faudes::Boolean Class Reference

Elementary type. More...

#include <cfl_elementary.h>

List of all members.

Public Member Functions

 Boolean (void)
 Constructor.
 Boolean (bool val)
 Constructor provided with initial value.
 ~Boolean (void)
 Destructor.
virtual BooleanNew (void) const
 Construct on heap.
virtual BooleanCopy (void) const
 Construct copy on heap.
virtual const BooleanCast (const Type *pOther) const
 Cast the other object to Boolean.
void CValue (bool val)
 Set value.
bool CValue (void) const
 Get value.
bool * CReference (void)
 Get reference.
Boolean operator= (const bool &bbool)
 Assignment operator.
Boolean operator= (const Boolean &cobool)
 Assignment operator.
 operator bool () const
 Conversion to C++ type bool.
void DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Write data to Tokenwriter.
void DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 Read data from TokenReader.

Protected Attributes

bool mCBool
 Variable to store current value.

Detailed Description

Elementary type.

Definition at line 390 of file cfl_elementary.h.


Constructor & Destructor Documentation

faudes::Boolean::Boolean ( void   ) 

Constructor.

Definition at line 209 of file cfl_elementary.cpp.

faudes::Boolean::Boolean ( bool  val  ) 

Constructor provided with initial value.

Parameters:
val Initial value. (bool)

Definition at line 214 of file cfl_elementary.cpp.

faudes::Boolean::~Boolean ( void   )  [inline]

Destructor.

Definition at line 405 of file cfl_elementary.h.


Member Function Documentation

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

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

bool * faudes::Boolean::CReference ( void   ) 

Get reference.

Returns:
Reference to c value.

Definition at line 244 of file cfl_elementary.cpp.

bool faudes::Boolean::CValue ( void   )  const

Get value.

Returns:
Value of object. (bool)

Definition at line 239 of file cfl_elementary.cpp.

void faudes::Boolean::CValue ( bool  val  ) 

Set value.

Parameters:
val Value to be set.

Definition at line 234 of file cfl_elementary.cpp.

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

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

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

faudes::Boolean::operator bool (  )  const [inline]

Conversion to C++ type bool.

Definition at line 485 of file cfl_elementary.h.

Boolean faudes::Boolean::operator= ( const Boolean cobool  )  [inline]

Assignment operator.

Definition at line 476 of file cfl_elementary.h.

Boolean faudes::Boolean::operator= ( const bool &  bbool  )  [inline]

Assignment operator.

Definition at line 468 of file cfl_elementary.h.


Member Data Documentation

bool faudes::Boolean::mCBool [protected]

Variable to store current value.

Definition at line 529 of file cfl_elementary.h.


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

libFAUDES 2.23h --- 2014.04.03 --- c++ api documentaion by doxygen