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

FdoGeometricPropertyDefinition Class Reference

#include <GeometricPropertyDefinition.h>

Inherits FdoPropertyDefinition.

Inherited by FdoTopoGeometryPropertyDefinition.

Inheritance diagram for FdoGeometricPropertyDefinition:

[legend]
List of all members.

Detailed Description

FdoGeometricPropertyDefinition derives from FdoPropertyDefinition and represents a geometric value. Geometric properties can take on any of the geometric types listed in the FdoGeometricType enumeration.

Note:
Geometric properties do not actually store the coordinate system or measure units, this is to enable the use of the same schema in different geometric locals. FdoGeometricType informs the client application what types of geometric primitives it can expect when reading a particular geometric property (and what types they can store in the property on insert/update). The client application can interpret the actual geometry values as it wants, e.g., displaying and manipulating the vertices of a Polyline as a group of independent points.

Definition at line 46 of file GeometricPropertyDefinition.h.


Public Member Functions

virtual void _writeXml (FdoSchemaXmlContext *pContext)
 Serialize this property to XML.
bool GetAllDefaults ()
 Returns true if none of this property's setters have been called.
FDO_API FdoInt32 GetGeometryTypes ()
 Gets the FdoGeometricTypes that can be stored in this geometric property. The returned value may be any combination of the values from the FdoGeometricType enumeration combined via a bit-wise or operation.
FDO_API bool GetHasElevation ()
 Gets a Boolean value that indicates if the geometry of this property include elevation values.
FDO_API bool GetHasMeasure ()
 Gets a Boolean value that indicates if the geometry of this property includes measurement values that can be used for dynamic segmentation.
virtual FDO_API FdoPropertyType GetPropertyType ()
 Gets the concrete property type.
FDO_API bool GetReadOnly ()
 Returns a Boolean value that indicates if this geometric property is read-only.
FDO_API FdoStringGetSpatialContextAssociation ()
 Gets the Spatial Context name associated to this geometric property.
FDO_API FdoInt32 GetSpecificGeometryTypes ()
 DOXYGEN-IGNORE
FDO_API FdoGeometryTypeGetSpecificGeometryTypes (FdoInt32 &length)
 Gets the specific geometry types that can be stored in this geometric property. The returned value is a list of geometry types that are supported, with length being the number of types returned.
virtual void InitFromXml (FdoString *propertyTypeName, FdoSchemaXmlContext *pContext, FdoXmlAttributeCollection *attrs)
 Initialize this property from its XML attributes.
virtual void Set (FdoPropertyDefinition *pProperty, FdoSchemaMergeContext *pContext)
 DOXYGEN-IGNORE Public non-API functions for XML and Schema Merge support Update this property from the given property.
FDO_API void SetGeometryTypes (FdoInt32 value)
 Sets the FdoGeometricTypes that can be stored in this geometric property. The value may be any combination of the values from the FdoGeometricType enumeration combined via a bit-wise or operation.
FDO_API void SetHasElevation (bool value)
 Sets a Boolean value that determines if the geometry of this property includes elevation values.
FDO_API void SetHasMeasure (bool value)
 Sets a Boolean value that determines if the geometry of this property includes measurement values that can be used for dynamic segmentation.
FDO_API void SetReadOnly (bool value)
 Sets a Boolean value that specifies whether this geometric property is read-only.
FDO_API void SetSpatialContextAssociation (FdoString *value)
 Sets/add a Spatial Context association to this geometric property.
FDO_API void SetSpecificGeometryTypes (FdoGeometryType *types, FdoInt32 length)
 Sets the specific set of geometry types that can be stored in this geometric property. The provided value is a list of geometry types that are supported. Usually, one specific type is supported, but there can be more than one.
virtual FdoBoolean XmlEndElement (FdoXmlSaxContext *context, FdoString *uri, FdoString *name, FdoString *qname)
 Element end.
virtual FdoXmlSaxHandlerXmlStartElement (FdoXmlSaxContext *context, FdoString *uri, FdoString *name, FdoString *qname, FdoXmlAttributeCollection *atts)

Static Public Member Functions

FDO_API FdoGeometricPropertyDefinitionCreate (FdoString *name, FdoString *description, bool system=false)
 Constructs an instance of an FdoGeometricPropertyDefinition using the specified arguments.
FDO_API FdoGeometricPropertyDefinitionCreate ()
 Constructs a default instance of an FdoGeometricPropertyDefinition.

Protected Member Functions

virtual void _AcceptChanges ()
virtual void _RejectChanges ()
virtual void _StartChanges ()
 FdoFeatureSchema::RejectChanges() support.
virtual void Dispose ()
 Dispose this object.
 FdoGeometricPropertyDefinition (FdoString *name, FdoString *description, bool system=false)
 FdoGeometricPropertyDefinition ()
 Constructs a default instance of an FdoGeometricPropertyDefinition.
virtual ~FdoGeometricPropertyDefinition ()

Protected Attributes

FdoStringP m_associatedSCNameCHANGED
FdoInt32 m_geometricTypesCHANGED
FdoInt32 m_geometryTypesCHANGED
bool m_hasElevationCHANGED
bool m_hasMeasureCHANGED
bool m_readOnlyCHANGED

Friends

class FdoFeatureClass

Constructor & Destructor Documentation

FdoGeometricPropertyDefinition::FdoGeometricPropertyDefinition  )  [protected]
 

Constructs a default instance of an FdoGeometricPropertyDefinition.

FdoGeometricPropertyDefinition::FdoGeometricPropertyDefinition FdoString name,
FdoString description,
bool  system = false
[protected]
 

Constructs an instance of an FdoGeometricPropertyDefinition using the specified arguments.

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


Member Function Documentation

virtual void FdoGeometricPropertyDefinition::_AcceptChanges  )  [protected, virtual]
 

Reimplemented from FdoSchemaElement.

Reimplemented in FdoTopoGeometryPropertyDefinition.

virtual void FdoGeometricPropertyDefinition::_RejectChanges  )  [protected, virtual]
 

Reimplemented from FdoSchemaElement.

Reimplemented in FdoTopoGeometryPropertyDefinition.

virtual void FdoGeometricPropertyDefinition::_StartChanges  )  [protected, virtual]
 

FdoFeatureSchema::RejectChanges() support.

Reimplemented from FdoSchemaElement.

Reimplemented in FdoTopoGeometryPropertyDefinition.

virtual void FdoGeometricPropertyDefinition::_writeXml FdoSchemaXmlContext *  pContext  )  [virtual]
 

Serialize this property to XML.

Reimplemented from FdoPropertyDefinition.

Reimplemented in FdoTopoGeometryPropertyDefinition.

FDO_API FdoGeometricPropertyDefinition* FdoGeometricPropertyDefinition::Create FdoString name,
FdoString description,
bool  system = false
[static]
 

Constructs an instance of an FdoGeometricPropertyDefinition using the specified arguments.

Parameters:
name Input name
description Input description
system Input true if this is a system generated property, false otherwise.
Note:
A client would never set system to true, only a provider.
Returns:
Returns FdoGeometricPropertyDefinition

FDO_API FdoGeometricPropertyDefinition* FdoGeometricPropertyDefinition::Create  )  [static]
 

Constructs a default instance of an FdoGeometricPropertyDefinition.

Returns:
Returns FdoGeometricPropertyDefinition

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

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

Reimplemented in FdoTopoGeometryPropertyDefinition.

bool FdoGeometricPropertyDefinition::GetAllDefaults  ) 
 

Returns true if none of this property's setters have been called.

FDO_API FdoInt32 FdoGeometricPropertyDefinition::GetGeometryTypes  ) 
 

Gets the FdoGeometricTypes that can be stored in this geometric property. The returned value may be any combination of the values from the FdoGeometricType enumeration combined via a bit-wise or operation.

Returns:
Returns the FdoGeometricTypes that can be stored in this geometric property

FDO_API bool FdoGeometricPropertyDefinition::GetHasElevation  ) 
 

Gets a Boolean value that indicates if the geometry of this property include elevation values.

Returns:
Returns a Boolean value that determines if the geometry of this property includes elevation values

FDO_API bool FdoGeometricPropertyDefinition::GetHasMeasure  ) 
 

Gets a Boolean value that indicates if the geometry of this property includes measurement values that can be used for dynamic segmentation.

Returns:
Returns a Boolean value that indicates if the geometry of this property includes measurement values

virtual FDO_API FdoPropertyType FdoGeometricPropertyDefinition::GetPropertyType  )  [virtual]
 

Gets the concrete property type.

Returns:
Returns the concrete property type

Implements FdoPropertyDefinition.

FDO_API bool FdoGeometricPropertyDefinition::GetReadOnly  ) 
 

Returns a Boolean value that indicates if this geometric property is read-only.

Returns:
Returns a Boolean value that specifies whether this geometric property is read-only

FDO_API FdoString* FdoGeometricPropertyDefinition::GetSpatialContextAssociation  ) 
 

Gets the Spatial Context name associated to this geometric property.

Returns:
Returns a String value representing the Spatial Context name. If NULL then the geometric property is associated with all the Spatial Contexts in the datastore (supports multiple geometric representations via this property).

FDO_API FdoInt32 FdoGeometricPropertyDefinition::GetSpecificGeometryTypes  ) 
 

DOXYGEN-IGNORE

FDO_API FdoGeometryType* FdoGeometricPropertyDefinition::GetSpecificGeometryTypes FdoInt32 length  ) 
 

Gets the specific geometry types that can be stored in this geometric property. The returned value is a list of geometry types that are supported, with length being the number of types returned.

Parameters:
length The parameter is used to return the number of geometry types being returned by the function.
Returns:
Returns a list of geometry types that are supported.

virtual void FdoGeometricPropertyDefinition::InitFromXml FdoString propertyTypeName,
FdoSchemaXmlContext *  pContext,
FdoXmlAttributeCollection attrs
[virtual]
 

Initialize this property from its XML attributes.

Reimplemented from FdoPropertyDefinition.

Reimplemented in FdoTopoGeometryPropertyDefinition.

virtual void FdoGeometricPropertyDefinition::Set FdoPropertyDefinition pProperty,
FdoSchemaMergeContext pContext
[virtual]
 

DOXYGEN-IGNORE Public non-API functions for XML and Schema Merge support Update this property from the given property.

Reimplemented from FdoPropertyDefinition.

FDO_API void FdoGeometricPropertyDefinition::SetGeometryTypes FdoInt32  value  ) 
 

Sets the FdoGeometricTypes that can be stored in this geometric property. The value may be any combination of the values from the FdoGeometricType enumeration combined via a bit-wise or operation.

Parameters:
value Input the FdoGeometricTypes that can be stored in this geometric property
Returns:
Returns nothing

FDO_API void FdoGeometricPropertyDefinition::SetHasElevation bool  value  ) 
 

Sets a Boolean value that determines if the geometry of this property includes elevation values.

Parameters:
value Input a Boolean value that determines if the geometry of this property includes elevation values
Returns:
Returns nothing

FDO_API void FdoGeometricPropertyDefinition::SetHasMeasure bool  value  ) 
 

Sets a Boolean value that determines if the geometry of this property includes measurement values that can be used for dynamic segmentation.

Parameters:
value Input a Boolean value that determines if the geometry of this property includes measurement values
Returns:
Returns nothing

FDO_API void FdoGeometricPropertyDefinition::SetReadOnly bool  value  ) 
 

Sets a Boolean value that specifies whether this geometric property is read-only.

Parameters:
value Input a Boolean value that specifies whether this geometric property is read-only
Returns:
Returns nothing

FDO_API void FdoGeometricPropertyDefinition::SetSpatialContextAssociation FdoString value  ) 
 

Sets/add a Spatial Context association to this geometric property.

Parameters:
value Input the Spatial Context name to be added/set. Defaults to the active Spatial Context.
Returns:
Returns nothing

FDO_API void FdoGeometricPropertyDefinition::SetSpecificGeometryTypes FdoGeometryType types,
FdoInt32  length
 

Sets the specific set of geometry types that can be stored in this geometric property. The provided value is a list of geometry types that are supported. Usually, one specific type is supported, but there can be more than one.

Parameters:
types The specific set of geometry types that can be stored in this geometric property.
length Indicates the number of geometry types being stored in the provided set of geometry types.
Returns:
Returns nothing.

virtual FdoBoolean FdoGeometricPropertyDefinition::XmlEndElement FdoXmlSaxContext context,
FdoString uri,
FdoString name,
FdoString qname
[virtual]
 

Element end.

Reimplemented from FdoSchemaElement.

Reimplemented in FdoTopoGeometryPropertyDefinition.

virtual FdoXmlSaxHandler* FdoGeometricPropertyDefinition::XmlStartElement FdoXmlSaxContext context,
FdoString uri,
FdoString name,
FdoString qname,
FdoXmlAttributeCollection atts
[virtual]
 

read the geometric types from XML sub-elements. Element start

Reimplemented from FdoSchemaElement.

Reimplemented in FdoTopoGeometryPropertyDefinition.


Friends And Related Function Documentation

friend class FdoFeatureClass [friend]
 

Definition at line 48 of file GeometricPropertyDefinition.h.


Member Data Documentation

FdoStringP FdoGeometricPropertyDefinition::m_associatedSCNameCHANGED [protected]
 

Definition at line 324 of file GeometricPropertyDefinition.h.

FdoInt32 FdoGeometricPropertyDefinition::m_geometricTypesCHANGED [protected]
 

Definition at line 320 of file GeometricPropertyDefinition.h.

FdoInt32 FdoGeometricPropertyDefinition::m_geometryTypesCHANGED [protected]
 

Definition at line 319 of file GeometricPropertyDefinition.h.

bool FdoGeometricPropertyDefinition::m_hasElevationCHANGED [protected]
 

Definition at line 322 of file GeometricPropertyDefinition.h.

bool FdoGeometricPropertyDefinition::m_hasMeasureCHANGED [protected]
 

Definition at line 323 of file GeometricPropertyDefinition.h.

bool FdoGeometricPropertyDefinition::m_readOnlyCHANGED [protected]
 

Definition at line 321 of file GeometricPropertyDefinition.h.


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