ini::Line Klassenreferenz

Ist eine Kommentartzeile, aber auch Oberklasse für Section und Key. Mehr ...

#include <IniLine.h>

Klassendiagramm für ini::Line:

Öffentliche Methoden
	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
	Line (const std::string &sCharLine, LINE_TYPE eLineType)
	Line ()
char *	getTextWithEOL () const

Geschützte Attribute
std::string	m_sText
LINE_TYPE	m_eLineType
LineFactory	m_LineFactory

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

Freundbeziehungen
class	LineFactory
class	File
class	Section

Ausführliche Beschreibung

Ist eine Kommentartzeile, aber auch Oberklasse für Section und Key.

Autor

Helmut Jakoby

Copyright

© 1995 Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

Line() [1/4]

ini::Line::Line

(

const std::string &

sCharLine

)

Konstruktor mit Parameterübergabe.

Parameter

[in]

sCharLine

Der Text des Eintrags.

~Line()

virtual ini::Line::~Line ( )

virtual

Destruktor, Speicher wird aufgeräumt.

Line() [2/4]

ini::Line::Line ( 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 gewünschte Typ des Eintrags.

Line() [3/4]

ini::Line::Line ( )

protected

Standartkonstruktor steht nicht öffendlich zur Verfügung.

Line() [4/4]

ini::Line::Line ( const Line & )

inlineprivate

Der Copy-Konstruktor steht nicht zur Verfügung.

Dokumentation der Elementfunktionen

getLineSizeWithEOL()

std::size_t ini::Line::getLineSizeWithEOL

(

)

const

Liefert die Länge des Strings aus m_sText plus EOL.

Rückgabe

Die Länge des Eintragstextes.

getText()

std::string ini::Line::getText

(

)

const

Liefert den Text des INI-Eintrags.

Rückgabe

Der Text.

getTextWithEOL()

char * ini::Line::getTextWithEOL ( ) const

protected

Liefert den Text des INI-Eintrags als einen EOL-terminierten String.

Rückgabe

Der Text mit Zeilenumbruch am Ende.

getType()

LINE_TYPE ini::Line::getType

(

)

const

Liefert den Typ des Eintrags.

Rückgabe

Der Typ als Enumaration.

operator=()

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

private

Der Zuweisungsoperator steht nicht zur Verfügung.

setText()

void ini::Line::setText

(

std::string

sCharLine

)

Setzt den Text des INI-Eintrags.

Parameter

[in]

sCharLine

Der Text als String.

Freundbeziehungen und Funktionsdokumentation

File

friend class File

friend

LineFactory

friend class LineFactory

friend

Section

friend class Section

friend

Dokumentation der Datenelemente

m_eLineType

LINE_TYPE ini::Line::m_eLineType

protected

Der Typ des Eintrags.

m_LineFactory

LineFactory ini::Line::m_LineFactory

protected

Helferklasse, liefert u.a einen typegerechten Eintrag.

m_sText

std::string ini::Line::m_sText

protected

In diesem Attribut wird die Text (eine Zeile der INI-Datei) des Eintrags abgelegt.

---

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

• IniLine.h