AceSmartSoft API Documentation
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
SmartACE::CommParameterRequest Class Reference

#include <smartCommParameterRequest.hh>

Public Member Functions

 CommParameterRequest ()=default
 
virtual ~CommParameterRequest ()=default
 
 CommParameterRequest (const CommParameterIDL::CommParameterRequest &obj)
 
 operator CommParameterIDL::CommParameterRequest () const
 
int remove (const std::string &key)
 
std::string getTag () const
 
void setTag (const std::string &value)
 
template<class Value >
int set (const std::string &key, const Value &value)
 Generic setter method (expects one of primitive data types for the value) More...
 
int setString (const std::string &key, const std::string &value)
 
int setInteger (const std::string &key, const int &value)
 
int setDouble (const std::string &key, const double &value)
 
int setBoolean (const std::string &key, const bool &value)
 
template<class Value >
int get (const std::string &key, Value &value) const
 Generic getter method (expects one of primitive data types for the value) More...
 
template<class Value >
int getList (const std::string &key, std::list< Value > &value) const
 
int getString (const std::string &key, std::string &value) const
 
template<class Integer >
int getInteger (const std::string &key, Integer &value) const
 
template<class Double >
int getDouble (const std::string &key, Double &value) const
 
int getBoolean (const std::string &key, bool &value) const
 
int getStringList (const std::string &key, std::list< std::string > &value) const
 
template<class Integer >
int getIntegerList (const std::string &key, std::list< Integer > &value) const
 
template<class Double >
int getDoubleList (const std::string &key, std::list< Double > &value) const
 
int getBooleanList (const std::string &key, std::list< bool > &value) const
 
std::string getString (const std::string &key) const
 
int getInteger (const std::string &key) const
 
double getDouble (const std::string &key) const
 
bool getBoolean (const std::string &key) const
 
std::list< std::string > getStringList (const std::string &key) const
 
std::list< int > getIntegerList (const std::string &key) const
 
std::list< double > getDoubleList (const std::string &key) const
 
std::list< bool > getBooleanList (const std::string &key) const
 
void to_ostream (std::ostream &os=std::cout) const
 

Static Public Member Functions

static std::string identifier (void)
 

Public Attributes

CommParameterIDL::CommParameterRequest data
 

Constructor & Destructor Documentation

◆ CommParameterRequest() [1/2]

SmartACE::CommParameterRequest::CommParameterRequest ( )
default

◆ ~CommParameterRequest()

virtual SmartACE::CommParameterRequest::~CommParameterRequest ( )
virtualdefault

◆ CommParameterRequest() [2/2]

SmartACE::CommParameterRequest::CommParameterRequest ( const CommParameterIDL::CommParameterRequest obj)
inline

Member Function Documentation

◆ get()

template<class Value >
int SmartACE::CommParameterRequest::get ( const std::string &  key,
Value &  value 
) const

Generic getter method (expects one of primitive data types for the value)

◆ getBoolean() [1/2]

int SmartACE::CommParameterRequest::getBoolean ( const std::string &  key,
bool &  value 
) const
inline

◆ getBoolean() [2/2]

bool SmartACE::CommParameterRequest::getBoolean ( const std::string &  key) const
inline

◆ getBooleanList() [1/2]

int SmartACE::CommParameterRequest::getBooleanList ( const std::string &  key,
std::list< bool > &  value 
) const
inline

◆ getBooleanList() [2/2]

std::list<bool> SmartACE::CommParameterRequest::getBooleanList ( const std::string &  key) const
inline

◆ getDouble() [1/2]

template<class Double >
int SmartACE::CommParameterRequest::getDouble ( const std::string &  key,
Double &  value 
) const
inline

◆ getDouble() [2/2]

double SmartACE::CommParameterRequest::getDouble ( const std::string &  key) const
inline

◆ getDoubleList() [1/2]

template<class Double >
int SmartACE::CommParameterRequest::getDoubleList ( const std::string &  key,
std::list< Double > &  value 
) const
inline

◆ getDoubleList() [2/2]

std::list<double> SmartACE::CommParameterRequest::getDoubleList ( const std::string &  key) const
inline

◆ getInteger() [1/2]

template<class Integer >
int SmartACE::CommParameterRequest::getInteger ( const std::string &  key,
Integer &  value 
) const
inline

◆ getInteger() [2/2]

int SmartACE::CommParameterRequest::getInteger ( const std::string &  key) const
inline

◆ getIntegerList() [1/2]

template<class Integer >
int SmartACE::CommParameterRequest::getIntegerList ( const std::string &  key,
std::list< Integer > &  value 
) const
inline

◆ getIntegerList() [2/2]

std::list<int> SmartACE::CommParameterRequest::getIntegerList ( const std::string &  key) const
inline

◆ getList()

template<class Value >
int SmartACE::CommParameterRequest::getList ( const std::string &  key,
std::list< Value > &  value 
) const

◆ getString() [1/2]

int SmartACE::CommParameterRequest::getString ( const std::string &  key,
std::string &  value 
) const

◆ getString() [2/2]

std::string SmartACE::CommParameterRequest::getString ( const std::string &  key) const

◆ getStringList() [1/2]

int SmartACE::CommParameterRequest::getStringList ( const std::string &  key,
std::list< std::string > &  value 
) const

◆ getStringList() [2/2]

std::list<std::string> SmartACE::CommParameterRequest::getStringList ( const std::string &  key) const

◆ getTag()

std::string SmartACE::CommParameterRequest::getTag ( ) const

◆ identifier()

static std::string SmartACE::CommParameterRequest::identifier ( void  )
inlinestatic

◆ operator CommParameterIDL::CommParameterRequest()

SmartACE::CommParameterRequest::operator CommParameterIDL::CommParameterRequest ( ) const
inline

◆ remove()

int SmartACE::CommParameterRequest::remove ( const std::string &  key)

◆ set()

template<class Value >
int SmartACE::CommParameterRequest::set ( const std::string &  key,
const Value &  value 
)

Generic setter method (expects one of primitive data types for the value)

◆ setBoolean()

int SmartACE::CommParameterRequest::setBoolean ( const std::string &  key,
const bool &  value 
)
inline

◆ setDouble()

int SmartACE::CommParameterRequest::setDouble ( const std::string &  key,
const double &  value 
)
inline

◆ setInteger()

int SmartACE::CommParameterRequest::setInteger ( const std::string &  key,
const int &  value 
)
inline

◆ setString()

int SmartACE::CommParameterRequest::setString ( const std::string &  key,
const std::string &  value 
)
inline

◆ setTag()

void SmartACE::CommParameterRequest::setTag ( const std::string &  value)

◆ to_ostream()

void SmartACE::CommParameterRequest::to_ostream ( std::ostream &  os = std::cout) const

Member Data Documentation

◆ data

CommParameterIDL::CommParameterRequest SmartACE::CommParameterRequest::data

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