plist::NamedEnumerationBase Class Reference
#include <plistPrimitives.h>
Detailed Description
provides some accessors common across NamedEnumeration types
Definition at line 462 of file plistPrimitives.h.
Public Member Functions | |
| NamedEnumerationBase () | |
| constructor | |
| NamedEnumerationBase (const NamedEnumerationBase &ne) | |
| copy constructor | |
| NamedEnumerationBase & | operator= (const std::string &v) |
| assignment from string | |
| NamedEnumerationBase & | operator= (const NamedEnumerationBase &ne) |
| assignment (doesn't copy strictValue) | |
| virtual NamedEnumerationBase & | operator= (const PrimitiveBase &pb)=0 |
| assignment (don't assign listeners); doesn't trigger fireValueChanged, subclass should do that from its own operator=() following assignment | |
| virtual void | set (long x)=0 |
| converts from a numeric value, may throw bad_format if strictValue is set | |
| virtual void | getPreferredNames (std::map< int, std::string > &names) const =0 |
| fills names with the names and values for the enum -- needed for generic access to the names (e.g. UI generation) | |
| virtual void | getAllNames (std::map< std::string, int > &names) const =0 |
| fills names with the names and values for the enum -- needed for generic access to the names (e.g. UI generation) | |
| std::string | getDescription (bool preferredOnly=true) |
| returns a string listing the available symbolic names | |
| void | setStrict (bool strict) |
| sets strictValue (whether or not to allow assignment from numeric values which don't have a symbolic name) | |
| bool | getStrict () const |
| returns strictValue (whether or not to allow assignment from numeric values which don't have a symbolic name) | |
Protected Attributes | |
| bool | strictValue |
| if true, don't allow conversion from numeric string which doesn't correspond to a named value | |
Constructor & Destructor Documentation
| plist::NamedEnumerationBase::NamedEnumerationBase | ( | ) |
constructor
Definition at line 464 of file plistPrimitives.h.
| plist::NamedEnumerationBase::NamedEnumerationBase | ( | const NamedEnumerationBase & | ne | ) |
copy constructor
Definition at line 465 of file plistPrimitives.h.
Member Function Documentation
| virtual void plist::NamedEnumerationBase::getAllNames | ( | std::map< std::string, int > & | names | ) | const [pure virtual] |
fills names with the names and values for the enum -- needed for generic access to the names (e.g. UI generation)
Implemented in plist::NamedEnumeration< T >, plist::NamedEnumeration< Config::vision_config::encoding_t >, plist::NamedEnumeration< J_DCT_METHOD >, plist::NamedEnumeration< Config::transports >, plist::NamedEnumeration< gain_levels >, plist::NamedEnumeration< volume_levels >, plist::NamedEnumeration< compression_t >, plist::NamedEnumeration< white_balance_levels >, plist::NamedEnumeration< consoleMode_t >, plist::NamedEnumeration< JointType_t >, and plist::NamedEnumeration< shutter_speeds >.
Referenced by getDescription().
| std::string plist::NamedEnumerationBase::getDescription | ( | bool | preferredOnly = true |
) |
returns a string listing the available symbolic names
Definition at line 251 of file plistPrimitives.cc.
Referenced by Config::vision_config::DepthCamConfig::DepthCamConfig(), Config::main_config::main_config(), Config::vision_config::RawCamConfig::RawCamConfig(), Config::vision_config::SegCamConfig::SegCamConfig(), Config::sound_config::sound_config(), and Config::vision_config::vision_config().
| virtual void plist::NamedEnumerationBase::getPreferredNames | ( | std::map< int, std::string > & | names | ) | const [pure virtual] |
fills names with the names and values for the enum -- needed for generic access to the names (e.g. UI generation)
Implemented in plist::NamedEnumeration< T >, plist::NamedEnumeration< Config::vision_config::encoding_t >, plist::NamedEnumeration< J_DCT_METHOD >, plist::NamedEnumeration< Config::transports >, plist::NamedEnumeration< gain_levels >, plist::NamedEnumeration< volume_levels >, plist::NamedEnumeration< compression_t >, plist::NamedEnumeration< white_balance_levels >, plist::NamedEnumeration< consoleMode_t >, plist::NamedEnumeration< JointType_t >, and plist::NamedEnumeration< shutter_speeds >.
Referenced by getDescription(), and ConfigurationEditor::NamedEnumerationEditor::refresh().
| bool plist::NamedEnumerationBase::getStrict | ( | ) | const |
returns strictValue (whether or not to allow assignment from numeric values which don't have a symbolic name)
Definition at line 480 of file plistPrimitives.h.
| virtual NamedEnumerationBase& plist::NamedEnumerationBase::operator= | ( | const PrimitiveBase & | pb | ) | [pure virtual] |
assignment (don't assign listeners); doesn't trigger fireValueChanged, subclass should do that from its own operator=() following assignment
Reimplemented from plist::PrimitiveBase.
Implemented in plist::NamedEnumeration< T >, plist::NamedEnumeration< Config::vision_config::encoding_t >, plist::NamedEnumeration< J_DCT_METHOD >, plist::NamedEnumeration< Config::transports >, plist::NamedEnumeration< gain_levels >, plist::NamedEnumeration< volume_levels >, plist::NamedEnumeration< compression_t >, plist::NamedEnumeration< white_balance_levels >, plist::NamedEnumeration< consoleMode_t >, plist::NamedEnumeration< JointType_t >, and plist::NamedEnumeration< shutter_speeds >.
| NamedEnumerationBase& plist::NamedEnumerationBase::operator= | ( | const NamedEnumerationBase & | ne | ) |
assignment (doesn't copy strictValue)
Definition at line 467 of file plistPrimitives.h.
| NamedEnumerationBase& plist::NamedEnumerationBase::operator= | ( | const std::string & | v | ) |
assignment from string
Reimplemented from plist::PrimitiveBase.
Reimplemented in plist::NamedEnumeration< T >, plist::NamedEnumeration< Config::vision_config::encoding_t >, plist::NamedEnumeration< J_DCT_METHOD >, plist::NamedEnumeration< Config::transports >, plist::NamedEnumeration< gain_levels >, plist::NamedEnumeration< volume_levels >, plist::NamedEnumeration< compression_t >, plist::NamedEnumeration< white_balance_levels >, plist::NamedEnumeration< consoleMode_t >, plist::NamedEnumeration< JointType_t >, and plist::NamedEnumeration< shutter_speeds >.
Definition at line 466 of file plistPrimitives.h.
| virtual void plist::NamedEnumerationBase::set | ( | long | x | ) | [pure virtual] |
converts from a numeric value, may throw bad_format if strictValue is set
Implemented in plist::NamedEnumeration< T >, plist::NamedEnumeration< Config::vision_config::encoding_t >, plist::NamedEnumeration< J_DCT_METHOD >, plist::NamedEnumeration< Config::transports >, plist::NamedEnumeration< gain_levels >, plist::NamedEnumeration< volume_levels >, plist::NamedEnumeration< compression_t >, plist::NamedEnumeration< white_balance_levels >, plist::NamedEnumeration< consoleMode_t >, plist::NamedEnumeration< JointType_t >, and plist::NamedEnumeration< shutter_speeds >.
Referenced by ConfigurationEditor::NamedEnumerationEditor::doSelect().
| void plist::NamedEnumerationBase::setStrict | ( | bool | strict | ) |
sets strictValue (whether or not to allow assignment from numeric values which don't have a symbolic name)
Definition at line 479 of file plistPrimitives.h.
Referenced by Config::sound_config::sound_config().
Member Data Documentation
bool plist::NamedEnumerationBase::strictValue [protected] |
if true, don't allow conversion from numeric string which doesn't correspond to a named value
Definition at line 483 of file plistPrimitives.h.
Referenced by getDescription().
The documentation for this class was generated from the following files:
