libFAUDES

Sections

Index

faudes::Boolean Class Reference

#include <rtitypes.h>

Inherits faudes::Type.

List of all members.


Detailed Description

Elementary type.

Public Member Functions

 Boolean (void)
 Constructor.
 Boolean (bool val)
 Constructor provided with initial value.
 ~Boolean (void)
 Destructor.
virtual TypeNew (void) const
 Construct on heap.
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.

Constructor & Destructor Documentation

faudes::Boolean::Boolean ( void   ) 

Constructor.

faudes::Boolean::Boolean ( bool  val  ) 

Constructor provided with initial value.

Parameters:
val Initial value. (bool)

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

Destructor.


Member Function Documentation

Type * 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.

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

Set value.

Parameters:
val Value to be set.

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

Get value.

Returns:
Value of object. (bool)

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

Get reference.

Returns:
Reference to c value.

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

Assignment operator.

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

Assignment operator.

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

Conversion to c type bool.

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.

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 

Reimplemented from faudes::Type.


Member Data Documentation

bool faudes::Boolean::mCBool [protected]

Variable to store current value.


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

libFAUDES 2.13a c++ source docu by doxygen 1.5.6