ParallelAnalogEnsemble
Public Member Functions | Private Attributes | Friends | List of all members
Parameter Class Reference

Parameter stores parameter information including name and circular. More...

#include <Parameters.h>

Inheritance diagram for Parameter:
Inheritance graph
Collaboration diagram for Parameter:
Collaboration graph

Public Member Functions

 Parameter ()
 
 Parameter (const Parameter &other)
 
 Parameter (std::string name, bool circular=Config::_CIRCULAR)
 
virtual ~Parameter ()
 
Parameteroperator= (const Parameter &rhs)
 
bool operator== (const Parameter &rhs) const
 
bool operator< (const Parameter &right) const
 
void setName (std::string)
 
void setCircular (bool)
 
std::string getName () const
 
bool getCircular () const
 
void print (std::ostream &) const
 

Private Attributes

std::string name_
 
bool circular_
 

Friends

std::ostream & operator<< (std::ostream &, Parameter const &)
 

Detailed Description

Parameter stores parameter information including name and circular.

Constructor & Destructor Documentation

◆ Parameter() [1/3]

Parameter::Parameter ( )

◆ Parameter() [2/3]

Parameter::Parameter ( const Parameter other)

Initialize parameter.

Parameters
nameParameter name.
circularWhether parameter is circular.

◆ Parameter() [3/3]

Parameter::Parameter ( std::string  name,
bool  circular = Config::_CIRCULAR 
)

Initialize parameter.

Parameters
nameParameter name.
circularWhether parameter is circular.

◆ ~Parameter()

Parameter::~Parameter ( )
virtual

Member Function Documentation

◆ getCircular()

bool Parameter::getCircular ( ) const

◆ getName()

string Parameter::getName ( ) const

◆ operator<()

bool Parameter::operator< ( const Parameter right) const

Compares two Parameter objects based solely on name. The comparison algorithm uses std::string::compare.

Parameters
rightRight hand-side of the compare sign.
Returns
A boolean for whether this < right.

◆ operator=()

Parameter & Parameter::operator= ( const Parameter rhs)

◆ operator==()

bool Parameter::operator== ( const Parameter rhs) const

◆ print()

void Parameter::print ( std::ostream &  ) const

◆ setCircular()

void Parameter::setCircular ( bool  circular)

◆ setName()

void Parameter::setName ( std::string  )

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  ,
Parameter const &   
)
friend

Member Data Documentation

◆ circular_

bool Parameter::circular_
private

◆ name_

std::string Parameter::name_
private

The documentation for this class was generated from the following files: