Fawkes API
Fawkes Development Version
|
#include <>>
Classes | |
class | ValueIterator |
Public Member Functions | |
virtual | ~Configuration () |
virtual void | copy (Configuration *copyconf)=0 |
virtual void | add_change_handler (ConfigurationChangeHandler *h) |
Add a configuration change handler. More... | |
virtual void | rem_change_handler (ConfigurationChangeHandler *h) |
Remove a configuration change handler. More... | |
virtual void | load (const char *file_path)=0 |
virtual bool | exists (const char *path)=0 |
virtual bool | is_float (const char *path)=0 |
virtual bool | is_uint (const char *path)=0 |
virtual bool | is_int (const char *path)=0 |
virtual bool | is_bool (const char *path)=0 |
virtual bool | is_string (const char *path)=0 |
virtual bool | is_list (const char *path)=0 |
virtual bool | is_default (const char *path)=0 |
virtual float | get_float (const char *path)=0 |
virtual unsigned int | get_uint (const char *path)=0 |
virtual int | get_int (const char *path)=0 |
virtual bool | get_bool (const char *path)=0 |
virtual std::string | get_string (const char *path)=0 |
virtual float | get_float_or_default (const char *path, const float &default_val) |
virtual unsigned int | get_uint_or_default (const char *path, const unsigned int &default_val) |
virtual int | get_int_or_default (const char *path, const int &default_val) |
virtual bool | get_bool_or_default (const char *path, const bool &default_val) |
virtual std::string | get_string_or_default (const char *path, const std::string &default_val) |
virtual std::vector< float > | get_floats (const char *path)=0 |
virtual std::vector< unsigned int > | get_uints (const char *path)=0 |
virtual std::vector< int > | get_ints (const char *path)=0 |
virtual std::vector< bool > | get_bools (const char *path)=0 |
virtual std::vector< std::string > | get_strings (const char *path)=0 |
virtual std::vector< float > | get_floats_or_defaults (const char *path, const std::vector< float > &default_val) |
virtual std::vector< unsigned int > | get_uints_or_defaults (const char *path, const std::vector< unsigned int > &default_val) |
virtual std::vector< int > | get_ints_or_defaults (const char *path, const std::vector< int > &default_val) |
virtual std::vector< bool > | get_bools_or_defaults (const char *path, const std::vector< bool > &default_val) |
virtual std::vector< std::string > | get_strings_or_defaults (const char *path, const std::vector< std::string > &default_val) |
virtual ValueIterator * | get_value (const char *path)=0 |
virtual std::string | get_type (const char *path)=0 |
virtual std::string | get_comment (const char *path)=0 |
virtual std::string | get_default_comment (const char *path)=0 |
virtual void | set_float (const char *path, float f)=0 |
virtual void | set_uint (const char *path, unsigned int uint)=0 |
virtual void | set_int (const char *path, int i)=0 |
virtual void | set_bool (const char *path, bool b)=0 |
virtual void | set_string (const char *path, std::string &s)=0 |
virtual void | set_string (const char *path, const char *s)=0 |
virtual void | set_floats (const char *path, std::vector< float > &f)=0 |
virtual void | set_uints (const char *path, std::vector< unsigned int > &uint)=0 |
virtual void | set_ints (const char *path, std::vector< int > &i)=0 |
virtual void | set_bools (const char *path, std::vector< bool > &b)=0 |
virtual void | set_strings (const char *path, std::vector< std::string > &s)=0 |
virtual void | set_strings (const char *path, std::vector< const char * > &s)=0 |
virtual void | set_comment (const char *path, const char *comment)=0 |
virtual void | set_comment (const char *path, std::string &comment)=0 |
virtual void | erase (const char *path)=0 |
virtual void | set_default_float (const char *path, float f)=0 |
virtual void | set_default_uint (const char *path, unsigned int uint)=0 |
virtual void | set_default_int (const char *path, int i)=0 |
virtual void | set_default_bool (const char *path, bool b)=0 |
virtual void | set_default_string (const char *path, std::string &s)=0 |
virtual void | set_default_string (const char *path, const char *s)=0 |
virtual void | set_default_comment (const char *path, const char *comment)=0 |
virtual void | set_default_comment (const char *path, std::string &comment)=0 |
virtual void | erase_default (const char *path)=0 |
virtual ValueIterator * | iterator ()=0 |
virtual ValueIterator * | search (const char *path)=0 |
virtual void | lock ()=0 |
virtual bool | try_lock ()=0 |
virtual void | unlock ()=0 |
virtual void | try_dump ()=0 |
Protected Types | |
typedef std::list< ConfigurationChangeHandler * > | ChangeHandlerList |
List that contains pointers to ConfigurationChangeHandler. More... | |
typedef std::multimap< const char *, ConfigurationChangeHandler *, StringLess > | ChangeHandlerMultimap |
Multimap string to config change handlers. More... | |
typedef std::pair< ChangeHandlerMultimap::iterator, ChangeHandlerMultimap::iterator > | ChangeHandlerMultimapRange |
Config change handler multimap range. More... | |
Protected Member Functions | |
ChangeHandlerList * | find_handlers (const char *path) |
Find handlers for given path. More... | |
void | notify_handlers (const char *path, bool comment_changed=false) |
Notify handlers for given path. More... | |
Protected Attributes | |
ChangeHandlerMultimap | _change_handlers |
Registered change handlers. More... | |
ChangeHandlerMultimapRange | _ch_range |
Change handler range. More... | |
Interface for configuration handling. We know that half of robotics is about parameter tuning. The Configuration interface defines a unified way of storing parameters and other configuration options no matter of how the database is implemented. This is mainly done to allow for testing different solutions for ticket #10.
|
protected |
List that contains pointers to ConfigurationChangeHandler.
|
protected |
|
protected |
|
inlinevirtual |
|
virtual |
Add a configuration change handler.
The added handler is called whenever a value changes and the handler desires to get notified for the given component.
h | configuration change handler |
Reimplemented in fawkes::NetworkConfiguration.
Definition at line 609 of file config.cpp.
Referenced by fawkes::NetworkConfiguration::add_change_handler(), ConfigChangeWatcherTool::ConfigChangeWatcherTool(), ProcRRDThread::init(), MongoRRDThread::init(), StaticTransformsThread::init(), LaserLinesThread::init(), and SickTiM55xCommonAcquisitionThread::pre_init().
|
pure virtual |
Copies all values from the given configuration. All values from the given configuration are copied. Old values are not erased so that the copied values will overwrite existing values, new values are created, but values existent in current config but not in the copied config will remain unchanged.
copyconf | configuration to copy |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Erase the given value from the configuration. It is not an error if the value does not exists before deletion.
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Erase the given default value from the configuration. It is not an error if the value does not exists before deletion.
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Check if a given value exists.
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
Referenced by EventTriggerManager::EventTriggerManager(), ROSOdometryThread::init(), GossipThread::init(), PddlRobotMemoryThread::init(), NavGraphGeneratorThread::init(), NavGraphThread::init(), RobotinoSimThread::init(), and GlobalStatePlexilAdapter::initialize().
|
protected |
Find handlers for given path.
path | path to get handlers for |
Definition at line 657 of file config.cpp.
References _ch_range, and _change_handlers.
|
pure virtual |
Get value from configuration which is of type bool
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
Referenced by AmclPlugin::AmclPlugin(), BlackBoardLoggerPlugin::BlackBoardLoggerPlugin(), BlackBoardLogReplayPlugin::BlackBoardLogReplayPlugin(), BlackBoardSynchronizationPlugin::BlackBoardSynchronizationPlugin(), DynamixelPlugin::DynamixelPlugin(), EventTriggerManager::EventTriggerManager(), fawkes::FawkesMainThread::FawkesMainThread(), PanTiltSonyEviD100PThread::finalize(), FvRetrieverPlugin::FvRetrieverPlugin(), IMUPlugin::IMUPlugin(), JacoActThread::init(), FountainThread::init(), JoystickTeleOpThread::init(), StnGeneratorThread::init(), ClipsTFThread::init(), TabletopVisualizationThread::init(), AgentControlThread::init(), EclipseAgentThread::init(), LaserSensorThread::init(), GossipThread::init(), JoystickAcquisitionThread::init(), CedarThread::init(), ClipsExecutiveThread::init(), GazsimCommThread::init(), PanTiltSonyEviD100PThread::init(), PddlRobotMemoryThread::init(), DirectRobotinoComThread::init(), ROSNodeThread::init(), fawkes::FawkesTimingThread::init(), RefBoxCommThread::init(), WebviewThread::init(), Roomba500Thread::init(), FvRetrieverThread::init(), ClipsAgentThread::init(), OpenNiContextThread::init(), RobotinoSensorThread::init(), NaoQiLedThread::init(), CLIPSThread::init(), ColliActThread::init(), OpenPRSThread::init(), MapLaserGenThread::init(), NaoQiButtonThread::init(), XmlRpcThread::init(), DynamixelDriverThread::init(), RobotinoActThread::init(), NavGraphGeneratorThread::init(), PanTiltRX28Thread::init(), LaserClusterThread::init(), NavGraphThread::init(), LuaAgentPeriodicExecutionThread::init(), RobotinoSimThread::init(), ColliThread::init(), JacoOpenraveBaseThread::init(), LuaAgentContinuousExecutionThread::init(), MongoDBReplicaSetConfig::init(), RosTfThread::init(), Bumblebee2Thread::init(), SkillerExecutionThread::init(), OpenNiPointCloudThread::init(), KatanaActThread::init(), LaserLinesThread::init(), OpenRobotinoComThread::init(), AmclThread::init(), TabletopObjectsThread::init(), GlobalStatePlexilAdapter::initialize(), JacoPlugin::JacoPlugin(), LaserClusterPlugin::LaserClusterPlugin(), LaserFilterPlugin::LaserFilterPlugin(), fawkes::LaserOccupancyGrid::LaserOccupancyGrid(), LaserPlugin::LaserPlugin(), LuaAgentPlugin::LuaAgentPlugin(), MongoDBClientConfig::MongoDBClientConfig(), MongoDBInstanceConfig::MongoDBInstanceConfig(), MongoLogPlugin::MongoLogPlugin(), NavGraphGeneratorPlugin::NavGraphGeneratorPlugin(), NavGraphPlugin::NavGraphPlugin(), OpenPRSAgentPlugin::OpenPRSAgentPlugin(), PanTiltPlugin::PanTiltPlugin(), PointCloudDBMergePipeline< pcl::PointXYZ >::PointCloudDBMergePipeline(), LaseEdlAcquisitionThread::pre_init(), LaserLinesThread::read_config(), SkillerPlugin::SkillerPlugin(), and WebviewPlugin::WebviewPlugin().
|
virtual |
Get value from configuration which is of type bool, or the given default if the path does not exist
path | path to value |
default_val | the default value |
Definition at line 732 of file config.cpp.
Referenced by Realsense2Thread::init(), RealsenseThread::init(), and PlexilExecutiveThread::init().
|
pure virtual |
Get list of values from configuration which is of type bool
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
virtual |
Get list of values from configuration which is of type bool, or the given default if the path does not exist
path | path to value |
default_val | the default value |
Definition at line 782 of file config.cpp.
|
pure virtual |
Get comment of value at given path. The value at the given path must exist in the host-specific configuration.
path | path to value |
ConfigEntryNotFoundException | shall be thrown if value does not exist |
ConfigurationException | shall be thrown on any other error |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Get comment of value at given path. The value at the given path must exist in the default configuration.
path | path to value |
ConfigEntryNotFoundException | shall be thrown if value does not exist |
ConfigurationException | shall be thrown on any other error |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Get value from configuration which is of type float
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
Referenced by BlackboardComputable::BlackboardComputable(), BlackBoardLogReplayPlugin::BlackBoardLogReplayPlugin(), GazsimWebcam::GazsimWebcam(), HokuyoUrgAcquisitionThread::init(), JoystickTeleOpThread::init(), NavGraphVisualizationThread::init(), TabletopVisualizationThread::init(), JoystickAcquisitionThread::init(), GazsimCommThread::init(), LaserSimThread::init(), MongoLogTransformsThread::init(), DirectRobotinoComThread::init(), RRDThread::init(), RefBoxCommThread::init(), LocalizationSimThread::init(), VisLocalizationThread::init(), ClipsAgentThread::init(), ColliActThread::init(), OpenPRSThread::init(), MapLaserGenThread::init(), DynamixelDriverThread::init(), RobotinoActThread::init(), NavGraphClustersThread::init(), NavGraphGeneratorThread::init(), PanTiltRX28Thread::init(), DepthcamSimThread::init(), LaserClusterThread::init(), MongoLogPointCloudThread::init(), NavGraphThread::init(), RosPointCloudThread::init(), MongoLogImagesThread::init(), RobotMemoryThread::init(), RobotinoSimThread::init(), JacoOpenraveBaseThread::init(), ColliThread::init(), MongoDBReplicaSetConfig::init(), RosTfThread::init(), Bumblebee2Thread::init(), KatanaActThread::init(), AmclThread::init(), RobotStatePublisherThread::init(), TabletopObjectsThread::init(), GlobalStatePlexilAdapter::initialize(), LaserDeadSpotsDataFilter::LaserDeadSpotsDataFilter(), fawkes::LaserOccupancyGrid::LaserOccupancyGrid(), MongoDBInstanceConfig::MongoDBInstanceConfig(), PointCloudDBMergePipeline< pcl::PointXYZ >::PointCloudDBMergePipeline(), PointCloudDBPipeline< pcl::PointXYZ >::PointCloudDBPipeline(), LaseEdlAcquisitionThread::pre_init(), SickTiM55xCommonAcquisitionThread::read_common_config(), LaserLinesThread::read_config(), and TransformComputable::TransformComputable().
|
virtual |
Get value from configuration which is of type float, or the given default if the path does not exist
path | path to value |
default_val | the default value |
Definition at line 702 of file config.cpp.
Referenced by SkillerSimulatorExecutionThread::init(), Realsense2Thread::init(), and RealsenseThread::init().
|
pure virtual |
Get list of values from configuration which is of type float
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
Referenced by ROSOdometryThread::init(), MetricsThread::init(), PointCloudDBMergePipeline< pcl::PointXYZ >::PointCloudDBMergePipeline(), and PointCloudDBPipeline< pcl::PointXYZ >::PointCloudDBPipeline().
|
virtual |
Get list of values from configuration which is of type float, or the given default if the path does not exist
path | path to value |
default_val | the default value |
Definition at line 752 of file config.cpp.
|
pure virtual |
Get value from configuration which is of type int
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
Referenced by fawkes::AStarColli::AStarColli(), BlackboardComputable::BlackboardComputable(), RealsenseThread::init(), NavGraphClustersThread::init(), RobotMemoryThread::init(), RobotinoSimThread::init(), MongoDBReplicaSetConfig::init(), ColliThread::init(), Bumblebee2Thread::init(), GlobalStatePlexilAdapter::initialize(), fawkes::LaserOccupancyGrid::LaserOccupancyGrid(), and TransformComputable::TransformComputable().
|
virtual |
Get value from configuration which is of type int, or the given default if the path does not exist
path | path to value |
default_val | the default value |
Definition at line 722 of file config.cpp.
Referenced by LaserMapFilterDataFilter::LaserMapFilterDataFilter().
|
pure virtual |
Get list of values from configuration which is of type int
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
virtual |
Get list of values from configuration which is of type int, or the given default if the path does not exist
path | path to value |
default_val | the default value |
Definition at line 772 of file config.cpp.
|
pure virtual |
Get value from configuration which is of type string
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
Referenced by BlackBoardLoggerPlugin::BlackBoardLoggerPlugin(), BlackBoardLogReplayPlugin::BlackBoardLogReplayPlugin(), ComputablesManager::ComputablesManager(), EventTriggerManager::EventTriggerManager(), FvRetrieverPlugin::FvRetrieverPlugin(), GazsimWebcam::GazsimWebcam(), IMUPlugin::IMUPlugin(), SickTiM55xEthernetAcquisitionThread::init(), SickTiM55xUSBAcquisitionThread::init(), JacoActThread::init(), HokuyoUrgAcquisitionThread::init(), ROSCmdVelThread::init(), ROSOdometryThread::init(), ROSRobotDescriptionThread::init(), BackendInfoRestApi::init(), NavGraphGeneratorVisualizationThread::init(), ProcRRDThread::init(), IMUSensorThread::init(), FountainThread::init(), CruizCoreXG1010AcquisitionThread::init(), JoystickTeleOpThread::init(), RosIMUThread::init(), StnGeneratorThread::init(), NavGraphVisualizationThread::init(), OpenPRSAgentThread::init(), TabletopVisualizationThread::init(), AgentControlThread::init(), EclipseAgentThread::init(), RobotinoIrPclThread::init(), FestivalSynthThread::init(), RosNavgraphBreakoutThread::init(), GossipThread::init(), OpenraveRobotMemoryThread::init(), PanTiltDirectedPerceptionThread::init(), LaserSensorThread::init(), HokuyoUrgGbxAcquisitionThread::init(), FliteSynthThread::init(), ClipsExecutiveThread::init(), PanTiltSonyEviD100PThread::init(), JoystickAcquisitionThread::init(), GazsimTimesourceThread::init(), ROSNodeThread::init(), PddlRobotMemoryThread::init(), PointCloudDBStoreThread::init(), DirectRobotinoComThread::init(), LaserSimThread::init(), MongoLogTransformsThread::init(), RefBoxCommThread::init(), WebviewThread::init(), NavGraphROSPubThread::init(), GazeboNodeThread::init(), PddlPlannerThread::init(), Roomba500Thread::init(), LocalizationSimThread::init(), OpenNiContextThread::init(), VisLocalizationThread::init(), IMUAcquisitionThread::init(), PointCloudDBRetrieveThread::init(), FvRetrieverThread::init(), BlackBoardSynchronizationThread::init(), OpenNiPclOnlyThread::init(), CLIPSThread::init(), ColliActThread::init(), MongoLogBlackboardThread::init(), RobotinoSensorThread::init(), OpenNiImageThread::init(), OpenPRSThread::init(), RosMoveBaseThread::init(), MapLaserGenThread::init(), PointCloudDBMergeThread::init(), DynamixelDriverThread::init(), PointCloudDBROSCommThread::init(), RealsenseThread::init(), RosPosition3DThread::init(), NavGraphClustersThread::init(), NavGraphGeneratorThread::init(), PanTiltRX28Thread::init(), RobotinoActThread::init(), PlexilExecutiveThread::init(), DepthcamSimThread::init(), LaserClusterThread::init(), NavGraphThread::init(), MongoLogPointCloudThread::init(), MongoLogImagesThread::init(), LuaAgentPeriodicExecutionThread::init(), RobotinoSimThread::init(), MongoDBReplicaSetConfig::init(), ColliThread::init(), LuaAgentContinuousExecutionThread::init(), PlayerClientThread::init(), Bumblebee2Thread::init(), SkillerExecutionThread::init(), OpenNiPointCloudThread::init(), NavGraphInteractiveThread::init(), KatanaActThread::init(), OpenRobotinoComThread::init(), AmclThread::init(), RobotStatePublisherThread::init(), TabletopObjectsThread::init(), GlobalStatePlexilAdapter::initialize(), BehaviorEnginePlexilAdapter::initialize(), LaserBoxFilterDataFilter::LaserBoxFilterDataFilter(), LaserMapFilterDataFilter::LaserMapFilterDataFilter(), fawkes::LaserOccupancyGrid::LaserOccupancyGrid(), LaserPlugin::LaserPlugin(), fawkes::PluginManager::load(), MongoDBClientConfig::MongoDBClientConfig(), MongoDBInstanceConfig::MongoDBInstanceConfig(), MongoLogPlugin::MongoLogPlugin(), OpenPRSAgentPlugin::OpenPRSAgentPlugin(), PanTiltPlugin::PanTiltPlugin(), PointCloudDBMergePipeline< pcl::PointXYZ >::PointCloudDBMergePipeline(), PointCloudDBRetrievePipeline< pcl::PointXYZ >::PointCloudDBRetrievePipeline(), LaseEdlAcquisitionThread::pre_init(), LaserLinesThread::read_config(), RobotinoPlugin::RobotinoPlugin(), fawkes::SelectDriveMode::SelectDriveMode(), and WebviewUserVerifier::verify_user().
|
virtual |
Get value from configuration which is of type string, or the given default if the path does not exist
path | path to value |
default_val | the default value |
Definition at line 742 of file config.cpp.
Referenced by MongoLogLoggerThread::init(), Realsense2Thread::init(), PlexilExecutiveThread::init(), and MongoDBInstanceConfig::MongoDBInstanceConfig().
|
pure virtual |
Get list of values from configuration which is of type string
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
Referenced by EventTriggerManager::EventTriggerManager(), NavGraphStaticConstraintsThread::init(), ClipsProtobufThread::init(), EclipseAgentThread::init(), ClipsExecutiveThread::init(), GazsimCommThread::init(), WebviewThread::init(), ClipsAgentThread::init(), MongoLogBlackboardThread::init(), WebcamSimThread::init(), MongoLogPointCloudThread::init(), MongoLogImagesThread::init(), MongoDBReplicaSetConfig::init(), fawkes::PluginManager::load(), MongoDBClientConfig::MongoDBClientConfig(), and TransformComputable::TransformComputable().
|
virtual |
Get list of values from configuration which is of type string, or the given default if the path does not exist
path | path to value |
default_val | the default value |
Definition at line 792 of file config.cpp.
Referenced by PlexilExecutiveThread::init().
|
pure virtual |
Get type of value at given path.
path | path to value |
ConfigurationException | shall be thrown if value does not exist or on any other error. |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Get value from configuration which is of type unsigned int
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
Referenced by fawkes::FawkesMainThread::FawkesMainThread(), RosClockThread::init(), BallPosLogThread::init(), HokuyoUrgAcquisitionThread::init(), ProcRRDThread::init(), RoombaJoystickThread::init(), TimeTrackerMainLoopThread::init(), JoystickTeleOpThread::init(), CruizCoreXG1010AcquisitionThread::init(), FountainThread::init(), TabletopVisualizationThread::init(), GossipThread::init(), PanTiltDirectedPerceptionThread::init(), PanTiltSonyEviD100PThread::init(), JoystickAcquisitionThread::init(), DirectRobotinoComThread::init(), ROSNodeThread::init(), fawkes::FawkesTimingThread::init(), RefBoxCommThread::init(), WebviewThread::init(), BlackBoardSynchronizationThread::init(), OpenPRSThread::init(), XmlRpcThread::init(), DynamixelDriverThread::init(), RobotinoActThread::init(), NavGraphGeneratorThread::init(), PanTiltRX28Thread::init(), LaserClusterThread::init(), MongoLogPointCloudThread::init(), MongoLogImagesThread::init(), PlayerClientThread::init(), Bumblebee2Thread::init(), KatanaActThread::init(), OpenRobotinoComThread::init(), AmclThread::init(), TabletopObjectsThread::init(), MongoDBInstanceConfig::MongoDBInstanceConfig(), PointCloudDBMergePipeline< pcl::PointXYZ >::PointCloudDBMergePipeline(), LaseEdlAcquisitionThread::pre_init(), and LaserLinesThread::read_config().
|
virtual |
Get value from configuration which is of type unsigned int, or the given default if the path does not exist
path | path to value |
default_val | the default value |
Definition at line 712 of file config.cpp.
Referenced by Realsense2Thread::init(), and RealsenseThread::init().
|
pure virtual |
Get list of values from configuration which is of type unsigned int
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
Referenced by GazsimCommThread::init(), and DynamixelDriverThread::init().
|
virtual |
Get list of values from configuration which is of type unsigned int, or the given default if the path does not exist
path | path to value |
default_val | the default value |
Definition at line 762 of file config.cpp.
|
pure virtual |
Get value from configuration.
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Check if a value is of type bool
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Check if a value was read from the default config.
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Check if a value is of type float
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Check if a value is of type int
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Check if a value is a list.
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
Referenced by PlexilExecutiveThread::init(), and fawkes::PluginManager::load().
|
pure virtual |
Check if a value is of type string
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Check if a value is of type unsigned int
path | path to value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Iterator for all values. Returns an iterator that can be used to iterate over all values in the current configuration, it will value the overlay. If a default and a host-specific value exists you will only see the host-specific value.
Implemented in fawkes::NetworkConfiguration, fawkes::SQLiteConfiguration, fawkes::YamlConfiguration, and fawkes::MemoryConfiguration.
Referenced by fawkes::SQLiteConfiguration::copy(), fawkes::NetworkConfiguration::copy(), and fawkes::ConfigNetworkHandler::loop().
|
pure virtual |
Load configuration. Loads configuration data, or opens a file, depending on the implementation. After this call access to all other methods shall be possible.
file_path | path of the configuration file. |
Implemented in fawkes::SQLiteConfiguration, fawkes::NetworkConfiguration, fawkes::YamlConfiguration, and fawkes::MemoryConfiguration.
|
pure virtual |
Lock the config. No further changes or queries can be executed on the configuration and will block until the config is unlocked.
Implemented in fawkes::NetworkConfiguration, fawkes::SQLiteConfiguration, fawkes::YamlConfiguration, and fawkes::MemoryConfiguration.
Referenced by fawkes::SQLiteConfiguration::copy(), fawkes::NetworkConfiguration::copy(), fawkes::ConfigNetworkHandler::loop(), and AmclThread::loop().
|
protected |
Notify handlers for given path.
path | path to notify handlers for |
comment_changed | true if the change is about a comment change, false otherwise |
Definition at line 680 of file config.cpp.
Referenced by fawkes::SQLiteConfiguration::erase(), fawkes::SQLiteConfiguration::erase_default(), fawkes::SQLiteConfiguration::set_bool(), fawkes::SQLiteConfiguration::set_comment(), fawkes::SQLiteConfiguration::set_default_bool(), fawkes::SQLiteConfiguration::set_default_comment(), fawkes::SQLiteConfiguration::set_default_float(), fawkes::SQLiteConfiguration::set_default_int(), fawkes::SQLiteConfiguration::set_default_string(), fawkes::SQLiteConfiguration::set_default_uint(), fawkes::SQLiteConfiguration::set_float(), fawkes::SQLiteConfiguration::set_int(), fawkes::SQLiteConfiguration::set_string(), fawkes::YamlConfiguration::set_string(), and fawkes::SQLiteConfiguration::set_uint().
|
virtual |
Remove a configuration change handler.
The handler is removed from the change handler list and no longer called on config changes.
h | configuration change handler |
Reimplemented in fawkes::NetworkConfiguration.
Definition at line 625 of file config.cpp.
References _ch_range, and _change_handlers.
Referenced by ProcRRDThread::finalize(), MongoRRDThread::finalize(), StaticTransformsThread::finalize(), ConfigChangeWatcherTool::handle_signal(), and fawkes::NetworkConfiguration::rem_change_handler().
|
pure virtual |
Iterator with search results. Returns an iterator that can be used to iterate over the search results. All values whose path start with the given strings are returned. A call like
is effectively the same as a call to iterator().
path | start of path |
Implemented in fawkes::NetworkConfiguration, fawkes::SQLiteConfiguration, fawkes::YamlConfiguration, and fawkes::MemoryConfiguration.
Referenced by BlackBoardLoggerPlugin::BlackBoardLoggerPlugin(), BlackBoardLogReplayPlugin::BlackBoardLogReplayPlugin(), BlackBoardSynchronizationPlugin::BlackBoardSynchronizationPlugin(), DynamixelPlugin::DynamixelPlugin(), FvRetrieverPlugin::FvRetrieverPlugin(), IMUPlugin::IMUPlugin(), BackendInfoRestApi::init(), ProcRRDThread::init(), MongoRRDThread::init(), GossipThread::init(), ClipsExecutiveThread::init(), LaserFilterThread::init(), GlobalStatePlexilAdapter::initialize(), BehaviorEnginePlexilAdapter::initialize(), LaserClusterPlugin::LaserClusterPlugin(), LaserDeadSpotsDataFilter::LaserDeadSpotsDataFilter(), LaserFilterPlugin::LaserFilterPlugin(), LaserPlugin::LaserPlugin(), and PanTiltPlugin::PanTiltPlugin().
|
pure virtual |
Set new value in configuration of type bool
path | path to value |
b | new bool value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new value in configuration of type bool
path | path to value |
b | new bool values |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new comment for existing value. Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.
path | path to value |
comment | new comment string |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new comment for existing value.
path | path to value |
comment | new comment string |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new default value in configuration of type bool
path | path to value |
b | new bool value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new default comment for existing default configuration value. Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.
path | path to value |
comment | new comment string |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new default comment for existing default configuration value.
path | path to value |
comment | new comment string |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new default value in configuration of type float
path | path to value |
f | new float value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new default value in configuration of type int
path | path to value |
i | new int value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new default value in configuration of type string. Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.
path | path to value |
s | new string value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new default value in configuration of type string
path | path to value |
s | new string value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new default value in configuration of type unsigned int
path | path to value |
uint | new unsigned int value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new value in configuration of type float
path | path to value |
f | new float value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
Referenced by AmclThread::loop().
|
pure virtual |
Set new value in configuration of type float
path | path to value |
f | new float values |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new value in configuration of type int
path | path to value |
i | new int value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new value in configuration of type int
path | path to value |
i | new int values |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new value in configuration of type string. Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.
path | path to value |
s | new string value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new value in configuration of type string
path | path to value |
s | new string value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
Referenced by BlackBoardLoggerPlugin::BlackBoardLoggerPlugin(), Roomba500Thread::init(), and MongoLogPlugin::MongoLogPlugin().
|
pure virtual |
Set new value in configuration of type string. Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.
path | path to value |
s | new string values |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new value in configuration of type string
path | path to value |
s | new string values |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new value in configuration of type unsigned int
path | path to value |
uint | new unsigned int value |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Set new value in configuration of type unsigned int
path | path to value |
uint | new unsigned int values |
Implemented in fawkes::NetworkConfiguration, fawkes::YamlConfiguration, fawkes::MemoryConfiguration, and fawkes::SQLiteConfiguration.
|
pure virtual |
Try to dump configuration. For configuration methods that transform configuration files in a binary format this can be used to write out the text representation on shutdown of Fawkes.
Exception | thrown if dumping fails |
Implemented in fawkes::NetworkConfiguration, fawkes::SQLiteConfiguration, fawkes::YamlConfiguration, and fawkes::MemoryConfiguration.
Referenced by fawkes::FawkesMainThread::~FawkesMainThread().
|
pure virtual |
Try to lock the config.
Implemented in fawkes::NetworkConfiguration, fawkes::SQLiteConfiguration, fawkes::YamlConfiguration, and fawkes::MemoryConfiguration.
|
pure virtual |
Unlock the config. Modifications and queries are possible again.
Implemented in fawkes::NetworkConfiguration, fawkes::SQLiteConfiguration, fawkes::YamlConfiguration, and fawkes::MemoryConfiguration.
Referenced by fawkes::SQLiteConfiguration::copy(), fawkes::NetworkConfiguration::copy(), fawkes::ConfigNetworkHandler::loop(), and AmclThread::loop().
|
protected |
Change handler range.
Definition at line 462 of file config.h.
Referenced by find_handlers(), and rem_change_handler().
|
protected |
Registered change handlers.
Definition at line 460 of file config.h.
Referenced by find_handlers(), and rem_change_handler().