#include <core/BooleanValue.hpp>

Inheritance diagram for openfluid::core::BooleanValue:

Public Member Functions
	BooleanValue ()

	BooleanValue (const BooleanValue &Val)

	BooleanValue (const bool &POD)

Value &	operator= (const Value &Other)

	operator bool () const

virtual	~BooleanValue ()

Type	getType () const

Value *	clone () const

bool &	get ()

const bool &	get () const

void	set (const bool &Val)

void	writeToStream (std::ostream &OutStm) const

Public Member Functions inherited from openfluid::core::SimpleValue
bool	isSimple () const

bool	isCompound () const

Public Member Functions inherited from openfluid::core::Value
	Value ()

	Value (const Value &)

virtual	~Value ()

bool	isDoubleValue () const

const DoubleValue &	asDoubleValue () const

DoubleValue &	asDoubleValue ()

bool	isIntegerValue () const

const IntegerValue &	asIntegerValue () const

IntegerValue &	asIntegerValue ()

bool	isBooleanValue () const

const BooleanValue &	asBooleanValue () const

BooleanValue &	asBooleanValue ()

bool	isStringValue () const

const StringValue &	asStringValue () const

StringValue &	asStringValue ()

bool	isNullValue () const

const NullValue &	asNullValue () const

NullValue &	asNullValue ()

bool	isVectorValue () const

const VectorValue &	asVectorValue () const

VectorValue &	asVectorValue ()

bool	isMatrixValue () const

const MatrixValue &	asMatrixValue () const

MatrixValue &	asMatrixValue ()

bool	isMapValue () const

const MapValue &	asMapValue () const

MapValue &	asMapValue ()

std::string	toString () const

Additional Inherited Members
Public Types inherited from openfluid::core::Value
enum	Type { NONE, BOOLEAN, INTEGER, DOUBLE, STRING, VECTOR, MATRIX, MAP, NULLL }

Static Public Member Functions inherited from openfluid::core::Value
static bool	getValueTypeFromString (const std::string ValueTypeString, Value::Type &ValueType)

static std::string	getStringFromValueType (const Value::Type ValueType)

Detailed Description

BooleanValue is a container for a true/false value.

See Also: Value

Example : declaration

// declaration of a BooleanValue, initialized to false by default
openfluid::core::BooleanValue Val1;
// declaration of a BooleanValue, initialized to true
openfluid::core::BooleanValue Val2(true);

Example : getting the contained value

bool Tmp1;
// using the get method
Tmp1 = Val1.get();
// or using the cast operator
Tmp1 = Val1;

Example : setting the contained value

// using the set method

Val1.set(true);

Example : conversion from string

openfluid::core::StringValue StringVal("true");
// to BooleanValue
Val1 = StringVal.toBooleanValue();
// to bool
bool BoolVal = StringVal.toBoolean();

Example : conversion to string

std::string StdStrVal = Val1.toString();

Constructor & Destructor Documentation

openfluid::core::BooleanValue::BooleanValue ( )

inline

Default constructor

openfluid::core::BooleanValue::BooleanValue ( const BooleanValue & Val )

inline

Copy constructor

openfluid::core::BooleanValue::BooleanValue ( const bool & POD )

inline

Constructor from plain old type

virtual openfluid::core::BooleanValue::~BooleanValue ( )

inlinevirtual

Member Function Documentation

Value* openfluid::core::BooleanValue::clone ( ) const

inlinevirtual

Reimplemented from openfluid::core::Value.

bool& openfluid::core::BooleanValue::get ( )

inline

Returns the boolean value as plain old type

Returns: the boolean value

const bool& openfluid::core::BooleanValue::get ( ) const

inline

Returns the boolean value as a const plain old type

Returns: the boolean value

Type openfluid::core::BooleanValue::getType ( ) const

inlinevirtual

Implements openfluid::core::Value.

openfluid::core::BooleanValue::operator bool ( ) const

inline

Cast operator

Value& openfluid::core::BooleanValue::operator= ( const Value & )

virtual

Assignment operator

Reimplemented from openfluid::core::Value.

void openfluid::core::BooleanValue::set ( const bool & Val )

inline

Sets the plain old type boolean value

Parameters

[in] Val the boolean value

void openfluid::core::BooleanValue::writeToStream ( std::ostream & OutStm ) const

virtual

Implements openfluid::core::Value.

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

core/BooleanValue.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation