FDO API Reference

Feature Data Objects

FdoSingleValue Class Reference

#include <SingleValue.h>

Inherits FdoDataValue.

Inheritance diagram for FdoSingleValue:

[legend]List of all members.

---

Detailed Description

The FdoSingleValue class derives from FdoDataValue and represents a single precision floating point number.

Definition at line 32 of file SingleValue.h.

Public Member Functions
FDO_API FdoDataType	GetDataType ()
	Gets the data type of the FdoSingleValue.
FDO_API float	GetSingle ()
	Gets the FdoSingleValue as a single precision floating point number.
FDO_API	operator float ()
	A cast operator to get the floating point value.
FDO_API void	Process (FdoIExpressionProcessor *p)
	Overrides FdoExpression.Process to pass the FdoSingleValue to the appropriate expression processor operation.
FDO_API void	SetSingle (float value)
	Sets the FdoSingleValue as a single precision floating point number.
FDO_API FdoString *	ToString ()
	Returns the well defined text representation of this expression.
Static Public Member Functions
FDO_API FdoSingleValue *	Create (float value)
	Constructs a default instance of an FdoSingleValue using the specified arguments.
FDO_API FdoSingleValue *	Create ()
	Constructs a default instance of an FdoSingleValue with a value of null.
Protected Member Functions
virtual void	Dispose ()
	Dispose this object.
virtual FdoCompareType	DoCompare (FdoDataValue *other)
	Type-specific comparison function. Each sub-class has its own implementation.
	FdoSingleValue (float value)
	Constructs a default instance of an FdoSingleValue using the specified arguments.
	FdoSingleValue ()
	Constructs a default instance of an FdoSingleValue with a value of null.
virtual	~FdoSingleValue ()
	Default destructor for FdoSingleValue.
Static Protected Member Functions
FdoSingleValue *	Create (FdoDataValue *src, FdoBoolean truncate=false, FdoBoolean nullIfIncompatible=false)
	DOXYGEN-IGNORE Constructs an instance of an FdoSingleValue from another FdoDataValue.
Protected Attributes
float	m_data
Friends
class	FdoByteValue
	DOXYGEN-IGNORE
class	FdoInt16Value
class	FdoInt32Value
class	FdoInt64Value

---

Constructor & Destructor Documentation

FdoSingleValue::FdoSingleValue (   )  [protected]

Constructs a default instance of an FdoSingleValue with a value of null. Returns: Returns nothing

FdoSingleValue::FdoSingleValue (  float  value  )  [protected]

Constructs a default instance of an FdoSingleValue using the specified arguments. Parameters: value  Input a single precision floating point value Returns: Returns nothing

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

Default destructor for FdoSingleValue.

---

Member Function Documentation

FdoSingleValue* FdoSingleValue::Create (  FdoDataValue *  src, FdoBoolean  truncate = false, FdoBoolean  nullIfIncompatible = false )  [static, protected]

DOXYGEN-IGNORE Constructs an instance of an FdoSingleValue from another FdoDataValue. Parameters: src  Input the other FdoDataValue. Must be of one of the following types: FdoDataType_Byte FdoDataType_Int16 FdoDataType_Int32 FdoDataType_Int64 FdoDataType_Single truncate  Input in the future, will determine what to do if source value does not fit in the double number range: true - truncate the value to fit. false - throw an exception nullIfIncompatible  Input in the future, will determine what to do if source value type is not compatible with the FDO float type: true - return NULL. false - throw an exception Returns: Returns an FdoSingleValue

FDO_API FdoSingleValue* FdoSingleValue::Create (  float  value  )  [static]

Constructs a default instance of an FdoSingleValue using the specified arguments. Parameters: value  Input a single precision floating point value Returns: Returns the created FdoSingleValue Reimplemented from FdoDataValue.

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

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

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

Dispose this object. Returns: Returns nothing Implements FdoIDisposable.

virtual FdoCompareType FdoSingleValue::DoCompare (  FdoDataValue *  other  )  [protected, virtual]

Type-specific comparison function. Each sub-class has its own implementation. Parameters: other  Input the other data value Returns: Returns: FdoCompareType_Equal when this and the other value are equal or both null. FdoCompareType_Greater when this value is greater than the other value FdoCompareType_Less when this value is less than the other value FdoCompareType_Undefined when these two values cannot be compared. Cases where this happens are: one value is null and the other is not null the values have incompatible types (e.g. Int32 and DateTime). Base implementation always returns FdoCompareType_Undefined. Reimplemented from FdoDataValue.

FDO_API FdoDataType FdoSingleValue::GetDataType (   )  [virtual]

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

FDO_API float FdoSingleValue::GetSingle (   )

Gets the FdoSingleValue as a single precision floating point number. Returns: Returns a single precision floating point value

FDO_API FdoSingleValue::operator float (   )  [inline]

A cast operator to get the floating point value. Returns: Returns a single precision floating point value Definition at line 139 of file SingleValue.h. References FDO_API.

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

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

FDO_API void FdoSingleValue::SetSingle (  float  value  )

Sets the FdoSingleValue as a single precision floating point number. Parameters: value  Input a single precision floating point value Returns: Returns nothing

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

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

---

Friends And Related Function Documentation

friend class FdoByteValue [friend]

DOXYGEN-IGNORE Reimplemented from FdoDataValue. Definition at line 35 of file SingleValue.h.

friend class FdoInt16Value [friend]

Reimplemented from FdoDataValue. Definition at line 36 of file SingleValue.h.

friend class FdoInt32Value [friend]

Reimplemented from FdoDataValue. Definition at line 37 of file SingleValue.h.

friend class FdoInt64Value [friend]

Reimplemented from FdoDataValue. Definition at line 38 of file SingleValue.h.

---

Member Data Documentation

float FdoSingleValue::m_data [protected]

Definition at line 179 of file SingleValue.h.

---

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

• SingleValue.h

---

Comments or suggestions? Send us feedback.