roviz  0.7
Code Documentation of roviz
Public Member Functions | List of all members
Config< T > Class Template Reference

Storage for the configuration of an item. More...

#include <config.h>

Collaboration diagram for Config< T >:
Collaboration graph

Public Member Functions

 Config ()=default
 Constructs an empty config, don't try to access it.
 

Config interface

Look at RovizItem::addConfig for an explanation of the parameters. Never use those directly, always use RovizItem::addConfig!

 Config (ConfigImpl *impl)
 
ConfigStorageType< T >::type value (void)
 Get the current value stored in the config. More...
 
bool changed (void)
 Check, wether the value stored in the config has changed since it was last accessed. More...
 

Detailed Description

template<typename T>
class Config< T >

Storage for the configuration of an item.

You can store configurations that you rarely change using this class. Always use the RovizItem::addConfig functions to construct a Config!

See also
ConfigBase
Trim
ConfigPrivate

Member Function Documentation

◆ changed()

template<typename T >
bool Config< T >::changed ( void  )

Check, wether the value stored in the config has changed since it was last accessed.

Returns
true, if the value changed, false otherwise

◆ value()

template<typename T >
ConfigStorageType< T >::type Config< T >::value ( void  )

Get the current value stored in the config.

Returns
The value with the appropriate type

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