ini::Key Klassenreferenz

Eine Variable mit Wert eventuell auch in einer Sektion wie z.B.: "Pixel=1024". Variable und Wert sind durch ein "=" getrennt. Mehr ...

#include <IniKey.h>

Klassendiagramm für ini::Key:

Öffentliche Methoden
	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)
Öffentliche Methoden geerbt von 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

Geschützte Methoden
	Key (const std::string &sCharLine, LINE_TYPE eLineType)
	Key ()
Geschützte Methoden geerbt von ini::Line
	Line (const std::string &sCharLine, LINE_TYPE eLineType)
	Line ()
char *	getTextWithEOL () const

Private Methoden
	Key (const Key &)
Key &	operator= (const Key &)

Freundbeziehungen
class	LineFactory

Weitere Geerbte Elemente
Geschützte Attribute geerbt von ini::Line
std::string	m_sText
LINE_TYPE	m_eLineType
LineFactory	m_LineFactory

Ausführliche Beschreibung

Eine Variable mit Wert eventuell auch in einer Sektion wie z.B.: "Pixel=1024". Variable und Wert sind durch ein "=" getrennt.

Autor

Helmut Jakoby

Copyright

© 1995 Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

Key() [1/4]

ini::Key::Key

(

const std::string &

sCharLine

)

Konstruktor mit Parameterübergabe.

Parameter

[in]

sCharLine

Der Text des Eintrags.

~Key()

virtual ini::Key::~Key ( )

virtual

Destruktor.

Key() [2/4]

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

protected

Dieser Konstruktor mit Parameterübergabe steht nicht öffendlich zur Verfügung.

Parameter

[in]	sCharLine	Der Text des Eintrags.
[in]	eLineType	Der Typ des Eintrags, die Aufrufende Instanz muss den richtigen Typen, hier IniVARIABLE, ermittelt haben.

Key() [3/4]

ini::Key::Key ( )

protected

Der Standartkonstruktor steht nicht öffendlich zur Verfügung.

Key() [4/4]

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

private

Der Copy-Konstruktor steht nicht zur Verfügung.

Dokumentation der Elementfunktionen

getKeyName()

std::string ini::Key::getKeyName

(

)

const

Liefert die Bezeichnung der Variable.

Rückgabe

Die Variablenbezeichnung als String ohne angehängtes "=".

getKeyValue()

std::string ini::Key::getKeyValue

(

)

const

Liefert den Wert der Variable.

Rückgabe

Der Wert als String ohne führendes "=".

operator=()

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

private

Der Zuweisungsoperator steht nicht zur Verfügung.

setKeyName()

void ini::Key::setKeyName

(

const std::string &

sName

)

Setzt die Bezeichnung der Variable.

Parameter

[in]

sName

Die Bezeichnung als String ohne angehängtes "=".

Zu beachten

Wenn der INI-Eintrag vorher "Aufloesung=1024" war und die Bezeichnung der Variablen auf "Pixel" geändert wurd, ist der neue INI-Eintrag "Pixel=1024".

setKeyValue()

void ini::Key::setKeyValue

(

const std::string &

sValue

)

Setzt den Wert der Variable.

Parameter

[in]

sValue

Der Wert als String ohne führendes "=".

Zu beachten

Wenn der INI-Eintrag vorher "Aufloesung=1024" war und der Wert der Variablen auf "640" geändert wurd, ist der neue INI-Eintrag "Aufloesung=640".

Freundbeziehungen und Funktionsdokumentation

LineFactory

friend class LineFactory

friend

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• IniKey.h