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

FdoRasterPropertyDefinition Class Reference

#include <RasterPropertyDefinition.h>

Inherits FdoPropertyDefinition.

Inheritance diagram for FdoRasterPropertyDefinition:

[legend]
List of all members.

Detailed Description

The FdoRasterPropertyDefinition has the information needed to create or completely describe a raster property. This class encapsulates the information necessary to insert a 'new' raster, in the absence of any other information, for the properties defined using this schema element.

Definition at line 36 of file RasterPropertyDefinition.h.


Public Member Functions

virtual void _writeXml (FdoSchemaXmlContext *pContext)
 Serialize this property to XML.
virtual FDO_API FdoRasterDataModel * GetDefaultDataModel ()
 Gets the default data model used by this raster property.
virtual FDO_API FdoInt32 GetDefaultImageXSize ()
 Gets the default size of image file in the horizontal direction in pixels (number of columns).
virtual FDO_API FdoInt32 GetDefaultImageYSize ()
 Gets the default size of an image file in the vertical direction in pixels (number of rows).
virtual FDO_API bool GetNullable ()
 Returns a Boolean value that indicates if this property's value can be null.
virtual FDO_API FdoPropertyType GetPropertyType ()
 FdoPropertyDefinition interface Gets the concrete property type.
virtual FDO_API bool GetReadOnly ()
 Attributes. Returns a Boolean value that indicates if this property is read-only.
FDO_API FdoString * GetSpatialContextAssociation ()
 Gets the Spatial Context name associated to this raster property.
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.
virtual FDO_API void SetDefaultDataModel (FdoRasterDataModel *datamodel)
 Sets the default data model used by this raster property. Allowed values are only those data models that are acceptable to the SupportsDataModel capability.
virtual FDO_API void SetDefaultImageXSize (FdoInt32 size)
 Sets the default size of an image file in the horizontal direction in pixels (number of columns).
virtual FDO_API void SetDefaultImageYSize (FdoInt32 size)
 Sets the default size of an image file in the vertical direction in pixels (number of rows).
virtual FDO_API void SetNullable (bool value)
 Sets a Boolean value that indicates if this property's value can be null.
virtual FDO_API void SetReadOnly (bool value)
 Sets a Boolean value that indicates if this property is read-only.
FDO_API void SetSpatialContextAssociation (FdoString *spatialContextName)
 Spatial Context Support. Sets a Spatial Context association for this raster property.

Static Public Member Functions

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

Protected Member Functions

virtual void _AcceptChanges ()
virtual void _RejectChanges ()
virtual void _StartChanges ()
 FdoSchemaElement interface.
virtual void Dispose ()
 FdoIDisposable interface Dispose this object.
 FdoRasterPropertyDefinition (FdoString *name, FdoString *description, bool system=false)
 FdoRasterPropertyDefinition ()
 Constructs a default instance of an FdoRasterPropertyDefinition.
virtual ~FdoRasterPropertyDefinition ()
 Destructor.

Protected Attributes

FdoRasterDataModel * m_modelCHANGED
bool m_nullableCHANGED
bool m_readOnlyCHANGED
FdoStringP m_scAssociationCHANGED
FdoInt32 m_sizeXCHANGED
FdoInt32 m_sizeYCHANGED

Friends

class FdoFeatureClass

Constructor & Destructor Documentation

FdoRasterPropertyDefinition::FdoRasterPropertyDefinition (   )  [protected]
 

Constructs a default instance of an FdoRasterPropertyDefinition.

FdoRasterPropertyDefinition::FdoRasterPropertyDefinition (  FdoString *  name,
FdoString *  description,
bool  system = false
)  [protected]
 

Constructs an instance of an FdoRasterPropertyDefinition using the specified arguments.

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

Destructor.

Member Function Documentation

virtual void FdoRasterPropertyDefinition::_AcceptChanges (   )  [protected, virtual]
 

Reimplemented from FdoSchemaElement.

virtual void FdoRasterPropertyDefinition::_RejectChanges (   )  [protected, virtual]
 

Reimplemented from FdoSchemaElement.

virtual void FdoRasterPropertyDefinition::_StartChanges (   )  [protected, virtual]
 

FdoSchemaElement interface.

Reimplemented from FdoSchemaElement.

virtual void FdoRasterPropertyDefinition::_writeXml (  FdoSchemaXmlContext *  pContext  )  [virtual]
 

Serialize this property to XML.

Reimplemented from FdoPropertyDefinition.

FDO_API FdoRasterPropertyDefinition* FdoRasterPropertyDefinition::Create (  FdoString *  name,
FdoString *  description,
bool  system = false
)  [static]
 

Constructs an instance of an FdoRasterPropertyDefinition 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 FdoRasterPropertyDefinition

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

Constructs a default instance of an FdoRasterPropertyDefinition.

Returns:
Returns FdoRasterPropertyDefinition

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

FdoIDisposable interface Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

virtual FDO_API FdoRasterDataModel* FdoRasterPropertyDefinition::GetDefaultDataModel (   )  [virtual]
 

Gets the default data model used by this raster property.

Returns:
Returns the current default data model.

virtual FDO_API FdoInt32 FdoRasterPropertyDefinition::GetDefaultImageXSize (   )  [virtual]
 

Gets the default size of image file in the horizontal direction in pixels (number of columns).

Returns:
Returns the current default horizontal image size in pixels (number of columns).

virtual FDO_API FdoInt32 FdoRasterPropertyDefinition::GetDefaultImageYSize (   )  [virtual]
 

Gets the default size of an image file in the vertical direction in pixels (number of rows).

Returns:
Returns the current default vertical image size in pixels (number of rows).

virtual FDO_API bool FdoRasterPropertyDefinition::GetNullable (   )  [virtual]
 

Returns a Boolean value that indicates if this property's value can be null.

Returns:
Returns a Boolean value

virtual FDO_API FdoPropertyType FdoRasterPropertyDefinition::GetPropertyType (   )  [virtual]
 

FdoPropertyDefinition interface Gets the concrete property type.

Returns:
Returns the concrete property type

Implements FdoPropertyDefinition.

virtual FDO_API bool FdoRasterPropertyDefinition::GetReadOnly (   )  [virtual]
 

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

Returns:
Returns a Boolean value

FDO_API FdoString* FdoRasterPropertyDefinition::GetSpatialContextAssociation (   ) 
 

Gets the Spatial Context name associated to this raster property.

Returns:
Returns a String value representing the Spatial Context name.

virtual void FdoRasterPropertyDefinition::InitFromXml (  FdoString *  propertyTypeName,
FdoSchemaXmlContext *  pContext,
FdoXmlAttributeCollection *  attrs
)  [virtual]
 

Initialize this property from its XML attributes.

Reimplemented from FdoPropertyDefinition.

virtual void FdoRasterPropertyDefinition::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.

virtual FDO_API void FdoRasterPropertyDefinition::SetDefaultDataModel (  FdoRasterDataModel *  datamodel  )  [virtual]
 

Sets the default data model used by this raster property. Allowed values are only those data models that are acceptable to the SupportsDataModel capability.

Parameters:
datamodel The datamodel to be used for newly created rasters, or the default datamodel to be used when returning raster data.

virtual FDO_API void FdoRasterPropertyDefinition::SetDefaultImageXSize (  FdoInt32  size  )  [virtual]
 

Sets the default size of an image file in the horizontal direction in pixels (number of columns).

Parameters:
size The desired default horizontal image size in pixels (number of columns).

virtual FDO_API void FdoRasterPropertyDefinition::SetDefaultImageYSize (  FdoInt32  size  )  [virtual]
 

Sets the default size of an image file in the vertical direction in pixels (number of rows).

Parameters:
size The desired default vertical image size in pixels (number of rows).

virtual FDO_API void FdoRasterPropertyDefinition::SetNullable (  bool  value  )  [virtual]
 

Sets a Boolean value that indicates if this property's value can be null.

Parameters:
value Input a Boolean value that indicates if this property's value can be null
Returns:
Returns nothing

virtual FDO_API void FdoRasterPropertyDefinition::SetReadOnly (  bool  value  )  [virtual]
 

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

Parameters:
value Input a Boolean value that indicates if this property is read-only
Returns:
Returns nothing

FDO_API void FdoRasterPropertyDefinition::SetSpatialContextAssociation (  FdoString *  spatialContextName  ) 
 

Spatial Context Support. Sets a Spatial Context association for this raster property.

Parameters:
spatialContextName Input the Spatial Context name to be set. Defaults to the active Spatial Context.
Returns:
Returns nothing

Friends And Related Function Documentation

friend class FdoFeatureClass [friend]
 

Definition at line 40 of file RasterPropertyDefinition.h.

Member Data Documentation

FdoRasterDataModel* FdoRasterPropertyDefinition::m_modelCHANGED [protected]
 

Definition at line 277 of file RasterPropertyDefinition.h.

bool FdoRasterPropertyDefinition::m_nullableCHANGED [protected]
 

Definition at line 276 of file RasterPropertyDefinition.h.

bool FdoRasterPropertyDefinition::m_readOnlyCHANGED [protected]
 

Definition at line 275 of file RasterPropertyDefinition.h.

FdoStringP FdoRasterPropertyDefinition::m_scAssociationCHANGED [protected]
 

Definition at line 280 of file RasterPropertyDefinition.h.

FdoInt32 FdoRasterPropertyDefinition::m_sizeXCHANGED [protected]
 

Definition at line 278 of file RasterPropertyDefinition.h.

FdoInt32 FdoRasterPropertyDefinition::m_sizeYCHANGED [protected]
 

Definition at line 279 of file RasterPropertyDefinition.h.

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