IniFile
Loading...
Searching...
No Matches
ini::Key Class Reference

A variable with value possibly also in a section like "Pixel=1024". Variable and value are separated by a "=". More...

#include <IniKey.h>

Inheritance diagram for ini::Key:

Public Member Functions

 Key (const std::string &sCharLine)
 
virtual ~Key ()
 
std::string getKeyName () const
 
void setKeyName (const std::string &sName)
 
std::string getKeyValue () const
 
void setKeyValue (const std::string &sValue)
 
- Public Member Functions inherited from ini::Line
 Line (const std::string &sCharLine)
 
virtual ~Line ()
 
std::string getText () const
 
void setText (std::string sCharLine)
 
LINE_TYPE getType () const
 
std::size_t getLineSizeWithEOL () const
 

Protected Member Functions

 Key (const std::string &sCharLine, LINE_TYPE eLineType)
 
 Key ()
 
- Protected Member Functions inherited from ini::Line
 Line (const std::string &sCharLine, LINE_TYPE eLineType)
 
 Line ()
 
char * getTextWithEOL () const
 

Private Member Functions

 Key (const Key &)
 
Keyoperator= (const Key &)
 

Friends

class LineFactory
 

Additional Inherited Members

- Protected Attributes inherited from ini::Line
std::string m_sText
 
LINE_TYPE m_eLineType
 
LineFactory m_LineFactory
 

Detailed Description

A variable with value possibly also in a section like "Pixel=1024". Variable and value are separated by a "=".

Author
Helmut Jakoby

Constructor & Destructor Documentation

◆ Key() [1/4]

ini::Key::Key ( const std::string & sCharLine)

Constructor with parameter passing.

Parameters
[in]sCharLineThe text of the entry.

◆ ~Key()

virtual ini::Key::~Key ( )
virtual

Destructor.

◆ Key() [2/4]

ini::Key::Key ( const std::string & sCharLine,
LINE_TYPE eLineType )
protected

This constructor with parameter passing is not publicly available.

Parameters
[in]sCharLineThe text of the entry.
[in]eLineTypeThe type of the entry, the calling instance must have determined the correct type, here IniVARIABLE.

◆ Key() [3/4]

ini::Key::Key ( )
protected

The standard constructor is not publicly available.

◆ Key() [4/4]

ini::Key::Key ( const Key & )
private

The copy constructor is not available.

Member Function Documentation

◆ getKeyName()

std::string ini::Key::getKeyName ( ) const

Returns the name of the variable.

Returns
The variable name as string without appended "=".

◆ getKeyValue()

std::string ini::Key::getKeyValue ( ) const

Returns the value of the variable.

Returns
The value as string without leading "=".

◆ operator=()

Key & ini::Key::operator= ( const Key & )
private

The assignment operator is not available.

◆ setKeyName()

void ini::Key::setKeyName ( const std::string & sName)

Sets the name of the variable.

Parameters
[in]sNameThe name as string without appended "=".
Note
If the INI entry was previously "Resolution=1024" and the variable name was changed to "Pixel", the new INI entry is "Pixel=1024".

◆ setKeyValue()

void ini::Key::setKeyValue ( const std::string & sValue)

Sets the value of the variable.

Parameters
[in]sValueThe value as string without leading "=".
Note
If the INI entry was previously "Resolution=1024" and the value of the variable was changed to "640", the new INI entry is "Resolution=640".

Friends And Related Symbol Documentation

◆ LineFactory

friend class LineFactory
friend

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