FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoDoubleValue Class Reference

#include <DoubleValue.h>

Inherits FdoDataValue.

Inheritance diagram for FdoDoubleValue:

[legend]
List of all members.

Detailed Description

The FdoDoubleValue class derives from FdoDataValue and represents a double-precision floating point number.

Definition at line 32 of file DoubleValue.h.


Public Member Functions

FDO_API FdoDataType GetDataType ()
 Gets the data type of the FdoDoubleValue.
FDO_API double GetDouble ()
 Gets the double value.
FDO_API operator double ()
 A cast operator to get the double value.
FDO_API void Process (FdoIExpressionProcessor *p)
 Overrides FdoExpression.Process to pass the FdoDoubleValue to the appropriate expression processor operation.
FDO_API void SetDouble (double value)
 Sets the double value as a double precision floating point number.
FDO_API FdoStringToString ()
 Returns the well defined text representation of this expression.

Static Public Member Functions

FDO_API FdoDoubleValueCreate (double value)
 Constructs a default instance of an FdoDoubleValue using the specified arguments.
FDO_API FdoDoubleValueCreate ()
 Constructs a default instance of an FdoDoubleValue 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.
 FdoDoubleValue (double value)
 Constructs a default instance of an FdoDoubleValue using the specified arguments.
 FdoDoubleValue ()
 Constructs a default instance of an FdoDoubleValue with a value of null.
virtual ~FdoDoubleValue ()
 Default destructor for FdoDoubleValue.

Static Protected Member Functions

FdoDoubleValueCreate (FdoDataValue *src, FdoBoolean truncate=false, FdoBoolean nullIfIncompatible=false)
 DOXYGEN-IGNORE Constructs an instance of an FdoDoubleValue from another FdoDataValue.

Protected Attributes

double m_data

Friends

class FdoByteValue
 DOXYGEN-IGNORE
class FdoInt16Value
class FdoInt32Value
class FdoInt64Value
class FdoSingleValue

Constructor & Destructor Documentation

FdoDoubleValue::FdoDoubleValue  )  [protected]
 

Constructs a default instance of an FdoDoubleValue with a value of null.

Returns:
Returns nothing

FdoDoubleValue::FdoDoubleValue double  value  )  [protected]
 

Constructs a default instance of an FdoDoubleValue using the specified arguments.

Parameters:
value Input a double
Returns:
Returns nothing

virtual FdoDoubleValue::~FdoDoubleValue  )  [protected, virtual]
 

Default destructor for FdoDoubleValue.

Returns:
Returns nothing

Member Function Documentation

FdoDoubleValue* FdoDoubleValue::Create FdoDataValue src,
FdoBoolean  truncate = false,
FdoBoolean  nullIfIncompatible = false
[static, protected]
 

DOXYGEN-IGNORE Constructs an instance of an FdoDoubleValue from another FdoDataValue.

Parameters:
src Input the other FdoDataValue. Must be of one of the following types: FdoDataType_Byte FdoDataType_Decimal FdoDataType_Double 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 double type: true - return NULL. false - throw an exception
Returns:
Returns an FdoDoubleValue

FDO_API FdoDoubleValue* FdoDoubleValue::Create double  value  )  [static]
 

Constructs a default instance of an FdoDoubleValue using the specified arguments.

Parameters:
value Input a double
Returns:
Returns the created FdoDoubleValue

FDO_API FdoDoubleValue* FdoDoubleValue::Create  )  [static]
 

Constructs a default instance of an FdoDoubleValue with a value of null.

Returns:
Returns the created FdoDoubleValue

virtual void FdoDoubleValue::Dispose  )  [protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

virtual FdoCompareType FdoDoubleValue::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 FdoDoubleValue::GetDataType  )  [virtual]
 

Gets the data type of the FdoDoubleValue.

Returns:
Returns an FdoDataType

Implements FdoDataValue.

FDO_API double FdoDoubleValue::GetDouble  ) 
 

Gets the double value.

Returns:
Returns a double

FDO_API FdoDoubleValue::operator double  )  [inline]
 

A cast operator to get the double value.

Returns:
Returns a double

Definition at line 147 of file DoubleValue.h.

References FDO_API.

FDO_API void FdoDoubleValue::Process FdoIExpressionProcessor p  )  [virtual]
 

Overrides FdoExpression.Process to pass the FdoDoubleValue to the appropriate expression processor operation.

Parameters:
p Input an FdoIExpressionProcessor
Returns:
Returns nothing

Implements FdoExpression.

FDO_API void FdoDoubleValue::SetDouble double  value  ) 
 

Sets the double value as a double precision floating point number.

Parameters:
value Input a double
Returns:
Returns nothing

FDO_API FdoString* FdoDoubleValue::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 DoubleValue.h.

friend class FdoInt16Value [friend]
 

Reimplemented from FdoDataValue.

Definition at line 36 of file DoubleValue.h.

friend class FdoInt32Value [friend]
 

Reimplemented from FdoDataValue.

Definition at line 37 of file DoubleValue.h.

friend class FdoInt64Value [friend]
 

Reimplemented from FdoDataValue.

Definition at line 38 of file DoubleValue.h.

friend class FdoSingleValue [friend]
 

Reimplemented from FdoDataValue.

Definition at line 39 of file DoubleValue.h.


Member Data Documentation

double FdoDoubleValue::m_data [protected]
 

Definition at line 189 of file DoubleValue.h.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.