orxonox::ConfigFileEntryVectorValue Class Reference

Subclass of ConfigFileEntryValue, represents an element of a vector. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/libraries/core/config/ConfigFileEntryVectorValue.h>

Inheritance diagram for orxonox::ConfigFileEntryVectorValue:

Public Member Functions
	ConfigFileEntryVectorValue (const std::string &name, unsigned int index, const std::string &value="", bool bString=false, const std::string &additionalComment="")
	Constructor: Initializes the entry. More...
	~ConfigFileEntryVectorValue ()=default
	Destructor. More...
virtual unsigned int	getIndex () const override
	Returns the index of the entry in a vector (used only if it is a vector) More...
virtual const std::string &	getKeyString () const override
	Returns the "key" of the value (the name of the vector plus the index of the element) More...
Public Member Functions inherited from orxonox::ConfigFileEntryValue
	ConfigFileEntryValue (const std::string &name, const std::string &value="", bool bString=false, const std::string &additionalComment="")
	Constructor: Initializes the entry. More...
virtual	~ConfigFileEntryValue ()=default
	Destructor. More...
virtual const std::string &	getFileEntry () const override
	Returns the line as it will be stored in the config file. More...
virtual const std::string &	getName () const override
	Returns the name of the entry. More...
virtual const std::string &	getValue () const override
	Returns the value of the entry. More...
virtual void	setComment (const std::string &comment) override
	Changes the comment of the entry (will be placed after the value) More...
virtual void	setString (bool bString) override
	Defines if this entry is treated as string which means some special treatment of special characters. More...
virtual void	setValue (const std::string &value) override
	Changes the value of the entry. More...
Public Member Functions inherited from orxonox::ConfigFileEntry
virtual	~ConfigFileEntry ()=default
	Destructor. More...

Private Member Functions
virtual void	update () override
	Updates the string that will be stored in the file after one of it's components (name, value, index, comment) has changed. More...

Private Attributes
unsigned int	index_
	The index of the element in the vector. More...
std::string	keyString_
	The full name of the entry (the name of the vector plus the index of the element) More...

Additional Inherited Members
Protected Attributes inherited from orxonox::ConfigFileEntryValue
std::string	additionalComment_
	The additional comment. More...
bool	bString_
	If true, the value is treated as string which means some special treatment of special characters. More...
std::string	fileEntry_
	The string as it will be stored in the config file. More...
const std::string	name_
	The name of the value. More...
std::string	value_
	The value. More...

Detailed Description

Subclass of ConfigFileEntryValue, represents an element of a vector.

Constructor & Destructor Documentation

orxonox::ConfigFileEntryVectorValue::ConfigFileEntryVectorValue ( const std::string &  name, unsigned int  index, const std::string &  value = "", bool  bString = false, const std::string &  additionalComment = ""  )

inline

Constructor: Initializes the entry.

Parameters

name	The name of the vector
index	The index of the element in the vector
value	The value of the element
bString	If true, the value is treated as string which means some special treatment of special characters.
additionalComment	An optional comment that will be placed behind the value in the config file

orxonox::ConfigFileEntryVectorValue::~ConfigFileEntryVectorValue ( )

inlinedefault

Destructor.

Member Function Documentation

virtual unsigned int orxonox::ConfigFileEntryVectorValue::getIndex ( ) const

inlineoverridevirtual

Returns the index of the entry in a vector (used only if it is a vector)

Reimplemented from orxonox::ConfigFileEntry.

virtual const std::string& orxonox::ConfigFileEntryVectorValue::getKeyString ( ) const

inlineoverridevirtual

Returns the "key" of the value (the name of the vector plus the index of the element)

Reimplemented from orxonox::ConfigFileEntryValue.

void orxonox::ConfigFileEntryVectorValue::update ( )

overrideprivatevirtual

Updates the string that will be stored in the file after one of it's components (name, value, index, comment) has changed.

Reimplemented from orxonox::ConfigFileEntryValue.

Member Data Documentation

unsigned int orxonox::ConfigFileEntryVectorValue::index_

private

The index of the element in the vector.

std::string orxonox::ConfigFileEntryVectorValue::keyString_

private

The full name of the entry (the name of the vector plus the index of the element)

---

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

• libraries/core/config/ConfigFileEntryVectorValue.h
• libraries/core/config/ConfigFileEntryVectorValue.cc