orxonox::ConfigFileEntryComment Class Reference

This class represents a line in the config file which contains only a comment. More...

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

Inheritance diagram for orxonox::ConfigFileEntryComment:

Public Member Functions
	ConfigFileEntryComment (const std::string &comment)
	Constructor: Initializes the object. More...
virtual	~ConfigFileEntryComment ()=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...
virtual unsigned int	getIndex () const
	Returns the index of the entry in a vector (used only if it is a vector) More...

Private Attributes
std::string	comment_
	The comment. More...

Detailed Description

This class represents a line in the config file which contains only a comment.

Constructor & Destructor Documentation

orxonox::ConfigFileEntryComment::ConfigFileEntryComment ( const std::string &  comment )

inline

Constructor: Initializes the object.

virtual orxonox::ConfigFileEntryComment::~ConfigFileEntryComment ( )

inlinevirtualdefault

Destructor.

Member Function Documentation

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

inlineoverridevirtual

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

Implements orxonox::ConfigFileEntry.

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

inlineoverridevirtual

Returns the name of the entry.

Implements orxonox::ConfigFileEntry.

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

inlineoverridevirtual

Returns the value of the entry.

Implements orxonox::ConfigFileEntry.

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

inlineoverridevirtual

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

Implements orxonox::ConfigFileEntry.

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

inlineoverridevirtual

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

Implements orxonox::ConfigFileEntry.

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

inlineoverridevirtual

Changes the value of the entry.

Implements orxonox::ConfigFileEntry.

Member Data Documentation

std::string orxonox::ConfigFileEntryComment::comment_

private

The comment.

---

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

• libraries/core/config/ConfigFileEntryComment.h