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::Schema::RasterPropertyDefinition Class Reference

Inherits OSGeo::FDO::Schema::PropertyDefinition.

Inheritance diagram for OSGeo::FDO::Schema::RasterPropertyDefinition:

[legend]
List of all members.

Detailed Description

RasterPropertyDefinition 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.


Public Member Functions

__property OSGeo::FDO::Raster::RasterDataModelget_DefaultDataModel ()
 Gets the default data model used by this raster property.
__property System::Int32 get_DefaultImageXSize ()
 Gets the default size of image file in the horizontal direction in pixels (number of columns).
__property System::Int32 get_DefaultImageYSize ()
 Gets the default size of an image file in the vertical direction in pixels (number of rows).
__property System::Boolean get_Nullable ()
 Returns a Boolean value that indicates if this property's value can be null.
__property System::Boolean get_ReadOnly ()
 Returns a Boolean value that indicates if this property is read-only.
__property System::String * get_SpatialContextAssociation ()
 Gets the Spatial Context name associated to this raster property.
 RasterPropertyDefinition (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs a RasterPropertyDefinition object based on an unmanaged instance of the object.
 RasterPropertyDefinition (System::String *name, System::String *description, System::Boolean system)
 Constructs an instance of an RasterPropertyDefinition using the specified arguments.
 RasterPropertyDefinition (System::String *name, System::String *description)
 Constructs an instance of an RasterPropertyDefinition using the specified arguments.
 RasterPropertyDefinition ()
 Constructs a default instance of an RasterPropertyDefinition.
__property System::Void set_DefaultDataModel (OSGeo::FDO::Raster::RasterDataModel *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.
__property System::Void set_DefaultImageXSize (System::Int32 size)
 Sets the default size of an image file in the horizontal direction in pixels (number of columns).
__property System::Void set_DefaultImageYSize (System::Int32 size)
 Sets the default size of an image file in the vertical direction in pixels (number of rows).
__property System::Void set_Nullable (System::Boolean value)
 Sets a Boolean value that indicates if this property's value can be null.
__property System::Void set_ReadOnly (System::Boolean value)
 Sets a Boolean value that indicates if this property is read-only.
__property System::Void set_SpatialContextAssociation (System::String *spatialContextName)
 Spatial Context Support. Sets a Spatial Context association for this raster property.

Constructor & Destructor Documentation

OSGeo::FDO::Schema::RasterPropertyDefinition::RasterPropertyDefinition  ) 
 

Constructs a default instance of an RasterPropertyDefinition.

OSGeo::FDO::Schema::RasterPropertyDefinition::RasterPropertyDefinition System::String *  name,
System::String *  description
 

Constructs an instance of an RasterPropertyDefinition using the specified arguments.

Parameters:
name Input name
description Input description

OSGeo::FDO::Schema::RasterPropertyDefinition::RasterPropertyDefinition System::String *  name,
System::String *  description,
System::Boolean  system
 

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

OSGeo::FDO::Schema::RasterPropertyDefinition::RasterPropertyDefinition System::IntPtr  unmanaged,
System::Boolean  autoDelete
[inline]
 

Constructs a RasterPropertyDefinition 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 ::Raster ::RasterDataModel* OSGeo::FDO::Schema::RasterPropertyDefinition::get_DefaultDataModel  ) 
 

Gets the default data model used by this raster property.

Returns:
Returns the current default data model.

__property System::Int32 OSGeo::FDO::Schema::RasterPropertyDefinition::get_DefaultImageXSize  ) 
 

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).

__property System::Int32 OSGeo::FDO::Schema::RasterPropertyDefinition::get_DefaultImageYSize  ) 
 

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).

__property System::Boolean OSGeo::FDO::Schema::RasterPropertyDefinition::get_Nullable  ) 
 

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

Returns:
Returns a Boolean value

__property System::Boolean OSGeo::FDO::Schema::RasterPropertyDefinition::get_ReadOnly  ) 
 

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

Returns:
Returns a Boolean value

__property System::String* OSGeo::FDO::Schema::RasterPropertyDefinition::get_SpatialContextAssociation  ) 
 

Gets the Spatial Context name associated to this raster property.

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

__property System::Void OSGeo::FDO::Schema::RasterPropertyDefinition::set_DefaultDataModel OSGeo::FDO::Raster::RasterDataModel 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.

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

__property System::Void OSGeo::FDO::Schema::RasterPropertyDefinition::set_DefaultImageXSize System::Int32  size  ) 
 

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).

__property System::Void OSGeo::FDO::Schema::RasterPropertyDefinition::set_DefaultImageYSize System::Int32  size  ) 
 

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).

__property System::Void OSGeo::FDO::Schema::RasterPropertyDefinition::set_Nullable System::Boolean  value  ) 
 

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

__property System::Void OSGeo::FDO::Schema::RasterPropertyDefinition::set_ReadOnly System::Boolean  value  ) 
 

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

__property System::Void OSGeo::FDO::Schema::RasterPropertyDefinition::set_SpatialContextAssociation System::String *  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

Comments or suggestions? Send us feedback.