faudes::String Class Reference

Detailed Description

Elementary type.

Definition at line 242 of file cfl_elementary.h.

#include <cfl_elementary.h>

Public Member Functions
	String (void)
	Constructor. More...
	String (std::string val)
	Constructor provided with initial value. More...
	~String (void)
	Destructor. More...
virtual String *	New (void) const
	Construct on heap. More...
virtual String *	Copy (void) const
	Construct copy on heap. More...
virtual const String *	Cast (const Type *pOther) const
	Cast the other object to String. More...
void	CValue (std::string val)
	Set value. More...
std::string	CValue (void) const
	Get value. More...
std::string *	CReference (void)
	Get reference. More...
String &	operator= (const String &costr)
	Assignment operator. More...
String &	operator= (const std::string &cstr)
	operator std::string () const
	Conversion to std::string. More...
void	DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write data to Tokenwriter. More...
void	DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
	Read data from TokenReader. More...
Type &	operator= (const Type &rSrc)
	Assign configurationdata from other object. More...
Public Member Functions inherited from faudes::Type
	Type (void)
	Constructor. More...
	Type (const Type &rType)
	Copy constructor. More...
virtual	~Type (void)
	Destructor. More...
virtual void	Clear (void)
	Clear configuration data. More...
virtual Type &	Assign (const Type &rSrc)
	Assign configuration data from other object. More...
Type &	operator= (const Type &rSrc)
	Assign configurationdata from other object. More...
virtual bool	Equal (const Type &rOther) const
	Test equality of configuration data. More...
bool	operator== (const Type &rOther) const
	Test equality of configuration data. More...
bool	operator!= (const Type &rOther) const
	Test equality of configuration data. More...
virtual void	Name (const std::string &rName)
	Set the objects's name. More...
virtual const std::string &	Name (void) const
	Get objects's name. More...
virtual const std::string &	TypeName (void) const
	Get objects's type name. More...
void	Write (const Type *pContext=0) const
	Write configuration data to console. More...
void	Write (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
	Write configuration data to a file. More...
void	Write (const std::string &pFileName, std::ios::openmode openmode) const
	Write configuration data to a file. More...
void	Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data to TokenWriter. More...
virtual void	XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data to an XML file. More...
void	XWrite (const Type *pContext=0) const
	Write configuration data in XML format to concole Note: this write function uses the virtual function DoXWrite(), to be reimplemented by derived classes. More...
void	XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data in XML format to TokenWriter. More...
std::string	ToString (const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data to a string. More...
std::string	ToText (const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data to a formated string. More...
void	DWrite (const Type *pContext=0) const
	Write configuration data to console, debugging format. More...
void	DWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
	Write configuration data to a file, debugging format. More...
void	DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data in debug format to TokenWriter. More...
void	SWrite (TokenWriter &rTw) const
	Write statistics comment to TokenWriter. More...
void	SWrite (void) const
	Write statistics comment to console. More...
std::string	ToSText (void) const
	Write statistics to a string. More...
void	Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)
	Read configuration data from file with label specified. More...
void	FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)
	Read configuration data from a string. More...
void	Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
	Read configuration data from TokenReader with label sepcified. More...

Protected Attributes
std::string	mCString
	Variable to store current value. More...

Additional Inherited Members
Protected Member Functions inherited from faudes::Type
void	DoAssign (const Type &rSrc)
	Assign configuration data from other object. More...
bool	DoEqual (const Type &rOther) const
	Test equality of configuration data. More...
virtual void	DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data of this object to TokenWriter in XML format. More...
virtual void	DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data in debugging format to TokenWriter. More...
virtual void	DoSWrite (TokenWriter &rTw) const
	Write statistical data as a comment to TokenWriter. More...
virtual const TypeDefinition *	TypeDefinitionp (void) const
	Get objects's type definition. More...
virtual Token	XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const

Constructor & Destructor Documentation

String() [1/2]

faudes::String::String

(

void

)

Constructor.

Definition at line 129 of file cfl_elementary.cpp.

String() [2/2]

faudes::String::String

(

std::string

val

)

Constructor provided with initial value.

Parameters

val	Initial value.

Definition at line 134 of file cfl_elementary.cpp.

~String()

faudes::String::~String ( void  )

inline

Destructor.

Definition at line 260 of file cfl_elementary.h.

Member Function Documentation

Cast()

const String * faudes::String::Cast ( const Type *  pOther ) const

virtual

Cast the other object to String.

Returns NULL if the cast is not possible.

Parameters

pOther

Pointer to object to cast.

Returns

Pointer to String instance, or NULL

Reimplemented from faudes::Type.

Definition at line 149 of file cfl_elementary.cpp.

Copy()

String * faudes::String::Copy ( void  ) const

virtual

Construct copy on heap.

Create new String instance and return pointer.

Returns

Pointer to Integer instance.

Reimplemented from faudes::Type.

Definition at line 144 of file cfl_elementary.cpp.

CReference()

std::string * faudes::String::CReference

(

void

)

Get reference.

Returns

Reference to c value.

Definition at line 164 of file cfl_elementary.cpp.

CValue() [1/2]

void faudes::String::CValue

(

std::string

val

)

Set value.

Parameters

val	Value to be set. (std::string)

Definition at line 159 of file cfl_elementary.cpp.

CValue() [2/2]

std::string faudes::String::CValue

(

void

)

const

Get value.

Returns

Value of object. (std::string)

Definition at line 154 of file cfl_elementary.cpp.

DoRead()

void faudes::String::DoRead ( TokenReader &  rTr, const std::string &  rLabel = "", const Type *  pContext = 0  )

virtual

Read data from TokenReader.

Parameters

rTr	Reference to TokenReader.
rLabel	Section to read.
pContext	Read context to provide contextual information (ignored)

Exceptions

Exception

Token mismatch IO Error

Reimplemented from faudes::Type.

Definition at line 193 of file cfl_elementary.cpp.

DoWrite()

void faudes::String::DoWrite ( TokenWriter &  rTw, const std::string &  rLabel = "", const Type *  pContext = 0  ) const

virtual

Write data to Tokenwriter.

Parameters

rTw	Reference to TokenWriter.
rLabel	Label of section to write.
pContext	Write context to provide contextual information (ignored)

Exceptions

Exception

IO Error

Reimplemented from faudes::Type.

Definition at line 169 of file cfl_elementary.cpp.

New()

String * faudes::String::New ( void  ) const

virtual

Construct on heap.

Create new String instance and return pointer.

NOTE: Calling function takes control.

Returns

Pointer to String instance.

Reimplemented from faudes::Type.

Definition at line 139 of file cfl_elementary.cpp.

operator std::string()

faudes::String::operator std::string ( ) const

inline

Conversion to std::string.

Definition at line 339 of file cfl_elementary.h.

operator=() [1/3]

String& faudes::String::operator= ( const std::string &  cstr )

inline

Definition at line 331 of file cfl_elementary.h.

operator=() [2/3]

String& faudes::String::operator= ( const String &  costr )

inline

Assignment operator.

Definition at line 323 of file cfl_elementary.h.

operator=() [3/3]

Type & faudes::Type::operator=

Assign configurationdata from other object.

Derived classes should implement the operator form for the assignment for each source type which allows for a non-trivial assignment. This includes the particular case were the source and destination types match exactly. In the latter case the DoAssign method should be invoked. In contrast to the Assign function, the operator form must not be reimplemented for missmatched source types: the operator form only accepts sensible source types. This allows for compiletime typeckecking. However, the downside is that when the type is not known at compiletime, configuration is not properly assigned.

Re-implementation can be done via the convenience macros FAUDES_TYPE_DECLARATION and FAUDES_TYPE_IMPLEMENTATION.

Parameters

rSrc	Source to copy from

Returns

Reference to this object.

Definition at line 340 of file cfl_types.cpp.

Member Data Documentation

mCString

std::string faudes::String::mCString

protected

Variable to store current value.

Definition at line 376 of file cfl_elementary.h.

---

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

• cfl_elementary.h
• cfl_elementary.cpp