FDO API Reference

Feature Data Objects

FdoInt16Value Class Reference

#include <Int16Value.h>

Inherits FdoDataValue.

Inheritance diagram for FdoInt16Value:

[legend]List of all members.

---

Detailed Description

The FdoInt16Value class derives from FdoDataValue and represents a 16-bit signed integer value.

Definition at line 32 of file Int16Value.h.

Public Member Functions
FDO_API FdoDataType	GetDataType ()
	Gets the data type of the FdoInt16Value.
FDO_API FdoInt16	GetInt16 ()
	Gets the FdoInt16Value.
FDO_API	operator FdoInt16 ()
	A cast operator to get the integer value.
FDO_API void	Process (FdoIExpressionProcessor *p)
	Overrides FdoExpression.Process to pass the FdoInt16Value to the appropriate expression processor operation.
FDO_API void	SetInt16 (FdoInt16 value)
	Sets the FdoInt16Value.
FDO_API FdoString *	ToString ()
	Returns the well defined text representation of this expression.
Static Public Member Functions
FDO_API FdoInt16Value *	Create (FdoInt16 value)
	Constructs a default instance of an FdoInt16Value using the specified arguments.
FDO_API FdoInt16Value *	Create ()
	Constructs a default instance of an FdoInt16Value 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.
	FdoInt16Value (FdoInt16 value)
	Constructs a default instance of an FdoInt16Value using the specified arguaments.
	FdoInt16Value ()
	Constructs a default instance of an FdoInt16Value with a value of null.
virtual	~FdoInt16Value ()
	Default destructor for FdoInt16Value.
Static Protected Member Functions
FdoInt16Value *	Create (FdoDataValue *src, FdoBoolean truncate=false, FdoBoolean nullIfIncompatible=false)
	DOXYGEN-IGNORE Constructs an instance of an FdoInt16Value from another FdoDataValue.
Protected Attributes
FdoInt16	m_data
Friends
class	FdoByteValue
	DOXYGEN-IGNORE

---

Constructor & Destructor Documentation

FdoInt16Value::FdoInt16Value (   )  [protected]

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

FdoInt16Value::FdoInt16Value (  FdoInt16  value  )  [protected]

Constructs a default instance of an FdoInt16Value using the specified arguaments. Parameters: value  Input a 16 bit integer Returns: Returns nothing

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

Default destructor for FdoInt16Value. Returns: Returns nothing

---

Member Function Documentation

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

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

FDO_API FdoInt16Value* FdoInt16Value::Create (  FdoInt16  value  )  [static]

Constructs a default instance of an FdoInt16Value using the specified arguments. Parameters: value  Input a 16 bit integer Returns: Returns the created FdoInt16Value Reimplemented from FdoDataValue.

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

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

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

Dispose this object. Returns: Returns nothing Implements FdoIDisposable.

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

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

FDO_API FdoInt16 FdoInt16Value::GetInt16 (   )

Gets the FdoInt16Value. Returns: Returns a 16 bit integer

FDO_API FdoInt16Value::operator FdoInt16 (   )  [inline]

A cast operator to get the integer value. Returns: Returns a 16 bit integer Definition at line 139 of file Int16Value.h. References FDO_API.

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

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

FDO_API void FdoInt16Value::SetInt16 (  FdoInt16  value  )

Sets the FdoInt16Value. Parameters: value  Input a 16 bit integer Returns: Returns nothing

FDO_API FdoString* FdoInt16Value::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 Int16Value.h.

---

Member Data Documentation

FdoInt16 FdoInt16Value::m_data [protected]

Definition at line 176 of file Int16Value.h.

---

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

• Int16Value.h

---

Comments or suggestions? Send us feedback.