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

FdoIRasterPropertyDictionary Class Reference

#include <IRasterPropertyDictionary.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoIRasterPropertyDictionary:

[legend]
List of all members.

Detailed Description

The FdoIRasterPropertyDictionary exposes a dictionary style interface to the raster properties. Through this interface the non-standard properties of a raster image can be determined and their values can be retrieved and set. Data values are exchanged through the FdoDataValue object to accommodate various data types, boolean, integer, double, string etc.

Definition at line 36 of file IRasterPropertyDictionary.h.


Public Member Functions

virtual FDO_API FdoDataValueGetProperty (FdoString *name)=0
 Gets the value of the specified property (or its default).
virtual FDO_API FdoDataType GetPropertyDataType (FdoString *name)=0
 Gets the data type for the specified property.
virtual FDO_API FdoDataValueGetPropertyDefault (FdoString *name)=0
 Gets the default value for the specified property.
virtual FDO_API FdoStringCollectionGetPropertyNames ()=0
 Gets the names of all the properties that apply to this image as a collection of Strings. The order of the property names in the collection dictate the order in which they need to be specified. This is especially important for the success of the EnumeratePropertyValues method as properties that occur earlier in the collection may be required for successful enumeration of properties that appear later in the collection.
virtual FDO_API FdoDataValueCollectionGetPropertyValues (FdoString *name)=0
 Access the values of the specified enumerable property. The property must respond TRUE to IsPropertyEnumerable.
virtual FDO_API bool IsPropertyEnumerable (FdoString *name)=0
 Predicate to determine if the property is enumerable (has more than one value).
virtual FDO_API bool IsPropertyRequired (FdoString *name)=0
 Predicate to determine if the property is required to be set.
virtual FDO_API void SetProperty (FdoString *name, FdoDataValue *value)=0
 Sets the value of the specified property.
virtual FDO_API void SetPropertyValues (FdoString *name, FdoDataValueCollection *collection)=0
 Set the values of the specified enumerable property. The property must respond TRUE to IsPropertyEnumerable. Clients will need to use SetPropertyValues when creating an image with specific values for the enumerable property. An example would be setting a table of wavelength ranges corresponding to the false colour used to encode the image.

Member Function Documentation

virtual FDO_API FdoDataValue* FdoIRasterPropertyDictionary::GetProperty FdoString name  )  [pure virtual]
 

Gets the value of the specified property (or its default).

Parameters:
name The name of the property to get the value of.
Returns:
The value of the property.

virtual FDO_API FdoDataType FdoIRasterPropertyDictionary::GetPropertyDataType FdoString name  )  [pure virtual]
 

Gets the data type for the specified property.

Parameters:
name The name of the property to get the data type of.
Returns:
The data type of the property.

virtual FDO_API FdoDataValue* FdoIRasterPropertyDictionary::GetPropertyDefault FdoString name  )  [pure virtual]
 

Gets the default value for the specified property.

Parameters:
name The name of the property to get the default value of.
Returns:
The default value of the property.

virtual FDO_API FdoStringCollection* FdoIRasterPropertyDictionary::GetPropertyNames  )  [pure virtual]
 

Gets the names of all the properties that apply to this image as a collection of Strings. The order of the property names in the collection dictate the order in which they need to be specified. This is especially important for the success of the EnumeratePropertyValues method as properties that occur earlier in the collection may be required for successful enumeration of properties that appear later in the collection.

Returns:
A collection of the names of properties in this dictionary.

virtual FDO_API FdoDataValueCollection* FdoIRasterPropertyDictionary::GetPropertyValues FdoString name  )  [pure virtual]
 

Access the values of the specified enumerable property. The property must respond TRUE to IsPropertyEnumerable.

Parameters:
name The name of the property to get the collection of values for.
Returns:
A collection of datavaluesfor the enumerable property.

virtual FDO_API bool FdoIRasterPropertyDictionary::IsPropertyEnumerable FdoString name  )  [pure virtual]
 

Predicate to determine if the property is enumerable (has more than one value).

Parameters:
name The name of the property to get the enumerable status of.
Returns:
Returns true if the possible values for the specified property can be enumerated via the GetPropertyValues method.

virtual FDO_API bool FdoIRasterPropertyDictionary::IsPropertyRequired FdoString name  )  [pure virtual]
 

Predicate to determine if the property is required to be set.

Parameters:
name The name of the property to get the required status of.
Returns:
Returns true if the specified property is required, false if it is optional.

virtual FDO_API void FdoIRasterPropertyDictionary::SetProperty FdoString name,
FdoDataValue value
[pure virtual]
 

Sets the value of the specified property.

Parameters:
name The name of the property to set the value of.
value The new value for the property.

virtual FDO_API void FdoIRasterPropertyDictionary::SetPropertyValues FdoString name,
FdoDataValueCollection collection
[pure virtual]
 

Set the values of the specified enumerable property. The property must respond TRUE to IsPropertyEnumerable. Clients will need to use SetPropertyValues when creating an image with specific values for the enumerable property. An example would be setting a table of wavelength ranges corresponding to the false colour used to encode the image.

Parameters:
name The name of the property to set the collection of values for.
collection The collection of values for the enumerable property.

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