openfluid::core::BooleanValue Class Reference

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
StringVal.toBooleanValue(Val1);
 
// to bool
bool BoolVal; 
StringVal.toBoolean(BoolVal);

Example : conversion to string

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

#include <core/BooleanValue.hpp>

Public Member Functions
	BooleanValue () noexcept
	BooleanValue (const BooleanValue &Val) noexcept
	BooleanValue (BooleanValue &&Val) noexcept
	BooleanValue (const bool &POD) noexcept
BooleanValue &	operator= (const Value &Other) override
BooleanValue &	operator= (Value &&Other) override
BooleanValue &	operator= (const BooleanValue &)=default
BooleanValue &	operator= (BooleanValue &&)=default
virtual	~BooleanValue ()=default
	operator bool () const
Type	getType () const override
Value *	clone () const override
bool	convert (Value &Val) const override
bool	get () const
void	set (const bool &Val)
void	writeToStream (std::ostream &OutStm) const override
void	writeQuotedToStream (std::ostream &OutStm) const override
Public Member Functions inherited from openfluid::core::SimpleValue
bool	isSimple () const override
bool	isCompound () const override
Public Member Functions inherited from openfluid::core::Value
	Value ()=default
	Value (const Value &)=default
	Value (Value &&)=default
virtual	~Value ()=default
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 ()
bool	isTreeValue () const
const TreeValue &	asTreeValue () const
TreeValue &	asTreeValue ()
std::string	toString () const

Additional Inherited Members
Public Types inherited from openfluid::core::Value
enum	Type {   NONE, BOOLEAN, INTEGER, DOUBLE,   STRING, VECTOR, MATRIX, MAP,   TREE, 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)

Inheritance diagram for openfluid::core::BooleanValue:

Collaboration diagram for openfluid::core::BooleanValue:

Constructor & Destructor Documentation

BooleanValue() [1/4]

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

inlinenoexcept

Default constructor

BooleanValue() [2/4]

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

inlinenoexcept

Copy constructor

BooleanValue() [3/4]

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

inlinenoexcept

Move constructor

BooleanValue() [4/4]

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

inlinenoexcept

Constructor from plain old type

~BooleanValue()

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

virtualdefault

Member Function Documentation

clone()

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

inlineoverridevirtual

Reimplemented from openfluid::core::Value.

convert()

bool openfluid::core::BooleanValue::convert ( Value &  Val ) const

overridevirtual

Reimplemented from openfluid::core::Value.

get()

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

inline

Returns the boolean value as plain old type

Returns

the boolean value

getType()

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

inlineoverridevirtual

Implements openfluid::core::Value.

operator bool()

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

inline

Cast operator

operator=() [1/4]

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

default

operator=() [2/4]

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

default

operator=() [3/4]

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

overridevirtual

Assignment operator

Reimplemented from openfluid::core::Value.

operator=() [4/4]

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

overridevirtual

Move operator

Reimplemented from openfluid::core::Value.

set()

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

inline

Sets the plain old type boolean value

Parameters

[in]

Val

the boolean value

writeQuotedToStream()

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

inlineoverridevirtual

Implements openfluid::core::Value.

writeToStream()

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

overridevirtual

Implements openfluid::core::Value.

---

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

• core/BooleanValue.hpp