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

FdoInt32Value Class Reference

#include <Int32Value.h>

Inherits FdoDataValue.

Inheritance diagram for FdoInt32Value:

[legend]
List of all members.

Detailed Description

The FdoInt32Value class derives from FdoDataValue and represents a 32-bit signed integer value.

Definition at line 32 of file Int32Value.h.


Public Member Functions

FDO_API FdoDataType GetDataType ()
 Gets the data type of the FdoInt32Value.
FDO_API FdoInt32 GetInt32 ()
 Gets the FdoInt32Value.
FDO_API operator FdoInt32 ()
 A cast operator to get the integer value.
FDO_API void Process (FdoIExpressionProcessor *p)
 Overrides FdoExpression.Process to pass the FdoInt32Value to the appropriate expression processor operation.
FDO_API void SetInt32 (FdoInt32 value)
 Sets the FdoInt32Value.
FDO_API FdoStringToString ()
 Returns the well defined text representation of this expression.

Static Public Member Functions

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

Static Protected Member Functions

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

Protected Attributes

FdoInt32 m_data

Friends

class FdoByteValue
 DOXYGEN-IGNORE
class FdoInt16Value

Constructor & Destructor Documentation

FdoInt32Value::FdoInt32Value  )  [protected]
 

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

Returns:
Returns nothing

FdoInt32Value::FdoInt32Value FdoInt32  value  )  [protected]
 

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

Parameters:
value Input a 32 bit integer
Returns:
Returns nothing

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

Default destructor for FdoInt32Value.

Returns:
Returns nothing

Member Function Documentation

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

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

Parameters:
src Input the other FdoDataValue. Must be of one of the following types: FdoDataType_Byte FdoDataType_Int16 FdoDataType_Int32
truncate Input in the future, will determine what to do if source value does not fit in the int32 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 int32 type: true - return NULL. false - throw an exception
Returns:
Returns an FdoInt32Value

FDO_API FdoInt32Value* FdoInt32Value::Create FdoInt32  value  )  [static]
 

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

Parameters:
value Input a 32 bit integer
Returns:
Returns nothing

Reimplemented from FdoDataValue.

FDO_API FdoInt32Value* FdoInt32Value::Create  )  [static]
 

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

Returns:
Returns nothing

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

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

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

Gets the data type of the FdoInt32Value.

Returns:
Returns an FdoDataType

Implements FdoDataValue.

FDO_API FdoInt32 FdoInt32Value::GetInt32  ) 
 

Gets the FdoInt32Value.

Returns:
Returns a 32 bit integer

FDO_API FdoInt32Value::operator FdoInt32  )  [inline]
 

A cast operator to get the integer value.

Returns:
Returns a 32 bit integer

Definition at line 139 of file Int32Value.h.

References FDO_API.

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

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

Parameters:
p Input an FdoIExpressionProcessor
Returns:
Returns nothing

Implements FdoExpression.

FDO_API void FdoInt32Value::SetInt32 FdoInt32  value  ) 
 

Sets the FdoInt32Value.

Parameters:
value Input a 32 bit integer
Returns:
Returns nothing

FDO_API FdoString* FdoInt32Value::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 Int32Value.h.

friend class FdoInt16Value [friend]
 

Reimplemented from FdoDataValue.

Definition at line 36 of file Int32Value.h.


Member Data Documentation

FdoInt32 FdoInt32Value::m_data [protected]
 

Definition at line 177 of file Int32Value.h.


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