[fdo-commits] r738 - branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Wed Feb 7 16:45:51 EST 2007
Author: gregboone
Date: 2007-02-07 16:45:51 -0500 (Wed, 07 Feb 2007)
New Revision: 738
Modified:
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgDataValueCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRaster.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRasterImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataModel.h
Log:
893057: DOC: FDO Managed API Documentation Updates
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgDataValueCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgDataValueCollection.h 2007-02-07 21:44:59 UTC (rev 737)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgDataValueCollection.h 2007-02-07 21:45:51 UTC (rev 738)
@@ -235,10 +235,11 @@
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
+ ///
/// \param startAt
/// Input an integer that represents the index in array at which copying begins.
///
- System::Void CopyTo(DataValue* array[],System::Int32 size);
+ System::Void CopyTo(DataValue* array[],System::Int32 startAt);
/// \brief
/// Gets the item in the collection at the specified index.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRaster.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRaster.h 2007-02-07 21:44:59 UTC (rev 737)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRaster.h 2007-02-07 21:45:51 UTC (rev 738)
@@ -56,35 +56,35 @@
System::Void SetNull ();
/// \brief
- /// Gets the number of bands/channels contained in the raster image.
+ /// Gets the number of bands/channels contained in the raster image.
///
/// \return
- /// Returns the numbers of bands/channels contained in the raster image.
+ /// Returns the numbers of bands/channels contained in the raster image.
///
__property System::Int32 get_NumberOfBands();
/// \brief
- /// Sets the number of bands/channels contained in the raster image.
+ /// Sets the number of bands/channels contained in the raster image.
///
/// \return
- /// Returns nothing.
+ /// Returns nothing.
///
__property System::Void set_NumberOfBands (System::Int32 value);
/// \brief
- /// Gets the currently active band/channel.
+ /// Gets the currently active band/channel.
///
/// \remarks
/// IRaster Bounds, DataModel, ImageSize, AuxilliaryProperties and Stream
/// accessors all conform to the current band.
///
/// \return
- /// Returns the current active band/channel.
+ /// Returns the current active band/channel.
///
__property System::Int32 get_CurrentBand ();
/// \brief
- /// Sets the currently active band/channel.
+ /// Sets the currently active band/channel.
///
/// \remarks
/// Setting the current band will mean that the Bounds, DataModel, ImageSize,
@@ -92,20 +92,29 @@
/// will all switch to the specified band.
///
/// \return
- /// Returns nothing.
+ /// Returns nothing.
///
__property System::Void set_CurrentBand (System::Int32 value);
- /// Get the minimum bounding box around the image.
- /// The bounds are transformed to the active spatial context.
+ /// \brief
+ /// Get the minimum bounding box around the curent band of the image.
+ ///
+ /// \return
+ /// Returns the bounds of the raster image
+ ///
__property System::Byte get_Bounds () [];
+ /// \brief
/// Set the minimum bounding box around the image.
/// For georeferenced images, the coordinate system is specified by the
/// spatial context in force when the object is created. The act of
/// setting this property georeferences the image. In order to provide
/// for non-georeferenced images, this property is Nullable (doesn't
/// need to be set).
+ ///
+ /// \param bounds
+ /// The new bounds of the raster image.
+ ///
__property System::Void set_Bounds (System::Byte bounds[]);
/// \brief
@@ -120,6 +129,8 @@
/// Sets the data model used by this raster property.
/// Allowed values are only those data models that are acceptable to the
/// SupportsDataModel capability.
+ ///
+ /// \remarks
/// This attribute specifies the colour/palette model, bits per pixel,
/// tiling and interleaving. For example, if the bits per pixel of the
/// data model is 8 and it is set to 24, a conversion would be performed
@@ -128,7 +139,7 @@
/// transformed and saved. The next time this image is retrieved
/// by the client the bits per pixel value would indicate 24.
///
- /// \param datamodel
+ /// \param dataModel
/// The datamodel to be used.
///
__property System::Void set_DataModel (NAMESPACE_OSGEO_FDO_RASTER::RasterDataModel* dataModel);
@@ -206,17 +217,17 @@
NAMESPACE_OSGEO_FDO_RASTER::IRasterPropertyDictionary* GetAuxiliaryProperties();
/// \brief
- /// Gets the pixel value that represents a NULL value in the available raster stream.
+ /// Gets the pixel value that represents a NULL value in the available raster stream.
///
/// \remarks
- /// The Null Pixel Value is Data Model dependent. The value of the Null pixel
+ /// The Null Pixel Value is Data Model dependent. The value of the Null pixel
/// will change depending on which data model is set. If the client application changes
/// the Data Model using SetDataModel(RasterDataModel* datamodel) a subsequent
/// call to GetNullPixelValue will need to be made in order to determine the valid Null
/// value for the current data model.
///
/// \return
- /// Returns the DataType value that can be used to identify the Null value.
+ /// Returns the DataType value that can be used to identify the Null value.
///
__property NAMESPACE_OSGEO_FDO_EXPRESSION::DataValue* get_NullPixelValue ();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRasterImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRasterImp.h 2007-02-07 21:44:59 UTC (rev 737)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRasterImp.h 2007-02-07 21:45:51 UTC (rev 738)
@@ -49,56 +49,65 @@
System::Void SetNull ();
/// \brief
- /// Gets the number of bands/channels contained in the raster image.
+ /// Gets the number of bands/channels contained in the raster image.
///
/// \return
- /// Returns the numbers of bands/channels contained in the raster image.
+ /// Returns the numbers of bands/channels contained in the raster image.
///
__property System::Int32 get_NumberOfBands();
/// \brief
- /// Sets the number of bands/channels contained in the raster image.
+ /// Sets the number of bands/channels contained in the raster image.
///
/// \return
- /// Returns nothing.
+ /// Returns nothing.
///
__property System::Void set_NumberOfBands (System::Int32 value);
/// \brief
- /// Gets the currently active band/channel.
+ /// Gets the currently active band/channel.
///
/// \remarks
/// IRaster Bounds, DataModel, ImageSize, AuxilliaryProperties and Stream
/// accessors all conform to the current band.
///
/// \return
- /// Returns the current active band/channel.
+ /// Returns the current active band/channel.
///
__property System::Int32 get_CurrentBand ();
/// \brief
- /// Sets the currently active band/channel.
+ /// Sets the currently active band/channel.
///
/// \remarks
- /// Setting the current band will mean that the Bounds, DataModel, ImageSize,
+ /// Setting the current band will mean that the Bounds, DataModel, ImageSize,
/// AuxilliaryProperties and Stream accessors of IRaster
/// will all switch to the specified band.
///
/// \return
- /// Returns nothing.
+ /// Returns nothing.
///
__property System::Void set_CurrentBand (System::Int32 value);
- /// Get the minimum bounding box around the image.
- /// The bounds are transformed to the active spatial context.
+ /// \brief
+ /// Get the minimum bounding box around the curent band of the image.
+ ///
+ /// \return
+ /// Returns the bounds of the raster image
+ ///
__property System::Byte get_Bounds () [];
+ /// \brief
/// Set the minimum bounding box around the image.
/// For georeferenced images, the coordinate system is specified by the
/// spatial context in force when the object is created. The act of
/// setting this property georeferences the image. In order to provide
/// for non-georeferenced images, this property is Nullable (doesn't
/// need to be set).
+ ///
+ /// \param bounds
+ /// The new bounds of the raster image.
+ ///
__property System::Void set_Bounds (System::Byte bounds[]);
/// \brief
@@ -113,6 +122,8 @@
/// Sets the data model used by this raster property.
/// Allowed values are only those data models that are acceptable to the
/// SupportsDataModel capability.
+ ///
+ /// \remarks
/// This attribute specifies the colour/palette model, bits per pixel,
/// tiling and interleaving. For example, if the bits per pixel of the
/// data model is 8 and it is set to 24, a conversion would be performed
@@ -122,7 +133,7 @@
/// by the client the bits per pixel value would indicate 24.
///
/// \param dataModel
- /// The dataModel to be used.
+ /// The datamodel to be used.
///
__property System::Void set_DataModel (NAMESPACE_OSGEO_FDO_RASTER::RasterDataModel* dataModel);
@@ -199,17 +210,17 @@
NAMESPACE_OSGEO_FDO_RASTER::IRasterPropertyDictionary* GetAuxiliaryProperties();
/// \brief
- /// Gets the pixel value that represents a NULL value in the available raster stream.
+ /// Gets the pixel value that represents a NULL value in the available raster stream.
///
/// \remarks
- /// The Null Pixel Value is Data Model dependent. The value of the Null pixel
+ /// The Null Pixel Value is Data Model dependent. The value of the Null pixel
/// will change depending on which data model is set. If the client application changes
/// the Data Model using SetDataModel(RasterDataModel* datamodel) a subsequent
/// call to GetNullPixelValue will need to be made in order to determine the valid Null
/// value for the current data model.
///
/// \return
- /// Returns the DataType value that can be used to identify the Null value.
+ /// Returns the DataType value that can be used to identify the Null value.
///
__property NAMESPACE_OSGEO_FDO_EXPRESSION::DataValue* get_NullPixelValue ();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataModel.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataModel.h 2007-02-07 21:44:59 UTC (rev 737)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataModel.h 2007-02-07 21:45:51 UTC (rev 738)
@@ -72,7 +72,7 @@
/// \brief
/// Set the number of bits per pixel.
///
- /// \param bpp
+ /// \param bitsPerPixel
/// The number of bits per pixel desired.
/// Values of 1, 4, 8, 16, 24, 32, 48 and 64 bits per channel may
/// be supported. Others values (i.e. indivisible by the number of channels)
@@ -143,7 +143,7 @@
/// \brief
/// Sets the data type.
///
- /// \param value
+ /// \param dataType
/// Specifies the data type the raster data is to be returned in.
///
__property System::Void set_DataType (NAMESPACE_OSGEO_FDO_RASTER::RasterDataType dataType);
More information about the fdo-commits
mailing list