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)
	String (std::string val)
	~String (void)
virtual String *	New (void) const
virtual String *	NewCpy (void) const
virtual const String *	Cast (const Type *pOther) const
void	CValue (std::string val)
std::string	CValue (void) const
std::string *	CReference (void)
String &	operator= (const String &costr)
String &	operator= (const std::string &cstr)
	operator std::string () const
void	DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
void	DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
Type &	operator= (const Type &rSrc)
Type &	operator= (Type &&rSrc)
Public Member Functions inherited from faudes::Type
	Type (void)
	Type (const Type &rType)
virtual	~Type (void)
virtual void	Clear (void)
virtual bool	IsDefault (void) const
virtual Type &	Copy (const Type &rSrc)
virtual Type &	Move (Type &rSrc)
Type &	operator= (const Type &rSrc)
Type &	operator= (Type &&rSrc)
virtual bool	Equal (const Type &rOther) const
bool	operator== (const Type &rOther) const
bool	operator!= (const Type &rOther) const
virtual void	Name (const std::string &rName)
virtual const std::string &	Name (void) const
virtual const std::string &	TypeName (void) const
void	Write (const Type *pContext=0) const
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
void	Write (const std::string &pFileName, std::ios::openmode openmode) const
void	Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
virtual void	XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const
void	XWrite (const Type *pContext=0) const
void	XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
std::string	ToString (const std::string &rLabel="", const Type *pContext=0) const
std::string	ToText (const std::string &rLabel="", const Type *pContext=0) const
void	DWrite (const Type *pContext=0) const
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
void	DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
void	SWrite (TokenWriter &rTw) const
void	SWrite (void) const
std::string	ToSText (void) const
void	Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)
void	FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)
void	Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)

Protected Attributes
std::string	mCString

Additional Inherited Members
Protected Member Functions inherited from faudes::Type
void	DoCopy (const Type &rSrc)
void	DoMove (Type &rSrc)
bool	DoEqual (const Type &rOther) const
virtual void	DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
virtual void	DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
virtual void	DoSWrite (TokenWriter &rTw) const
virtual const TypeDefinition *	TypeDefinitionp (void) const
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 134 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 139 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 154 of file cfl_elementary.cpp.

CReference()

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

(

void

)

Get reference.

Returns

Reference to c value.

Definition at line 169 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 164 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 159 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 198 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 174 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 144 of file cfl_elementary.cpp.

NewCpy()

String * faudes::String::NewCpy ( 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 149 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/4]

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

inline

Definition at line 331 of file cfl_elementary.h.

operator=() [2/4]

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

inline

Copyment operator.

Definition at line 323 of file cfl_elementary.h.

operator=() [3/4]

Type & faudes::Type::operator=

(

const Type &

rSrc

)

Copy configuration data from other object. Derived classes should implement at least the signature with matching source and destination types via the DoCopy method. Additionally, one may implement variants with a base class as source, as mong as meaningul assigment is possible.

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 368 of file cfl_types.cpp.

operator=() [4/4]

Type & faudes::Type::operator=

(

Type &&

rSrc

)

Copy configuration data from other object (destructive) Derived classes should implement at least the signature with matching source and destination types via the DoCopy method. Additionally, one may implement variants with a base class as source, as mong as meaningul assigment is possible.

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 383 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