FDO API Reference

Feature Data Objects

FdoGeometryValue Class Reference

#include <GeometryValue.h>

Inherits FdoLiteralValue.

Inheritance diagram for FdoGeometryValue:

[legend]List of all members.

---

Detailed Description

The FdoGeometryValue class derives from FdoLiteralValue and represents a geometric value.

Definition at line 31 of file GeometryValue.h.

Public Member Functions
FDO_API FdoByteArray *	GetGeometry ()
	Gets the geometry as a byte array. The geometry is expected to be encoded in Autodesk Well-Known Binary format.
virtual FDO_API FdoLiteralValueType	GetLiteralValueType () const
	Gets the literal value type of the FdoGeometryValue.
FDO_API bool	IsNull ()
	Returns true if the FdoGeometryValue represents a null value.
FDO_API void	Process (FdoIExpressionProcessor *p)
	Overrides FdoExpression.Process to pass the FdoGeometryValue to the appropriate expression processor operation.
FDO_API void	SetGeometry (FdoByteArray *value)
	Sets the geometry as a byte array. The geometry is expected to be encoded in Autodesk Well-Known Binary format.
FDO_API void	SetNullValue ()
	Sets the FdoGeometryValue to a null value.
FDO_API FdoString *	ToString ()
	Returns the well defined text representation of this expression.
Static Public Member Functions
FDO_API FdoGeometryValue *	Create (FdoByteArray *geometry)
	Constructs an instance of an FdoGeometryValue using the specified arguments.
FDO_API FdoGeometryValue *	Create ()
	Constructs a default instance of an FdoGeometryValue with a value of null.
Protected Member Functions
virtual void	Dispose ()
	Dispose this object.
	FdoGeometryValue (FdoByteArray *geometry)
	Constructs an instance of an FdoGeometryValue using the specified arguments.
	FdoGeometryValue ()
	Constructs a default instance of an FdoGeometryValue with a value of null.
virtual	~FdoGeometryValue ()
	Default destructor for GeometryValue.
Protected Attributes
FdoByteArray *	m_geometry
	DOXYGEN-IGNORE

---

Constructor & Destructor Documentation

FdoGeometryValue::FdoGeometryValue (   )  [protected]

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

FdoGeometryValue::FdoGeometryValue (  FdoByteArray *  geometry  )  [protected]

Constructs an instance of an FdoGeometryValue using the specified arguments.

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

Default destructor for GeometryValue.

---

Member Function Documentation

FDO_API FdoGeometryValue* FdoGeometryValue::Create (  FdoByteArray *  geometry  )  [static]

Constructs an instance of an FdoGeometryValue using the specified arguments. Parameters: geometry  Input geometry byte array Returns: Returns FdoGeometryValue

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

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

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

Dispose this object. Returns: Returns nothing Implements FdoIDisposable.

FDO_API FdoByteArray* FdoGeometryValue::GetGeometry (   )

Gets the geometry as a byte array. The geometry is expected to be encoded in Autodesk Well-Known Binary format. Returns: Returns geometry in FGF format

virtual FDO_API FdoLiteralValueType FdoGeometryValue::GetLiteralValueType (   )  const [virtual]

Gets the literal value type of the FdoGeometryValue. Returns: Returns an FdoLiteralValueType Implements FdoLiteralValue.

FDO_API bool FdoGeometryValue::IsNull (   )

Returns true if the FdoGeometryValue represents a null value. Returns: Returns true if null geometry

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

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

FDO_API void FdoGeometryValue::SetGeometry (  FdoByteArray *  value  )

Sets the geometry as a byte array. The geometry is expected to be encoded in Autodesk Well-Known Binary format. Parameters: value  Input geometry in FGF format Returns: Returns nothing

FDO_API void FdoGeometryValue::SetNullValue (   )

Sets the FdoGeometryValue to a null value. Returns: Returns nothing

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

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

---

Member Data Documentation

FdoByteArray* FdoGeometryValue::m_geometry [protected]

DOXYGEN-IGNORE Definition at line 135 of file GeometryValue.h.

---

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

• GeometryValue.h

---

Comments or suggestions? Send us feedback.