Option
[Baselib]

basic set of classes about options More...

Classes
class	CommonOptions
class	OptionListener
class	GenericOption
	Generic option. More...
class	DecimalOption
	Decimal option. More...
class	PositionOption
	Position option. More...
class	Position3DOption
	Position3D option. More...
class	PoseOption
	Pose option. More...
class	Pose3DOption
	Pose3D option. More...
class	DecimalArrayOption
	A vector of Decimal option. More...
class	IntOption
	Integer option. More...
class	StringOption
	Integer option. More...
class	BoolOption
	Integer option. More...
class	GlobalOptionsListener
class	Options
class	OptionWidget
	Option widget. More...
class	IntSpinBox
	Int spin Box. More...
class	DecimalSpinBox
	Decimal spin Box. More...
class	NameWidget
	Name widget. More...
class	IntWidget
	Int widget. More...
class	DecimalWidget
	Decimal widget. More...
class	PositionWidget
	Position widget. More...
class	Position3DWidget
	Position3D widget. More...
class	PoseWidget
	Pose widget. More...
class	StringWidget
	String widget. More...
class	BoolWidget
	String widget. More...
Defines
#define	OPTION_TS_SETVALUE_FUNCTION(TypeOption, ValType)
#define	OPTION_GETTYPE_FUNCTION(TypeOption)
#define	OPTION_NOTIFYOPTIONSLISTENER_FUNCTION(Type)
#define	OPTION_TS_GETVALUE_FUNCTION(TypeOption, ValType)
#define	OPTION_CONSTUCTOR(TypeOption, ValType)
#define	OPTION_COPYCONSTUCTOR(TypeOption)
#define	OPTION_ASSIGNOP(TypeOption)
#define	OPTION_PRINT_FUNCTION(TypeOption)
#define	OPTION_PRINT_VALUEPRINT_FUNCTION(TypeOption)
#define	OPTION_PRINTVALUE_FUNCTION(TypeOption)
#define	OPTION_PRINTVALUE_VALUEPRINT_FUNCTION(TypeOption)
#define	OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION(Type)
#define	OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION(Type)
#define	DEBUG_OPTION_WIDG   0
Typedefs
typedef set< OptionListener * >	OptionListenerSet
typedef set< Options * >	GlobalOptionsSet
typedef set < GlobalOptionsListener * >	GlobalOptionsListenerSet
typedef set< DecimalOption * >	DecimalOptionSet
typedef set< PositionOption * >	PositionOptionSet
typedef set< Position3DOption * >	Position3DOptionSet
typedef set< PoseOption * >	PoseOptionSet
typedef set< Pose3DOption * >	Pose3DOptionSet
typedef set< DecimalArrayOption * >	DecimalArrayOptionSet
typedef set< IntOption * >	IntOptionSet
typedef set< StringOption * >	StringOptionSet
typedef set< BoolOption * >	BoolOptionSet
typedef map< string, GenericOption * >	GenericOptionNameMap
typedef set< GenericOption * >	GenericOptionSet
Enumerations
enum	OptionGroupsType {   OPT_GRP_COMM, OPT_GRP_RESO, OPT_GRP_TASK, OPT_GRP_ALGO,   OPT_GRP_OTHE, NUM_OPT_GRP }
enum	OptionValueType {   OVT_UNDEF, OVT_DECIMAL, OVT_POSITION, OVT_POSITION3D,   OVT_POSE, OVT_POSE3D, OVT_ARRAY_DECIMAL, OVT_STRING,   OVT_INT, OVT_BOOL, NUM_OVT }
enum	ScenarioType { KHEPERA_SCEN, WEBOTS_SCEN, PLAYER_SCEN, SCENARIO_NUMS }
Functions
	OPTION_TS_SETVALUE_FUNCTION (DecimalOption, Decimal)
	OPTION_TS_SETVALUE_FUNCTION (PositionOption, Position)
	OPTION_TS_SETVALUE_FUNCTION (Position3DOption, Position3D)
	OPTION_TS_SETVALUE_FUNCTION (PoseOption, Pose)
	OPTION_TS_SETVALUE_FUNCTION (Pose3DOption, Pose3D)
	OPTION_TS_SETVALUE_FUNCTION (DecimalArrayOption, string)
	OPTION_TS_SETVALUE_FUNCTION (StringOption, string)
	OPTION_TS_SETVALUE_FUNCTION (IntOption, int)
	OPTION_TS_SETVALUE_FUNCTION (BoolOption, bool)
	OPTION_GETTYPE_FUNCTION (DecimalOption)
	OPTION_GETTYPE_FUNCTION (PositionOption)
	OPTION_GETTYPE_FUNCTION (Position3DOption)
	OPTION_GETTYPE_FUNCTION (PoseOption)
	OPTION_GETTYPE_FUNCTION (Pose3DOption)
	OPTION_GETTYPE_FUNCTION (DecimalArrayOption)
	OPTION_GETTYPE_FUNCTION (StringOption)
	OPTION_GETTYPE_FUNCTION (IntOption)
	OPTION_GETTYPE_FUNCTION (BoolOption)
	OPTION_NOTIFYOPTIONSLISTENER_FUNCTION (DecimalOption)
	OPTION_NOTIFYOPTIONSLISTENER_FUNCTION (PositionOption)
	OPTION_NOTIFYOPTIONSLISTENER_FUNCTION (Position3DOption)
	OPTION_NOTIFYOPTIONSLISTENER_FUNCTION (PoseOption)
	OPTION_NOTIFYOPTIONSLISTENER_FUNCTION (Pose3DOption)
	OPTION_NOTIFYOPTIONSLISTENER_FUNCTION (DecimalArrayOption)
	OPTION_NOTIFYOPTIONSLISTENER_FUNCTION (StringOption)
	OPTION_NOTIFYOPTIONSLISTENER_FUNCTION (IntOption)
	OPTION_NOTIFYOPTIONSLISTENER_FUNCTION (BoolOption)
	OPTION_TS_GETVALUE_FUNCTION (DecimalOption, Decimal)
	OPTION_TS_GETVALUE_FUNCTION (PositionOption, Position)
	OPTION_TS_GETVALUE_FUNCTION (Position3DOption, Position3D)
	OPTION_TS_GETVALUE_FUNCTION (PoseOption, Pose)
	OPTION_TS_GETVALUE_FUNCTION (Pose3DOption, Pose3D)
	OPTION_TS_GETVALUE_FUNCTION (DecimalArrayOption, string)
	OPTION_TS_GETVALUE_FUNCTION (StringOption, string)
	OPTION_TS_GETVALUE_FUNCTION (IntOption, int)
	OPTION_TS_GETVALUE_FUNCTION (BoolOption, bool)
	OPTION_CONSTUCTOR (DecimalOption, Decimal)
	OPTION_CONSTUCTOR (PositionOption, Position)
	OPTION_CONSTUCTOR (Position3DOption, Position3D)
	OPTION_CONSTUCTOR (PoseOption, Pose)
	OPTION_CONSTUCTOR (Pose3DOption, Pose3D)
	OPTION_CONSTUCTOR (DecimalArrayOption, string)
	OPTION_CONSTUCTOR (StringOption, string)
	OPTION_CONSTUCTOR (IntOption, int)
	OPTION_CONSTUCTOR (BoolOption, bool)
	OPTION_COPYCONSTUCTOR (DecimalOption)
	OPTION_COPYCONSTUCTOR (PositionOption)
	OPTION_COPYCONSTUCTOR (Position3DOption)
	OPTION_COPYCONSTUCTOR (PoseOption)
	OPTION_COPYCONSTUCTOR (Pose3DOption)
	OPTION_COPYCONSTUCTOR (DecimalArrayOption)
	OPTION_COPYCONSTUCTOR (StringOption)
	OPTION_COPYCONSTUCTOR (IntOption)
	OPTION_COPYCONSTUCTOR (BoolOption)
	OPTION_ASSIGNOP (DecimalOption)
	OPTION_ASSIGNOP (PositionOption)
	OPTION_ASSIGNOP (Position3DOption)
	OPTION_ASSIGNOP (PoseOption)
	OPTION_ASSIGNOP (Pose3DOption)
	OPTION_ASSIGNOP (DecimalArrayOption)
	OPTION_ASSIGNOP (StringOption)
	OPTION_ASSIGNOP (IntOption)
	OPTION_ASSIGNOP (BoolOption)
	OPTION_PRINT_FUNCTION (DecimalOption)
	OPTION_PRINT_VALUEPRINT_FUNCTION (PositionOption)
	OPTION_PRINT_VALUEPRINT_FUNCTION (Position3DOption)
	OPTION_PRINT_VALUEPRINT_FUNCTION (PoseOption)
	OPTION_PRINT_VALUEPRINT_FUNCTION (Pose3DOption)
	OPTION_PRINT_FUNCTION (DecimalArrayOption)
	OPTION_PRINT_FUNCTION (StringOption)
	OPTION_PRINT_FUNCTION (IntOption)
	OPTION_PRINT_FUNCTION (BoolOption)
	OPTION_PRINTVALUE_FUNCTION (DecimalOption)
	OPTION_PRINTVALUE_VALUEPRINT_FUNCTION (PositionOption)
	OPTION_PRINTVALUE_VALUEPRINT_FUNCTION (Position3DOption)
	OPTION_PRINTVALUE_VALUEPRINT_FUNCTION (PoseOption)
	OPTION_PRINTVALUE_VALUEPRINT_FUNCTION (Pose3DOption)
	OPTION_PRINTVALUE_FUNCTION (DecimalArrayOption)
	OPTION_PRINTVALUE_FUNCTION (StringOption)
	OPTION_PRINTVALUE_FUNCTION (IntOption)
	OPTION_PRINTVALUE_FUNCTION (BoolOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION (DecimalOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION (PositionOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION (Position3DOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION (PoseOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION (Pose3DOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION (StringOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION (DecimalArrayOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION (IntOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION (BoolOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION (DecimalOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION (PositionOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION (Position3DOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION (PoseOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION (Pose3DOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION (DecimalArrayOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION (StringOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION (IntOption)
	OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION (BoolOption)
virtual void	OptionListener::optionChanged (DecimalOption *option)
virtual void	OptionListener::optionChanged (PositionOption *option)
virtual void	OptionListener::optionChanged (Position3DOption *option)
virtual void	OptionListener::optionChanged (PoseOption *option)
virtual void	OptionListener::optionChanged (DecimalArrayOption *option)
virtual void	OptionListener::optionChanged (Pose3DOption *option)
virtual void	OptionListener::optionChanged (StringOption *option)
virtual void	OptionListener::optionChanged (IntOption *option)
virtual void	OptionListener::optionChanged (BoolOption *option)
virtual void	GenericOption::notifyOptionListeners ()=0
	GenericOption::GenericOption (const string &name, const string &description, Options *optionsContainer)
	Constructor.
virtual string	GenericOption::getObjectName () const
	Get name.
string	GenericOption::getName () const
	Get name.
string	GenericOption::getDescription () const
	Get description.
virtual OptionValueType	GenericOption::getType () const =0
virtual void	GenericOption::setValue (const string &s)=0
virtual string	GenericOption::print () const =0
virtual string	GenericOption::printValue () const =0
void	GenericOption::registerOptionListener (OptionListener *optionListener)
void	GenericOption::unRegisterOptionListener (OptionListener *optionListener)
const Options &	GenericOption::getContainer ()
DecimalOption &	DecimalOption::operator= (const DecimalOption &rhs)
	Assigment operator.
OptionValueType	DecimalOption::getType () const
	Get type.
virtual string	DecimalOption::getObjectName () const
	Get ObjectName.
void	DecimalOption::setValue (const string &s)
	Set value.
void	DecimalOption::setValue (const Decimal &v)
Decimal	DecimalOption::getValue () const
	Get value.
string	DecimalOption::print () const
	Print.
string	DecimalOption::printValue () const
	PrintValue.
PositionOption &	PositionOption::operator= (const PositionOption &rhs)
	Assigment operator.
OptionValueType	PositionOption::getType () const
	Get type.
virtual string	PositionOption::getObjectName () const
	Get ObjectName.
void	PositionOption::setValue (const string &s)
	Set value.
void	PositionOption::setValue (const Position &v)
Position	PositionOption::getValue () const
	Get value.
string	PositionOption::print () const
	Print.
string	PositionOption::printValue () const
	PrintValue.
Position3DOption &	Position3DOption::operator= (const Position3DOption &rhs)
	Assigment operator.
OptionValueType	Position3DOption::getType () const
	Get type.
virtual string	Position3DOption::getObjectName () const
	Get ObjectName.
void	Position3DOption::setValue (const string &s)
	Set value.
void	Position3DOption::setValue (const Position3D &v)
Position3D	Position3DOption::getValue () const
	Get value.
string	Position3DOption::print () const
	Print.
string	Position3DOption::printValue () const
	PrintValue.
PoseOption &	PoseOption::operator= (const PoseOption &rhs)
	Assigment operator.
OptionValueType	PoseOption::getType () const
	Get type.
virtual string	PoseOption::getObjectName () const
	Get ObjectName.
void	PoseOption::setValue (const string &s)
	Set value.
void	PoseOption::setValue (const Pose &v)
Pose	PoseOption::getValue () const
	Get value.
string	PoseOption::print () const
	Print.
string	PoseOption::printValue () const
	PrintValue.
Pose3DOption &	Pose3DOption::operator= (const Pose3DOption &rhs)
	Assigment operator.
OptionValueType	Pose3DOption::getType () const
	Get type.
virtual string	Pose3DOption::getObjectName () const
	Get ObjectName.
void	Pose3DOption::setValue (const string &s)
	Set value.
void	Pose3DOption::setValue (const Pose3D &v)
Pose3D	Pose3DOption::getValue () const
	Get value.
string	Pose3DOption::print () const
	Print.
string	Pose3DOption::printValue () const
	PrintValue.
DecimalArrayOption &	DecimalArrayOption::operator= (const DecimalArrayOption &rhs)
	Assigment operator.
OptionValueType	DecimalArrayOption::getType () const
	Get type.
virtual string	DecimalArrayOption::getObjectName () const
	Get ObjectName.
void	DecimalArrayOption::setValue (const string &s)
	Set value.
void	DecimalArrayOption::setValue (const vector< Decimal > &v)
string	DecimalArrayOption::getValue () const
	Get value.
bool	DecimalArrayOption::fromString ()
	It computes the parsing of the string.
vector< Decimal >	DecimalArrayOption::getValueVec ()
	Get value.
string	DecimalArrayOption::print () const
	Print.
string	DecimalArrayOption::printValue () const
	PrintValue.
IntOption &	IntOption::operator= (const IntOption &rhs)
	Assigment operator.
OptionValueType	IntOption::getType () const
	Get type.
virtual string	IntOption::getObjectName () const
	Get ObjectName.
void	IntOption::setValue (const string &s)
	Set value..
void	IntOption::setValue (const int &v)
int	IntOption::getValue () const
	Get value.
string	IntOption::print () const
	Print.
string	IntOption::printValue () const
	PrintValue.
StringOption &	StringOption::operator= (const StringOption &rhs)
	Assigment operator.
OptionValueType	StringOption::getType () const
	Get type.
virtual string	StringOption::getObjectName () const
	Get ObjectName.
void	StringOption::setValue (const string &v)
	Set value.
string	StringOption::getValue () const
	Get value.
string	StringOption::print () const
	Print.
string	StringOption::printValue () const
	PrintValue.
BoolOption &	BoolOption::operator= (const BoolOption &rhs)
	Assigment operator.
OptionValueType	BoolOption::getType () const
	Get type.
virtual string	BoolOption::getObjectName () const
	Get ObjectName.
void	BoolOption::setValue (const string &s)
	Set value.
void	BoolOption::setValue (const bool &v)
bool	BoolOption::getValue () const
	Get value.
string	BoolOption::print () const
	Print.
string	BoolOption::printValue () const
	PrintValue.
virtual void	GlobalOptionsListener::optionWasCreated (DecimalOption *option)
virtual void	GlobalOptionsListener::optionWasCreated (PositionOption *option)
virtual void	GlobalOptionsListener::optionWasCreated (Position3DOption *option)
virtual void	GlobalOptionsListener::optionWasCreated (PoseOption *option)
virtual void	GlobalOptionsListener::optionWasCreated (Pose3DOption *option)
virtual void	GlobalOptionsListener::optionWasCreated (DecimalArrayOption *option)
virtual void	GlobalOptionsListener::optionWasCreated (StringOption *option)
virtual void	GlobalOptionsListener::optionWasCreated (IntOption *option)
virtual void	GlobalOptionsListener::optionWasCreated (BoolOption *option)
virtual void	GlobalOptionsListener::optionWillBeDeleted (GenericOption *option)
virtual void	GlobalOptionsListener::optionWillBeDeleted (DecimalOption *option)
virtual void	GlobalOptionsListener::optionWillBeDeleted (PositionOption *option)
virtual void	GlobalOptionsListener::optionWillBeDeleted (Position3DOption *option)
virtual void	GlobalOptionsListener::optionWillBeDeleted (PoseOption *option)
virtual void	GlobalOptionsListener::optionWillBeDeleted (Pose3DOption *option)
virtual void	GlobalOptionsListener::optionWillBeDeleted (DecimalArrayOption *option)
virtual void	GlobalOptionsListener::optionWillBeDeleted (StringOption *option)
virtual void	GlobalOptionsListener::optionWillBeDeleted (IntOption *option)
virtual void	GlobalOptionsListener::optionWillBeDeleted (BoolOption *option)
	Options::Options ()
	Constructor Options.
virtual	Options::~Options ()
	Destructor Options.
virtual string	Options::getObjectName () const =0
	Gets the Name of the Options.
virtual OptionGroupsType	Options::getGroup ()
string	Options::toString () const
void	Options::print () const
GenericOption *	Options::getOptionWithName (const string &name)
bool	Options::hasOptionWithName (const string &name)
DecimalOption *	Options::createDecimalOption (const string &name, const string &description, const Decimal &value, bool updateMandatory=false)
PositionOption *	Options::createPositionOption (const string &name, const string &description, const Position &value, bool updateMandatory=false)
Position3DOption *	Options::createPosition3DOption (const string &name, const string &description, const Position3D &value, bool updateMandatory=false)
PoseOption *	Options::createPoseOption (const string &name, const string &description, const Pose &value, bool updateMandatory=false)
Pose3DOption *	Options::createPose3DOption (const string &name, const string &description, const Pose3D &value, bool updateMandatory=false)
DecimalArrayOption *	Options::createDecimalArrayOption (const string &name, const string &description, const string &value, bool updateMandatory=false)
IntOption *	Options::createIntOption (const string &name, const string &description, int value, bool updateMandatory=false)
StringOption *	Options::createStringOption (const string &name, const string &description, const string &value, bool updateMandatory=false)
BoolOption *	Options::createBoolOption (const string &name, const string &description, bool value, bool updateMandatory=false)
bool	Options::removeOption (GenericOption *genericOption)
bool	Options::removeDecimalOption (DecimalOption *decimalOption)
bool	Options::removePositionOption (PositionOption *positionOption)
bool	Options::removePosition3DOption (Position3DOption *position3DOption)
bool	Options::removePoseOption (PoseOption *poseOption)
bool	Options::removePose3DOption (Pose3DOption *poseOption)
bool	Options::removeDecimalArrayOption (DecimalArrayOption *DecimalArrayOption)
bool	Options::removeIntOption (IntOption *intOption)
bool	Options::removeStringOption (StringOption *stringOption)
bool	Options::removeBoolOption (BoolOption *boolOption)
void	Options::updateValues (bool checkForUpdateMandatroy=true)
void	Options::updateValue (const string &name, const string &value)
static const GlobalOptionsSet &	Options::getGlobalOptionsSet ()
static GenericOption *	Options::globalGetOptionWithName (const string &name)
static void	Options::registerGlobalOptionsListener (GlobalOptionsListener *globalOptionsListener)
static void	Options::unRegisterGlobalOptionsListener (GlobalOptionsListener *globalOptionsListener)
Variables
CommonOptions *	commonOptions
static const char *	OptionGroupsNames [NUM_OPT_GRP]
static const char *	OVTNames [NUM_OVT]
static const char *	scenarioNames [SCENARIO_NUMS]
string	GenericOption::_description
OptionListenerSet	GenericOption::_optionsListenerSet
pthread_mutex_t	GenericOption::_valueMutex
Options *	GenericOption::_optionsContainer
Friends
class	DecimalOption::Options
class	PositionOption::Options
class	Position3DOption::Options
class	PoseOption::Options
class	Pose3DOption::Options
class	DecimalArrayOption::Options
class	IntOption::Options
class	StringOption::Options
class	BoolOption::Options

---

Detailed Description

basic set of classes about options

---

Define Documentation

#define DEBUG_OPTION_WIDG   0

#define OPTION_ASSIGNOP

(

TypeOption

)

Value:

TypeOption& TypeOption::operator=(const TypeOption& rhs) { \
 if (this != &rhs) { \
  _name = rhs._name; \
  _description = rhs._description; \
  _optionsContainer = rhs._optionsContainer; \
  setValue(rhs.getValue()); \
 } \
 return *this; \
}

#define OPTION_CONSTUCTOR	(	TypeOption,
		ValType		)

Value:

TypeOption::TypeOption(const string& name, const string& description, Options* optionsContainer, const ValType& value) \
 : GenericOption(name, description, optionsContainer) \
{ \
 _value = value; \
}

#define OPTION_COPYCONSTUCTOR

(

TypeOption

)

Value:

TypeOption::TypeOption(const TypeOption& rhs) \
 : GenericOption(rhs._name, rhs._description, rhs._optionsContainer) \
{ \
 _value = rhs.getValue(); \
}

#define OPTION_GETTYPE_FUNCTION

(

TypeOption

)

Value:

OptionValueType TypeOption::getType() const { \
 return TYPE; \
}

#define OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION

(

Type

)

Value:

void Options::notifyWasCreatedGlobalOptionsListener(Type* option) \
{ \
 GlobalOptionsListenerSet::const_iterator it; \
 for (it = _globalOptionsListenerSet.begin(); it != _globalOptionsListenerSet.end(); it++) \
 { \
  (*it)->optionWasCreated((GenericOption*)option); \
  (*it)->optionWasCreated(option); \
  /* register GlobalListener as OptionListener */ \
  option->registerOptionListener((*it)); \
 } \
}

#define OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION

(

Type

)

Value:

void Options::notifyWillBeDeletedGlobalOptionsListener(Type* option) \
{ \
 GlobalOptionsListenerSet::const_iterator it; \
 for (it = _globalOptionsListenerSet.begin(); it != _globalOptionsListenerSet.end(); it++) \
 { \
  (*it)->optionWillBeDeleted((GenericOption*)option); \
  (*it)->optionWillBeDeleted(option); \
  /* unregister GlobalListener as OptionListener */ \
  option->unRegisterOptionListener((*it)); \
 } \
}

#define OPTION_NOTIFYOPTIONSLISTENER_FUNCTION

(

Type

)

Value:

void Type::notifyOptionListeners() \
{ \
 OptionListenerSet::const_iterator it; \
 for (it = _optionsListenerSet.begin(); it != _optionsListenerSet.end(); it++) \
 { \
  (*it)->optionChanged((GenericOption*)this); \
  (*it)->optionChanged(this); \
 } \
}

#define OPTION_PRINT_FUNCTION

(

TypeOption

)

Value:

string TypeOption::print() const { \
 stringstream ss; \
 ss << _name << ",\t" << OVTNames[getType()] << ",\t" << getValue() << ",\t"  << _description; \
 return ss.str(); \
}

#define OPTION_PRINT_VALUEPRINT_FUNCTION

(

TypeOption

)

Value:

string TypeOption::print() const { \
 stringstream ss; \
 ss << _name << ",\t" << OVTNames[getType()] << ",\t" << getValue().print() << ",\t"  << _description; \
 return ss.str(); \
}

#define OPTION_PRINTVALUE_FUNCTION

(

TypeOption

)

Value:

string TypeOption::printValue() const { \
 stringstream ss; \
 ss << getValue(); \
 return ss.str(); \
}

#define OPTION_PRINTVALUE_VALUEPRINT_FUNCTION

(

TypeOption

)

Value:

string TypeOption::printValue() const { \
 return getValue().toString(); \
}

#define OPTION_TS_GETVALUE_FUNCTION	(	TypeOption,
		ValType		)

Value:

ValType TypeOption::getValue() const { \
 ValType r; \
 pthread_mutex_lock(&_valueMutex); \
 r = _value; \
 pthread_mutex_unlock(&_valueMutex); \
 return r; \
}

#define OPTION_TS_SETVALUE_FUNCTION	(	TypeOption,
		ValType		)

Value:

void TypeOption::setValue(const ValType& v) \
{ \
 pthread_mutex_lock(&_valueMutex); \
 _value = v; \
 pthread_mutex_unlock(&_valueMutex); \
 /* Inform Listeners */ \
 notifyOptionListeners(); \
}

---

Typedef Documentation

typedef set<BoolOption*> BoolOptionSet

typedef set<DecimalArrayOption*> DecimalArrayOptionSet

typedef set<DecimalOption*> DecimalOptionSet

typedef map<string, GenericOption*> GenericOptionNameMap

typedef set<GenericOption*> GenericOptionSet

typedef set<GlobalOptionsListener*> GlobalOptionsListenerSet

typedef set<Options*> GlobalOptionsSet

typedef set<IntOption*> IntOptionSet

typedef set<OptionListener*> OptionListenerSet

typedef set<Pose3DOption*> Pose3DOptionSet

typedef set<PoseOption*> PoseOptionSet

typedef set<Position3DOption*> Position3DOptionSet

typedef set<PositionOption*> PositionOptionSet

typedef set<StringOption*> StringOptionSet

---

Enumeration Type Documentation

enum OptionGroupsType

Enumerator:

OPT_GRP_COMM
OPT_GRP_RESO
OPT_GRP_TASK
OPT_GRP_ALGO
OPT_GRP_OTHE
NUM_OPT_GRP

enum OptionValueType

Enumerator:

OVT_UNDEF
OVT_DECIMAL
OVT_POSITION
OVT_POSITION3D
OVT_POSE
OVT_POSE3D
OVT_ARRAY_DECIMAL
OVT_STRING
OVT_INT
OVT_BOOL
NUM_OVT

enum ScenarioType

Enumerator:

KHEPERA_SCEN
WEBOTS_SCEN
PLAYER_SCEN
SCENARIO_NUMS

---

Function Documentation

BoolOption * Options::createBoolOption	(	const string &	name,
		const string &	description,
		bool	value,
		bool	updateMandatory = false
	)			[inherited]

DecimalArrayOption * Options::createDecimalArrayOption	(	const string &	name,
		const string &	description,
		const string &	value,
		bool	updateMandatory = false
	)			[inherited]

DecimalOption * Options::createDecimalOption	(	const string &	name,
		const string &	description,
		const Decimal &	value,
		bool	updateMandatory = false
	)			[inherited]

IntOption * Options::createIntOption	(	const string &	name,
		const string &	description,
		int	value,
		bool	updateMandatory = false
	)			[inherited]

Pose3DOption * Options::createPose3DOption	(	const string &	name,
		const string &	description,
		const Pose3D &	value,
		bool	updateMandatory = false
	)			[inherited]

PoseOption * Options::createPoseOption	(	const string &	name,
		const string &	description,
		const Pose &	value,
		bool	updateMandatory = false
	)			[inherited]

Position3DOption * Options::createPosition3DOption	(	const string &	name,
		const string &	description,
		const Position3D &	value,
		bool	updateMandatory = false
	)			[inherited]

PositionOption * Options::createPositionOption	(	const string &	name,
		const string &	description,
		const Position &	value,
		bool	updateMandatory = false
	)			[inherited]

StringOption * Options::createStringOption	(	const string &	name,
		const string &	description,
		const string &	value,
		bool	updateMandatory = false
	)			[inherited]

bool DecimalArrayOption::fromString

(

)

[inherited]

It computes the parsing of the string.

GenericOption::GenericOption	(	const string &	name,
		const string &	description,
		Options *	optionsContainer
	)			[protected, inherited]

Constructor.

const Options& GenericOption::getContainer

(

)

[inline, inherited]

string GenericOption::getDescription

(

)

const [inline, inherited]

Get description.

Returns:

Description.

static const GlobalOptionsSet& Options::getGlobalOptionsSet

(

)

[inline, static, inherited]

virtual OptionGroupsType Options::getGroup

(

)

[inline, virtual, inherited]

Reimplemented in CommonOptions, MipResources::CameraCVDOptions, MipResources::CameraRosOptions, MipResources::MobileRobOptions, MipResources::RemoteKheperaOptions, MipResources::MotionModuleOptions, MipResources::RangeSensOptions, MipResources::ROSNodeOptions, MipTasks::ClearingOptions, MipTasks::JoystickOptions, MipTasks::LaserNavigationTaskOptions, MipTasks::Localization3DOptions, MipTasks::MutLocOptions, MipTasks::ParticleMutLocOptions, MipTasks::ParticleMutLocCamOffOptions, MipTasks::ParticleMutLocCamOptions, and MipTasks::ParticleMutLocNoMROptions.

string GenericOption::getName

(

)

const [inline, inherited]

Get name.

Returns:

Name.

virtual string Options::getObjectName

(

)

const [pure virtual, inherited]

Gets the Name of the Options.

Returns:

The name the Options.

Implements MIPObject.

Implemented in FormCtrlOptions, ObsAvoiAlgoDynOptions, MipAlgorithms::ObsAvoiAlgoLIPOptions, MipAlgorithms::ObsAvoiAlgoSNDOptions, PspmOptions, UavControlOptions, CommonOptions, KheperaServerOptions, MipResources::KheperaServerROSOptions, MipResources::CameraOptions, MipResources::CameraCVDOptions, MipResources::CameraRosOptions, MipResources::DirectStreamCommModuleOptions, MipResources::IPCommModuleOptions, MipResources::DraWinGLOptions, MipResources::ExternScanMatchOptions, MipResources::Imu_sensorOptions, MipResources::MobileRobOptions, MipResources::RemoteKheperaOptions, MipResources::MobileRob3DOptions, MipResources::MotionModuleOptions, MipResources::RangeSensOptions, MipResources::RemoteDeviceOptions, MipResources::ROSNodeOptions, MipResources::asctecUavOptions, MipResources::HummingBirdUavOptions, MipResources::UavOptions, MipTasks::AntiSimmetryTaskOptions, MipTasks::ClearingOptions, MipTasks::ClocheOptions, MipTasks::DeployOptions, MipTasks::DriverOptions, MipTasks::FeatExtrCamOptions, MipTasks::FeatExtrOptions, MipTasks::FormControlTaskOptions, MipTasks::JoystickOptions, MipTasks::LaserNavigationTaskOptions, MipTasks::LineFollowingOptions, MipTasks::Localization3DOptions, MipTasks::MutLocOptions, MipTasks::ObstacleAvoidanceOptions, MipTasks::OfflinerTaskOptions, MipTasks::ParticleMutLocOptions, MipTasks::ParticleMutLocCamOffOptions, MipTasks::ParticleMutLocCamOptions, MipTasks::ParticleMutLocNoMROptions, MipTasks::CentralizedPHDFilterTaskOptions, MipTasks::PHDCamFilterTaskOptions, MipTasks::PHDFilterTaskOptions, MipTasks::PursuingOptions, MipTasks::RemoteRobTaskOptions, MipTasks::ScanMatchingOptions, MipTasks::TrackerOptions, MipTasks::UavHeightControlOptions, MipTasks::UavHeiConOnboardOptions, MipTasks::ExampleTaskOptions, MipTasks::UAVPositioningSystemOptions, and MipTasks::VisualHoveringOptions.

virtual string BoolOption::getObjectName

(

)

const [inline, virtual, inherited]

Get ObjectName.

Returns:

Name.

Reimplemented from GenericOption.

virtual string StringOption::getObjectName

(

)

const [inline, virtual, inherited]

Get ObjectName.

Returns:

Name.

Reimplemented from GenericOption.

virtual string IntOption::getObjectName

(

)

const [inline, virtual, inherited]

Get ObjectName.

Returns:

Name.

Reimplemented from GenericOption.

virtual string DecimalArrayOption::getObjectName

(

)

const [inline, virtual, inherited]

Get ObjectName.

Returns:

Name.

Reimplemented from GenericOption.

virtual string Pose3DOption::getObjectName

(

)

const [inline, virtual, inherited]

Get ObjectName.

Returns:

Name.

Reimplemented from GenericOption.

virtual string PoseOption::getObjectName

(

)

const [inline, virtual, inherited]

Get ObjectName.

Returns:

Name.

Reimplemented from GenericOption.

virtual string Position3DOption::getObjectName

(

)

const [inline, virtual, inherited]

Get ObjectName.

Returns:

Name.

Reimplemented from GenericOption.

virtual string PositionOption::getObjectName

(

)

const [inline, virtual, inherited]

Get ObjectName.

Returns:

Name.

Reimplemented from GenericOption.

virtual string DecimalOption::getObjectName

(

)

const [inline, virtual, inherited]

Get ObjectName.

Returns:

Name.

Reimplemented from GenericOption.

virtual string GenericOption::getObjectName

(

)

const [inline, virtual, inherited]

Get name.

Returns:

Name.

Implements MIPObject.

Reimplemented in DecimalOption, PositionOption, Position3DOption, PoseOption, Pose3DOption, DecimalArrayOption, IntOption, StringOption, and BoolOption.

GenericOption * Options::getOptionWithName

(

const string &

name

)

[inherited]

OptionValueType BoolOption::getType

(

)

const [virtual, inherited]

Get type.

Returns:

Type.

Implements GenericOption.

OptionValueType StringOption::getType

(

)

const [virtual, inherited]

Get type.

Returns:

Type.

Implements GenericOption.

OptionValueType IntOption::getType

(

)

const [virtual, inherited]

Get type.

Returns:

Type.

Implements GenericOption.

OptionValueType DecimalArrayOption::getType

(

)

const [virtual, inherited]

Get type.

Returns:

Type.

Implements GenericOption.

OptionValueType Pose3DOption::getType

(

)

const [virtual, inherited]

Get type.

Returns:

Type.

Implements GenericOption.

OptionValueType PoseOption::getType

(

)

const [virtual, inherited]

Get type.

Returns:

Type.

Implements GenericOption.

OptionValueType Position3DOption::getType

(

)

const [virtual, inherited]

Get type.

Returns:

Type.

Implements GenericOption.

OptionValueType PositionOption::getType

(

)

const [virtual, inherited]

Get type.

Returns:

Type.

Implements GenericOption.

OptionValueType DecimalOption::getType

(

)

const [virtual, inherited]

Get type.

Returns:

Type.

Implements GenericOption.

virtual OptionValueType GenericOption::getType

(

)

const [pure virtual, inherited]

Implemented in DecimalOption, PositionOption, Position3DOption, PoseOption, Pose3DOption, DecimalArrayOption, IntOption, StringOption, and BoolOption.

bool BoolOption::getValue

(

)

const [inherited]

Get value.

Returns:

Value.

string StringOption::getValue

(

)

const [inherited]

Get value.

Returns:

Value.

int IntOption::getValue

(

)

const [inherited]

Get value.

Returns:

Value.

Examples:

exampleCommModule.cpp.

string DecimalArrayOption::getValue

(

)

const [inherited]

Get value.

Returns:

Value. String in input

Pose3D Pose3DOption::getValue

(

)

const [inherited]

Get value.

Returns:

Value.

Pose PoseOption::getValue

(

)

const [inherited]

Get value.

Returns:

Value.

Position3D Position3DOption::getValue

(

)

const [inherited]

Get value.

Returns:

Value.

Position PositionOption::getValue

(

)

const [inherited]

Get value.

Returns:

Value.

Decimal DecimalOption::getValue

(

)

const [inherited]

Get value.

Returns:

Value.

vector< Decimal > DecimalArrayOption::getValueVec

(

)

[inherited]

Get value.

Returns:

Value. Vector of Decimal of input computed by the parser

static GenericOption* Options::globalGetOptionWithName

(

const string &

name

)

[static, inherited]

bool Options::hasOptionWithName

(

const string &

name

)

[inherited]

virtual void GenericOption::notifyOptionListeners

(

)

[protected, pure virtual, inherited]

BoolOption& BoolOption::operator=

(

const BoolOption &

rhs

)

[inherited]

Assigment operator.

StringOption& StringOption::operator=

(

const StringOption &

rhs

)

[inherited]

Assigment operator.

IntOption& IntOption::operator=

(

const IntOption &

rhs

)

[inherited]

Assigment operator.

DecimalArrayOption& DecimalArrayOption::operator=

(

const DecimalArrayOption &

rhs

)

[inherited]

Assigment operator.

Pose3DOption& Pose3DOption::operator=

(

const Pose3DOption &

rhs

)

[inherited]

Assigment operator.

PoseOption& PoseOption::operator=

(

const PoseOption &

rhs

)

[inherited]

Assigment operator.

Position3DOption& Position3DOption::operator=

(

const Position3DOption &

rhs

)

[inherited]

Assigment operator.

PositionOption& PositionOption::operator=

(

const PositionOption &

rhs

)

[inherited]

Assigment operator.

DecimalOption& DecimalOption::operator=

(

const DecimalOption &

rhs

)

[inherited]

Assigment operator.

OPTION_ASSIGNOP

(

BoolOption

)

OPTION_ASSIGNOP

(

IntOption

)

OPTION_ASSIGNOP

(

StringOption

)

OPTION_ASSIGNOP

(

DecimalArrayOption

)

OPTION_ASSIGNOP

(

Pose3DOption

)

OPTION_ASSIGNOP

(

PoseOption

)

OPTION_ASSIGNOP

(

Position3DOption

)

OPTION_ASSIGNOP

(

PositionOption

)

OPTION_ASSIGNOP

(

DecimalOption

)

OPTION_CONSTUCTOR	(	BoolOption	,
		bool
	)

OPTION_CONSTUCTOR	(	IntOption	,
		int
	)

OPTION_CONSTUCTOR	(	StringOption	,
		string
	)

OPTION_CONSTUCTOR	(	DecimalArrayOption	,
		string
	)

OPTION_CONSTUCTOR	(	Pose3DOption	,
		Pose3D
	)

OPTION_CONSTUCTOR	(	PoseOption	,
		Pose
	)

OPTION_CONSTUCTOR	(	Position3DOption	,
		Position3D
	)

OPTION_CONSTUCTOR	(	PositionOption	,
		Position
	)

OPTION_CONSTUCTOR	(	DecimalOption	,
		Decimal
	)

OPTION_COPYCONSTUCTOR

(

BoolOption

)

OPTION_COPYCONSTUCTOR

(

IntOption

)

OPTION_COPYCONSTUCTOR

(

StringOption

)

OPTION_COPYCONSTUCTOR

(

DecimalArrayOption

)

OPTION_COPYCONSTUCTOR

(

Pose3DOption

)

OPTION_COPYCONSTUCTOR

(

PoseOption

)

OPTION_COPYCONSTUCTOR

(

Position3DOption

)

OPTION_COPYCONSTUCTOR

(

PositionOption

)

OPTION_COPYCONSTUCTOR

(

DecimalOption

)

OPTION_GETTYPE_FUNCTION

(

BoolOption

)

OPTION_GETTYPE_FUNCTION

(

IntOption

)

OPTION_GETTYPE_FUNCTION

(

StringOption

)

OPTION_GETTYPE_FUNCTION

(

DecimalArrayOption

)

OPTION_GETTYPE_FUNCTION

(

Pose3DOption

)

OPTION_GETTYPE_FUNCTION

(

PoseOption

)

OPTION_GETTYPE_FUNCTION

(

Position3DOption

)

OPTION_GETTYPE_FUNCTION

(

PositionOption

)

OPTION_GETTYPE_FUNCTION

(

DecimalOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION

(

BoolOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION

(

IntOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION

(

DecimalArrayOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION

(

StringOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION

(

Pose3DOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION

(

PoseOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION

(

Position3DOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION

(

PositionOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_CREATED_FUNCTION

(

DecimalOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION

(

BoolOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION

(

IntOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION

(

StringOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION

(

DecimalArrayOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION

(

Pose3DOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION

(

PoseOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION

(

Position3DOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION

(

PositionOption

)

OPTION_NOTIFYGLOBALOPTIONSLISTENER_DELETED_FUNCTION

(

DecimalOption

)

OPTION_NOTIFYOPTIONSLISTENER_FUNCTION

(

BoolOption

)

OPTION_NOTIFYOPTIONSLISTENER_FUNCTION

(

IntOption

)

OPTION_NOTIFYOPTIONSLISTENER_FUNCTION

(

StringOption

)

OPTION_NOTIFYOPTIONSLISTENER_FUNCTION

(

DecimalArrayOption

)

OPTION_NOTIFYOPTIONSLISTENER_FUNCTION

(

Pose3DOption

)

OPTION_NOTIFYOPTIONSLISTENER_FUNCTION

(

PoseOption

)

OPTION_NOTIFYOPTIONSLISTENER_FUNCTION

(

Position3DOption

)

OPTION_NOTIFYOPTIONSLISTENER_FUNCTION

(

PositionOption

)

OPTION_NOTIFYOPTIONSLISTENER_FUNCTION

(

DecimalOption

)

OPTION_PRINT_FUNCTION

(

BoolOption

)

OPTION_PRINT_FUNCTION

(

IntOption

)

OPTION_PRINT_FUNCTION

(

StringOption

)

OPTION_PRINT_FUNCTION

(

DecimalArrayOption

)

OPTION_PRINT_FUNCTION

(

DecimalOption

)

OPTION_PRINT_VALUEPRINT_FUNCTION

(

Pose3DOption

)

OPTION_PRINT_VALUEPRINT_FUNCTION

(

PoseOption

)

OPTION_PRINT_VALUEPRINT_FUNCTION

(

Position3DOption

)

OPTION_PRINT_VALUEPRINT_FUNCTION

(

PositionOption

)

OPTION_PRINTVALUE_FUNCTION

(

BoolOption

)

OPTION_PRINTVALUE_FUNCTION

(

IntOption

)

OPTION_PRINTVALUE_FUNCTION

(

StringOption

)

OPTION_PRINTVALUE_FUNCTION

(

DecimalArrayOption

)

OPTION_PRINTVALUE_FUNCTION

(

DecimalOption

)

OPTION_PRINTVALUE_VALUEPRINT_FUNCTION

(

Pose3DOption

)

OPTION_PRINTVALUE_VALUEPRINT_FUNCTION

(

PoseOption

)

OPTION_PRINTVALUE_VALUEPRINT_FUNCTION

(

Position3DOption

)

OPTION_PRINTVALUE_VALUEPRINT_FUNCTION

(

PositionOption

)

OPTION_TS_GETVALUE_FUNCTION	(	BoolOption	,
		bool
	)

OPTION_TS_GETVALUE_FUNCTION	(	IntOption	,
		int
	)

OPTION_TS_GETVALUE_FUNCTION	(	StringOption	,
		string
	)

OPTION_TS_GETVALUE_FUNCTION	(	DecimalArrayOption	,
		string
	)

OPTION_TS_GETVALUE_FUNCTION	(	Pose3DOption	,
		Pose3D
	)

OPTION_TS_GETVALUE_FUNCTION	(	PoseOption	,
		Pose
	)

OPTION_TS_GETVALUE_FUNCTION	(	Position3DOption	,
		Position3D
	)

OPTION_TS_GETVALUE_FUNCTION	(	PositionOption	,
		Position
	)

OPTION_TS_GETVALUE_FUNCTION	(	DecimalOption	,
		Decimal
	)

OPTION_TS_SETVALUE_FUNCTION	(	BoolOption	,
		bool
	)

OPTION_TS_SETVALUE_FUNCTION	(	IntOption	,
		int
	)

OPTION_TS_SETVALUE_FUNCTION	(	StringOption	,
		string
	)

OPTION_TS_SETVALUE_FUNCTION	(	DecimalArrayOption	,
		string
	)

OPTION_TS_SETVALUE_FUNCTION	(	Pose3DOption	,
		Pose3D
	)

OPTION_TS_SETVALUE_FUNCTION	(	PoseOption	,
		Pose
	)

OPTION_TS_SETVALUE_FUNCTION	(	Position3DOption	,
		Position3D
	)

OPTION_TS_SETVALUE_FUNCTION	(	PositionOption	,
		Position
	)

OPTION_TS_SETVALUE_FUNCTION	(	DecimalOption	,
		Decimal
	)

virtual void OptionListener::optionChanged

(

BoolOption *

option

)

[inline, virtual, inherited]

virtual void OptionListener::optionChanged

(

IntOption *

option

)

[inline, virtual, inherited]

virtual void OptionListener::optionChanged

(

StringOption *

option

)

[inline, virtual, inherited]

virtual void OptionListener::optionChanged

(

Pose3DOption *

option

)

[inline, virtual, inherited]

virtual void OptionListener::optionChanged

(

DecimalArrayOption *

option

)

[inline, virtual, inherited]

virtual void OptionListener::optionChanged

(

PoseOption *

option

)

[inline, virtual, inherited]

virtual void OptionListener::optionChanged

(

Position3DOption *

option

)

[inline, virtual, inherited]

virtual void OptionListener::optionChanged

(

PositionOption *

option

)

[inline, virtual, inherited]

virtual void OptionListener::optionChanged

(

DecimalOption *

option

)

[inline, virtual, inherited]

Options::Options

(

)

[inherited]

Constructor Options.

virtual void GlobalOptionsListener::optionWasCreated

(

BoolOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWasCreated

(

IntOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWasCreated

(

StringOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWasCreated

(

DecimalArrayOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWasCreated

(

Pose3DOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWasCreated

(

PoseOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWasCreated

(

Position3DOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWasCreated

(

PositionOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWasCreated

(

DecimalOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWillBeDeleted

(

BoolOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWillBeDeleted

(

IntOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWillBeDeleted

(

StringOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWillBeDeleted

(

DecimalArrayOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWillBeDeleted

(

Pose3DOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWillBeDeleted

(

PoseOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWillBeDeleted

(

Position3DOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWillBeDeleted

(

PositionOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWillBeDeleted

(

DecimalOption *

option

)

[inline, virtual, inherited]

virtual void GlobalOptionsListener::optionWillBeDeleted

(

GenericOption *

option

)

[inline, virtual, inherited]

void Options::print

(

)

const [inherited]

string BoolOption::print

(

)

const [virtual, inherited]

Print.

Returns:

Option summary string.

Implements GenericOption.

string StringOption::print

(

)

const [virtual, inherited]

Print.

Returns:

Option summary string.

Implements GenericOption.

string IntOption::print

(

)

const [virtual, inherited]

Print.

Returns:

Option summary string.

Implements GenericOption.

string DecimalArrayOption::print

(

)

const [virtual, inherited]

Print.

Returns:

Option summary string.

Implements GenericOption.

string Pose3DOption::print

(

)

const [virtual, inherited]

Print.

Returns:

Option summary string.

Implements GenericOption.

string PoseOption::print

(

)

const [virtual, inherited]

Print.

Returns:

Option summary string.

Implements GenericOption.

string Position3DOption::print

(

)

const [virtual, inherited]

Print.

Returns:

Option summary string.

Implements GenericOption.

string PositionOption::print

(

)

const [virtual, inherited]

Print.

Returns:

Option summary string.

Implements GenericOption.

string DecimalOption::print

(

)

const [virtual, inherited]

Print.

Returns:

Option summary string.

Implements GenericOption.

virtual string GenericOption::print

(

)

const [pure virtual, inherited]

Implemented in DecimalOption, PositionOption, Position3DOption, PoseOption, Pose3DOption, DecimalArrayOption, IntOption, StringOption, and BoolOption.

string BoolOption::printValue

(

)

const [virtual, inherited]

PrintValue.

Returns:

Option summary string.

Implements GenericOption.

string StringOption::printValue

(

)

const [virtual, inherited]

PrintValue.

Returns:

Option summary string.

Implements GenericOption.

string IntOption::printValue

(

)

const [virtual, inherited]

PrintValue.

Returns:

Option summary string.

Implements GenericOption.

string DecimalArrayOption::printValue

(

)

const [virtual, inherited]

PrintValue.

Returns:

Option summary string.

Implements GenericOption.

string Pose3DOption::printValue

(

)

const [virtual, inherited]

PrintValue.

Returns:

Option summary string.

Implements GenericOption.

string PoseOption::printValue

(

)

const [virtual, inherited]

PrintValue.

Returns:

Option summary string.

Implements GenericOption.

string Position3DOption::printValue

(

)

const [virtual, inherited]

PrintValue.

Returns:

Option summary string.

Implements GenericOption.

string PositionOption::printValue

(

)

const [virtual, inherited]

PrintValue.

Returns:

Option summary string.

Implements GenericOption.

string DecimalOption::printValue

(

)

const [virtual, inherited]

PrintValue.

Returns:

Option summary string.

Implements GenericOption.

virtual string GenericOption::printValue

(

)

const [pure virtual, inherited]

Implemented in DecimalOption, PositionOption, Position3DOption, PoseOption, Pose3DOption, DecimalArrayOption, IntOption, StringOption, and BoolOption.

void Options::registerGlobalOptionsListener

(

GlobalOptionsListener *

globalOptionsListener

)

[static, inherited]

void GenericOption::registerOptionListener

(

OptionListener *

optionListener

)

[inherited]

bool Options::removeBoolOption

(

BoolOption *

boolOption

)

[inherited]

bool Options::removeDecimalArrayOption

(

DecimalArrayOption *

DecimalArrayOption

)

[inherited]

bool Options::removeDecimalOption

(

DecimalOption *

decimalOption

)

[inherited]

bool Options::removeIntOption

(

IntOption *

intOption

)

[inherited]

bool Options::removeOption

(

GenericOption *

genericOption

)

[inherited]

bool Options::removePose3DOption

(

Pose3DOption *

poseOption

)

[inherited]

bool Options::removePoseOption

(

PoseOption *

poseOption

)

[inherited]

bool Options::removePosition3DOption

(

Position3DOption *

position3DOption

)

[inherited]

bool Options::removePositionOption

(

PositionOption *

positionOption

)

[inherited]

bool Options::removeStringOption

(

StringOption *

stringOption

)

[inherited]

void BoolOption::setValue

(

const bool &

v

)

[inherited]

void BoolOption::setValue

(

const string &

s

)

[virtual, inherited]

Set value.

Parameters:

Value.

Implements GenericOption.

void StringOption::setValue

(

const string &

v

)

[virtual, inherited]

Set value.

Parameters:

Value.

Implements GenericOption.

void IntOption::setValue

(

const int &

v

)

[inherited]

void IntOption::setValue

(

const string &

s

)

[virtual, inherited]

Set value..

Parameters:

Value.

Implements GenericOption.

void DecimalArrayOption::setValue

(

const vector< Decimal > &

v

)

[inherited]

void DecimalArrayOption::setValue

(

const string &

s

)

[virtual, inherited]

Set value.

Parameters:

Value.

Implements GenericOption.

void Pose3DOption::setValue

(

const Pose3D &

v

)

[inherited]

void Pose3DOption::setValue

(

const string &

s

)

[virtual, inherited]

Set value.

Parameters:

Value.

Implements GenericOption.

void PoseOption::setValue

(

const Pose &

v

)

[inherited]

void PoseOption::setValue

(

const string &

s

)

[virtual, inherited]

Set value.

Parameters:

Value.

Implements GenericOption.

void Position3DOption::setValue

(

const Position3D &

v

)

[inherited]

void Position3DOption::setValue

(

const string &

s

)

[virtual, inherited]

Set value.

Parameters:

Value.

Implements GenericOption.

void PositionOption::setValue

(

const Position &

v

)

[inherited]

void PositionOption::setValue

(

const string &

s

)

[virtual, inherited]

Set value.

Parameters:

Value.

Implements GenericOption.

void DecimalOption::setValue

(

const Decimal &

v

)

[inherited]

void DecimalOption::setValue

(

const string &

s

)

[virtual, inherited]

Set value.

Parameters:

Value.

Implements GenericOption.

virtual void GenericOption::setValue

(

const string &

s

)

[pure virtual, inherited]

Implemented in DecimalOption, PositionOption, Position3DOption, PoseOption, Pose3DOption, DecimalArrayOption, IntOption, StringOption, and BoolOption.

string Options::toString

(

)

const [inherited]

void Options::unRegisterGlobalOptionsListener

(

GlobalOptionsListener *

globalOptionsListener

)

[static, inherited]

void GenericOption::unRegisterOptionListener

(

OptionListener *

optionListener

)

[inherited]

void Options::updateValue	(	const string &	name,
		const string &	value
	)			[inherited]

void Options::updateValues

(

bool

checkForUpdateMandatroy = true

)

[inherited]

Examples:

exampleCommModule.cpp, and exampleDraWin.cpp.

Options::~Options

(

)

[virtual, inherited]

Destructor Options.

---

Variable Documentation

string GenericOption::_description [protected, inherited]

Options* GenericOption::_optionsContainer [protected, inherited]

OptionListenerSet GenericOption::_optionsListenerSet [protected, inherited]

pthread_mutex_t GenericOption::_valueMutex [mutable, protected, inherited]

CommonOptions* commonOptions

const char* OptionGroupsNames[NUM_OPT_GRP] [static]

Initial value:

 {
  "Common",
  "Resources",
  "Tasks",
  "Algorithms",
  "Others" }

const char* OVTNames[NUM_OVT] [static]

Initial value:

 {
  "Undef",
  "Decimal",
  "Position",
  "Position3D",
  "Pose",
  "Pose3D",
  "ArrayDecimal",
  "string",
  "int",
  "bool" }

const char* scenarioNames[SCENARIO_NUMS] [static]

Initial value:

 {
  "khepera\0",
  "webots\0",
  "player\0" }

---

Friends

friend class Options [friend, inherited]

friend class Options [friend, inherited]

friend class Options [friend, inherited]

friend class Options [friend, inherited]

friend class Options [friend, inherited]

friend class Options [friend, inherited]

friend class Options [friend, inherited]

friend class Options [friend, inherited]

friend class Options [friend, inherited]