orxonox::ConfigFileEntry Class Reference

This class represents an entry in the config file. More...

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

Inheritance diagram for orxonox::ConfigFileEntry:

Public Member Functions
virtual	~ConfigFileEntry ()=default
	Destructor. More...
virtual const std::string &	getFileEntry () const =0
	Returns the line as it will be stored in the config file. More...
virtual unsigned int	getIndex () const
	Returns the index of the entry in a vector (used only if it is a vector) More...
virtual const std::string &	getName () const =0
	Returns the name of the entry. More...
virtual const std::string &	getValue () const =0
	Returns the value of the entry. More...
virtual void	setComment (const std::string &comment)=0
	Changes the comment of the entry (will be placed after the value) More...
virtual void	setString (bool bString)=0
	Defines if this entry is treated as string which means some special treatment of special characters. More...
virtual void	setValue (const std::string &value)=0
	Changes the value of the entry. More...

Detailed Description

This class represents an entry in the config file.

This class is pure virtual. Use one of the derived classes to define the type of the entry.

Constructor & Destructor Documentation

virtual orxonox::ConfigFileEntry::~ConfigFileEntry ( )

virtualdefault

Destructor.

Member Function Documentation

virtual const std::string& orxonox::ConfigFileEntry::getFileEntry ( ) const

pure virtual

Returns the line as it will be stored in the config file.

Implemented in orxonox::ConfigFileEntryValue, and orxonox::ConfigFileEntryComment.

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

inlinevirtual

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

Reimplemented in orxonox::ConfigFileEntryVectorValue.

virtual const std::string& orxonox::ConfigFileEntry::getName ( ) const

pure virtual

Returns the name of the entry.

Implemented in orxonox::ConfigFileEntryValue, and orxonox::ConfigFileEntryComment.

virtual const std::string& orxonox::ConfigFileEntry::getValue ( ) const

pure virtual

Returns the value of the entry.

Implemented in orxonox::ConfigFileEntryValue, and orxonox::ConfigFileEntryComment.

virtual void orxonox::ConfigFileEntry::setComment ( const std::string &  comment )

pure virtual

Changes the comment of the entry (will be placed after the value)

Implemented in orxonox::ConfigFileEntryValue, and orxonox::ConfigFileEntryComment.

virtual void orxonox::ConfigFileEntry::setString ( bool  bString )

pure virtual

Defines if this entry is treated as string which means some special treatment of special characters.

Implemented in orxonox::ConfigFileEntryValue, and orxonox::ConfigFileEntryComment.

virtual void orxonox::ConfigFileEntry::setValue ( const std::string &  value )

pure virtual

Changes the value of the entry.

Implemented in orxonox::ConfigFileEntryValue, and orxonox::ConfigFileEntryComment.

---

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

• libraries/core/config/ConfigFileEntry.h