FDO API Reference

Feature Data Objects

FdoBooleanValue Class Reference

#include <BooleanValue.h>

Inherits FdoDataValue.

Inheritance diagram for FdoBooleanValue:

[legend]List of all members.

---

Detailed Description

The FdoBooleanValue class derives from FdoDataValue and represents a Boolean value.

Definition at line 32 of file BooleanValue.h.

Public Member Functions
FDO_API bool	GetBoolean ()
	Gets the FdoBooleanValue.
FDO_API FdoDataType	GetDataType ()
	Gets the data type of the FdoBooleanValue.
FDO_API	operator bool ()
	A cast operator to get the Boolean value.
FDO_API void	Process (FdoIExpressionProcessor *p)
	Overrides FdoExpression.Process to pass the FdoBooleanValue to the appropriate expression processor operation.
FDO_API void	SetBoolean (bool value)
	Sets the Boolean value.
FDO_API FdoString *	ToString ()
	Returns the well defined text representation of this expression.
Static Public Member Functions
FDO_API FdoBooleanValue *	Create (bool value)
	Constructs a default instance of an FdoBooleanValue using the specified arguments.
FDO_API FdoBooleanValue *	Create ()
	Constructs a default instance of an FdoBooleanValue with a value of null.
Protected Member Functions
virtual void	Dispose ()
	Dispose this object.
	FdoBooleanValue (bool value)
	Constructs a default instance of an FdoBooleanValue using the specified arguments.
	FdoBooleanValue ()
	DOXYGEN-IGNORE Constructs a default instance of an FdoBooleanValue with a value of null.
virtual	~FdoBooleanValue ()
	Default destructor for FdoBooleanValue.
Protected Attributes
bool	m_data

---

Constructor & Destructor Documentation

FdoBooleanValue::FdoBooleanValue (   )  [protected]

DOXYGEN-IGNORE Constructs a default instance of an FdoBooleanValue with a value of null. Returns: Returns nothing

FdoBooleanValue::FdoBooleanValue (  bool  value  )  [protected]

Constructs a default instance of an FdoBooleanValue using the specified arguments. Parameters: value  Input a Boolean value Returns: Returns nothing

virtual FdoBooleanValue::~FdoBooleanValue (   )  [protected, virtual]

Default destructor for FdoBooleanValue. Returns: Returns nothing

---

Member Function Documentation

FDO_API FdoBooleanValue* FdoBooleanValue::Create (  bool  value  )  [static]

Constructs a default instance of an FdoBooleanValue using the specified arguments. Parameters: value  Input a Boolean value Returns: Returns the created FdoBooleanValue Reimplemented from FdoDataValue.

FDO_API FdoBooleanValue* FdoBooleanValue::Create (   )  [static]

Constructs a default instance of an FdoBooleanValue with a value of null. Returns: Returns the created FdoBooleanValue

virtual void FdoBooleanValue::Dispose (   )  [protected, virtual]

Dispose this object. Returns: Returns nothing Implements FdoIDisposable.

FDO_API bool FdoBooleanValue::GetBoolean (   )

Gets the FdoBooleanValue. Returns: Returns a Boolean value

FDO_API FdoDataType FdoBooleanValue::GetDataType (   )  [virtual]

Gets the data type of the FdoBooleanValue. Returns: Returns an FdoDataType Implements FdoDataValue.

FDO_API FdoBooleanValue::operator bool (   )  [inline]

A cast operator to get the Boolean value. Returns: Returns a Boolean value Definition at line 142 of file BooleanValue.h. References FDO_API.

FDO_API void FdoBooleanValue::Process (  FdoIExpressionProcessor *  p  )  [virtual]

Overrides FdoExpression.Process to pass the FdoBooleanValue to the appropriate expression processor operation. Parameters: p  Input the FdoIExpressionProcessor Returns: Returns nothing Implements FdoExpression.

FDO_API void FdoBooleanValue::SetBoolean (  bool  value  )

Sets the Boolean value. Parameters: value  Input a Boolean value Returns: Returns nothing

FDO_API FdoString* FdoBooleanValue::ToString (   )  [virtual]

Returns the well defined text representation of this expression. Returns: Returns a character string. Implements FdoExpression.

---

Member Data Documentation

bool FdoBooleanValue::m_data [protected]

Definition at line 148 of file BooleanValue.h.

---

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

• BooleanValue.h

---

Comments or suggestions? Send us feedback.