rtt_dynamic_reconfigure::dynamic_reconfigure_traits< ConfigType > Struct Template Reference

#include <server.h>

Public Types
typedef Server< ConfigType >	ServerType

Static Public Member Functions
static void	clamp (ConfigType &config, const ServerType *)
static void	fromMessage (ConfigType &config, dynamic_reconfigure::Config &message, const ServerType *)
static RTT::internal::AssignableDataSource< RTT::PropertyBag >::shared_ptr	getDataSource (ConfigType &config, const ServerType *server)
static void	getDefault (ConfigType &dflt, const ServerType *)
static dynamic_reconfigure::ConfigDescriptionPtr	getDescriptionMessage (const ServerType *)
static void	getMax (ConfigType &max, const ServerType *)
static void	getMin (ConfigType &min, const ServerType *)
static void	refreshDescription (const ServerType *)
static void	toMessage (ConfigType &config, dynamic_reconfigure::Config &message, const ServerType *)

Static Public Attributes
static const bool	canRefresh = false

Detailed Description

template<class ConfigType>
struct rtt_dynamic_reconfigure::dynamic_reconfigure_traits< ConfigType >

Definition at line 77 of file server.h.

Member Typedef Documentation

template<class ConfigType >

typedef Server<ConfigType> rtt_dynamic_reconfigure::dynamic_reconfigure_traits< ConfigType >::ServerType

Definition at line 78 of file server.h.

Member Function Documentation

template<class ConfigType >

static void rtt_dynamic_reconfigure::dynamic_reconfigure_traits< ConfigType >::clamp ( ConfigType &  config, const ServerType *    )

inlinestatic

Clamp the values in the ConfigType instance to the limits given in the config description/properties

Parameters

config	referencte to the ConfigType instance to be clamped
server	pointer to the rtt_dynamic_reconfigure server instance (only used for AutoConfig)

Definition at line 148 of file server.h.

template<class ConfigType >

static void rtt_dynamic_reconfigure::dynamic_reconfigure_traits< ConfigType >::fromMessage ( ConfigType &  config, dynamic_reconfigure::Config &  message, const ServerType *    )

inlinestatic

Convert a dynamic_reconfigure::Config message to an instance of ConfigType

Parameters

config	reference to the ConfigType instance to be filled
message	reference to the Config message to be read
server	pointer to the rtt_dynamic_reconfigure server instance (only used for AutoConfig)

Definition at line 140 of file server.h.

template<class ConfigType >

static RTT::internal::AssignableDataSource<RTT::PropertyBag>::shared_ptr rtt_dynamic_reconfigure::dynamic_reconfigure_traits< ConfigType >::getDataSource ( ConfigType &  config, const ServerType *  server  )

inlinestatic

Creates a new RTT::internal::AssignableDataSource<RTT::PropertyBag> filled with properties from a ConfigType instance.

Parameters

config	referencte to the ConfigType instance to be read
server	pointer to the rtt_dynamic_reconfigure server instance whose updater is going to be used

Definition at line 156 of file server.h.

template<class ConfigType >

static void rtt_dynamic_reconfigure::dynamic_reconfigure_traits< ConfigType >::getDefault ( ConfigType &  dflt, const ServerType *    )

inlinestatic

Get the default values of config ConfigType.

Parameters

config	reference to the config instance to be filled with the default values
server	pointer to the rtt_dynamic_reconfigure server instance (only used for AutoConfig)

Definition at line 102 of file server.h.

template<class ConfigType >

static dynamic_reconfigure::ConfigDescriptionPtr rtt_dynamic_reconfigure::dynamic_reconfigure_traits< ConfigType >::getDescriptionMessage ( const ServerType *  )

inlinestatic

Get the ConfigDescription of config ConfigType.

Parameters

server

pointer to the rtt_dynamic_reconfigure server instance (only used for AutoConfig)

Returns

a shared_ptr to the dynamic_reconfigure::ConfigDescription for ConfigType

Definition at line 110 of file server.h.

template<class ConfigType >

static void rtt_dynamic_reconfigure::dynamic_reconfigure_traits< ConfigType >::getMax ( ConfigType &  max, const ServerType *    )

inlinestatic

Get the maximum values of config ConfigType.

Parameters

config	reference to the config instance to be filled with the maximum values
server	pointer to the rtt_dynamic_reconfigure server instance (only used for AutoConfig)

Definition at line 94 of file server.h.

template<class ConfigType >

static void rtt_dynamic_reconfigure::dynamic_reconfigure_traits< ConfigType >::getMin ( ConfigType &  min, const ServerType *    )

inlinestatic

Get the minimum values of config ConfigType.

Parameters

config	reference to the config instance to be filled with the minimum values
server	pointer to the rtt_dynamic_reconfigure server instance (only used for AutoConfig)

Definition at line 86 of file server.h.

template<class ConfigType >

static void rtt_dynamic_reconfigure::dynamic_reconfigure_traits< ConfigType >::refreshDescription ( const ServerType *  )

inlinestatic

Refresh the ConfigDescription from the properties of the owning TaskContext (no-op unless for ConfigType AutoConfig)

Parameters

server

pointer to the rtt_dynamic_reconfigure server instance

Definition at line 122 of file server.h.

template<class ConfigType >

static void rtt_dynamic_reconfigure::dynamic_reconfigure_traits< ConfigType >::toMessage ( ConfigType &  config, dynamic_reconfigure::Config &  message, const ServerType *    )

inlinestatic

Convert an instance of ConfigType to a dynamic_reconfigure::Config message

Parameters

config	reference to the ConfigType instance to be read
message	reference to the Config message to be filled
server	pointer to the rtt_dynamic_reconfigure server instance (only used for AutoConfig)

Definition at line 131 of file server.h.

Member Data Documentation

template<class ConfigType >

const bool rtt_dynamic_reconfigure::dynamic_reconfigure_traits< ConfigType >::canRefresh = false

static

If true, the description of ConfigType is dynamic and can be changed during run-time (e.g. by adding/removing properties).

Definition at line 115 of file server.h.

---

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

• server.h