faudes::Boolean Class Reference

#include <cfl_elementary.h>

Public Member Functions
	Boolean (void)
	Boolean (bool val)
	~Boolean (void)
virtual Boolean *	New (void) const
virtual Boolean *	Copy (void) const
virtual const Boolean *	Cast (const Type *pOther) const
void	CValue (bool val)
bool	CValue (void) const
bool *	CReference (void)
Boolean &	operator= (const bool &bbool)
Boolean &	operator= (const Boolean &cobool)
	operator bool () 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)
Public Member Functions inherited from faudes::Type
	Type (void)
	Type (const Type &rType)
virtual	~Type (void)
virtual void	Clear (void)
virtual Type &	Assign (const Type &rSrc)
Type &	operator= (const 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
bool	mCBool

Additional Inherited Members
Protected Member Functions inherited from faudes::Type
void	DoAssign (const 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

Detailed Description

Elementary type

Definition at line 396 of file cfl_elementary.h.

Constructor & Destructor Documentation

Boolean() [1/2]

faudes::Boolean::Boolean

(

void

)

Constructor

Definition at line 218 of file cfl_elementary.cpp.

Boolean() [2/2]

faudes::Boolean::Boolean

(

bool

val

)

Constructor provided with initial value.

Parameters

val	Initial value. (bool)

Definition at line 223 of file cfl_elementary.cpp.

~Boolean()

faudes::Boolean::~Boolean ( void  )

inline

Destructor

Definition at line 414 of file cfl_elementary.h.

Member Function Documentation

Cast()

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

virtual

Cast the other object to Boolean. Returns NULL if the cast is not possible.

Parameters

pOther

Pointer to object to cast.

Returns

Pointer to Boolean instance, or NULL

Reimplemented from faudes::Type.

Definition at line 238 of file cfl_elementary.cpp.

Copy()

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

virtual

Construct copy on heap. Create new Boolean instance and return pointer.

Returns

Pointer to Boolean instance.

Reimplemented from faudes::Type.

Definition at line 233 of file cfl_elementary.cpp.

CReference()

bool * faudes::Boolean::CReference

(

void

)

Get reference.

Returns

Reference to c value.

Definition at line 253 of file cfl_elementary.cpp.

CValue() [1/2]

void faudes::Boolean::CValue

(

bool

val

)

Set value.

Parameters

val	Value to be set.

Definition at line 243 of file cfl_elementary.cpp.

CValue() [2/2]

bool faudes::Boolean::CValue

(

void

)

const

Get value.

Returns

Value of object. (bool)

Definition at line 248 of file cfl_elementary.cpp.

DoRead()

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

virtual

Read data from TokenReader.

NOTE: 0 = false 1 = true

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 275 of file cfl_elementary.cpp.

DoWrite()

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

virtual

Write data to Tokenwriter.

NOTE: 0 = false 1 = true

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 258 of file cfl_elementary.cpp.

New()

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

virtual

Construct on heap. Create new Boolean instance and return pointer.

NOTE: Calling function takes control.

Returns

Pointer to Boolean instance.

Reimplemented from faudes::Type.

Definition at line 228 of file cfl_elementary.cpp.

operator bool()

faudes::Boolean::operator bool ( ) const

inline

Conversion to C++ type bool

Definition at line 494 of file cfl_elementary.h.

operator=() [1/3]

Boolean& faudes::Boolean::operator= ( const bool &  bbool )

inline

Assignment operator.

Definition at line 477 of file cfl_elementary.h.

operator=() [2/3]

Boolean& faudes::Boolean::operator= ( const Boolean &  cobool )

inline

Assignment operator.

Definition at line 485 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

mCBool

bool faudes::Boolean::mCBool

protected

Variable to store current value.

Definition at line 538 of file cfl_elementary.h.

---

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

• cfl_elementary.h
• cfl_elementary.cpp