FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Raster::IRasterPropertyDictionaryImp Class Reference

Inherits OSGeo::FDO::Runtime::Disposable, and OSGeo::FDO::Raster::OSGeo::FDO::Raster::IRasterPropertyDictionary.

Inheritance diagram for OSGeo::FDO::Raster::IRasterPropertyDictionaryImp:

[legend]
List of all members.

Detailed Description

The IRasterPropertyDictionary 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 DataValue object to accommodate various data types, boolean, integer, double, string etc.


Public Member Functions

__property OSGeo::FDO::Expression::DataValueget_Property (System::String *name)
 Gets the value of the specified property (or its default).
__property OSGeo::FDO::Schema::DataType get_PropertyDataType (System::String *name)
 Gets the data type for the specified property.
__property OSGeo::FDO::Expression::DataValueget_PropertyDefault (System::String *name)
 Gets the default value for the specified property.
__property OSGeo::FDO::Common::StringCollectionget_PropertyNames ()
 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.
__property OSGeo::FDO::Raster::DataValueCollectionget_PropertyValues (System::String *name)
 Access the values of the specified enumerable property. The property must respond TRUE to IsPropertyEnumerable.
 IRasterPropertyDictionaryImp (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs a IRasterPropertyDictionaryImp object based on an unmanaged instance of the object.
System::Boolean IsPropertyEnumerable (System::String *name)
 Predicate to determine if the property is enumerable (has more than one value).
System::Boolean IsPropertyRequired (System::String *name)
 Predicate to determine if the property is required to be set.
__property System::Void set_Property (System::String *name, OSGeo::FDO::Expression::DataValue *value)
 Sets the value of the specified property.
__property System::Void set_PropertyValues (System::String *name, OSGeo::FDO::Raster::DataValueCollection *collection)
 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.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Raster::IRasterPropertyDictionaryImp::IRasterPropertyDictionaryImp System::IntPtr  unmanaged,
System::Boolean  autoDelete
 

Constructs a IRasterPropertyDictionaryImp object based on an unmanaged instance of the object.

Parameters:
unmanaged Input A Pointer to the unmanaged object.
autoDelete Input Indicates if the constructed object should be automatically deleted once it no longer referenced.

Member Function Documentation

__property OSGeo ::FDO ::Expression ::DataValue* OSGeo::FDO::Raster::IRasterPropertyDictionaryImp::get_Property System::String *  name  ) 
 

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.

__property OSGeo ::FDO ::Schema ::DataType OSGeo::FDO::Raster::IRasterPropertyDictionaryImp::get_PropertyDataType System::String *  name  ) 
 

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.

__property OSGeo ::FDO ::Expression ::DataValue* OSGeo::FDO::Raster::IRasterPropertyDictionaryImp::get_PropertyDefault System::String *  name  ) 
 

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.

__property OSGeo ::FDO ::Common ::StringCollection* OSGeo::FDO::Raster::IRasterPropertyDictionaryImp::get_PropertyNames  ) 
 

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.

__property OSGeo ::FDO ::Raster ::DataValueCollection* OSGeo::FDO::Raster::IRasterPropertyDictionaryImp::get_PropertyValues System::String *  name  ) 
 

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.

System::Boolean OSGeo::FDO::Raster::IRasterPropertyDictionaryImp::IsPropertyEnumerable System::String *  name  ) 
 

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.

System::Boolean OSGeo::FDO::Raster::IRasterPropertyDictionaryImp::IsPropertyRequired System::String *  name  ) 
 

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.

System::Void OSGeo::FDO::Raster::IRasterPropertyDictionaryImp::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Runtime::Disposable.

__property System::Void OSGeo::FDO::Raster::IRasterPropertyDictionaryImp::set_Property System::String *  name,
OSGeo::FDO::Expression::DataValue value
 

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.

__property System::Void OSGeo::FDO::Raster::IRasterPropertyDictionaryImp::set_PropertyValues System::String *  name,
OSGeo::FDO::Raster::DataValueCollection collection
 

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.

Comments or suggestions? Send us feedback.