OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Protected Attributes | Friends | List of all members
openjaus::system::Setting Class Reference

#include <Setting.h>

Inherits openjaus::system::Accessable.

Public Member Functions

 Setting ()
virtual ~Setting ()
std::string getKey () const
 Accessor to get the value of key. More...
bool setKey (std::string key)
 Accessor to set value of key. More...
std::string getValueStr () const
 Accessor to get the value of valueStr. More...
bool setValueStr (std::string valueStr)
 Accessor to set value of valueStr. More...
std::string getComment () const
 Accessor to get the value of comment. More...
bool setComment (std::string comment)
 Accessor to set value of comment. More...
bool isSaveDefault () const
 Accessor to get the value of saveDefault. More...
bool setSaveDefault (bool saveDefault)
 Accessor to set value of saveDefault. More...
virtual std::string toString () const
- Public Member Functions inherited from openjaus::system::Accessable
 Accessable ()
virtual ~Accessable ()
bool isGlobalRead () const
 Accessor to get the value of globalRead. More...
bool setGlobalRead (bool globalRead)
 Accessor to set value of globalRead. More...
bool isControllerRead () const
 Accessor to get the value of controllerRead. More...
bool setControllerRead (bool controllerRead)
 Accessor to set value of controllerRead. More...
bool isControllerWrite () const
 Accessor to get the value of controllerWrite. More...
bool setControllerWrite (bool controllerWrite)
 Accessor to set value of controllerWrite. More...
std::vector< std::string > getOwnerUri () const
 Accessor to get the value of ownerUri. More...
bool setOwnerUri (std::string ownerUri)
 Accessor to set value of ownerUri. More...

Protected Attributes

std::string key
std::string valueStr
std::string comment
bool saveDefault
- Protected Attributes inherited from openjaus::system::Accessable
bool globalRead
bool controllerRead
bool controllerWrite
std::vector< std::string > ownerUri


OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const Setting &object)
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const Setting *object)

Constructor & Destructor Documentation

§ Setting()

openjaus::system::Setting::Setting ( )

§ ~Setting()

openjaus::system::Setting::~Setting ( )

Member Function Documentation

§ getComment()

std::string openjaus::system::Setting::getComment ( ) const

§ getKey()

std::string openjaus::system::Setting::getKey ( ) const

§ getValueStr()

std::string openjaus::system::Setting::getValueStr ( ) const

§ isSaveDefault()

bool openjaus::system::Setting::isSaveDefault ( ) const

§ setComment()

bool openjaus::system::Setting::setComment ( std::string  comment)
commentThe value of the new comment.

§ setKey()

bool openjaus::system::Setting::setKey ( std::string  key)
keyThe value of the new key.

§ setSaveDefault()

bool openjaus::system::Setting::setSaveDefault ( bool  saveDefault)
saveDefaultThe value of the new saveDefault.

§ setValueStr()

bool openjaus::system::Setting::setValueStr ( std::string  valueStr)
valueStrThe value of the new valueStr.

§ toString()

std::string openjaus::system::Setting::toString ( ) const

Reimplemented from openjaus::system::Accessable.

Friends And Related Function Documentation

§ operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const Setting object 

§ operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const Setting object 

Member Data Documentation

§ comment

std::string openjaus::system::Setting::comment

§ key

std::string openjaus::system::Setting::key

§ saveDefault

bool openjaus::system::Setting::saveDefault

§ valueStr

std::string openjaus::system::Setting::valueStr

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