[fdo-commits] r706 - branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Thu Feb 1 19:51:18 EST 2007
Author: gregboone
Date: 2007-02-01 19:51:18 -0500 (Thu, 01 Feb 2007)
New Revision: 706
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/mgIRasterPropertyDictionary.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRasterPropertyDictionaryImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataModel.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataModelType.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataOrganization.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-02 00:39:40 UTC (rev 705)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgDataValueCollection.h 2007-02-02 00:51:18 UTC (rev 706)
@@ -29,13 +29,32 @@
BEGIN_NAMESPACE_OSGEO_FDO_RASTER
/// \brief
-/// FdoArgumentDefinitionCollection is a collection of name-value pairs.
+/// DataValueCollection is a collection of DataValue objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class DataValueCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
+/// \cond DOXYGEN-IGNORE
private:
/// \brief
- /// nested class defined to provide Enumerator.
+ /// A Nested class defined to provide enumeration of Dictionary elements
+ ///
+ /// Enumerators can be used to read the data in the collection,
+ /// but they cannot be used to modify the underlying collection.
+ ///
+ /// An enumerator remains valid as long as the collection remains unchanged.
+ /// If changes are made to the collection, such as adding, modifying, or deleting
+ /// elements, the enumerator is irrecoverably invalidated and the next call to
+ /// MoveNext or Reset throws an InvalidOperationException. If the collection is
+ /// modified between MoveNext and Current, Current returns the element that it is
+ /// set to, even if the enumerator is already invalidated.
+ ///
+ /// The enumerator does not have exclusive access to the collection; therefore,
+ /// enumerating through a collection is intrinsically not a thread-safe procedure.
+ /// Even when a collection is synchronized, other threads can still modify the
+ /// collection, which causes the enumerator to throw an exception. To guarantee
+ /// thread safety during enumeration, you can either lock the collection during
+ /// the entire enumeration or catch the exceptions resulting from changes made
+ /// by other threads.
///
__gc class Enumerator : public System::Collections::IEnumerator
{
@@ -44,15 +63,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(DataValueCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
}
- __property System::Object* get_Current();
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
+ __property System::Object *get_Current();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first object in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
System::Boolean MoveNext();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
System::Void Reset();
};
@@ -60,49 +111,63 @@
inline FdoDataValueCollection* GetImpObj();
private:
- /// System::Collections::ICollection interfaces
- System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
+ // System::Collections::ICollection interface properties
+ __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
- __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ // System::Collections::ICollection interface methods
+ System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
- __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
+ // System::Collections::IList interface properties
+ __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ __property System::Boolean System::Collections::IList::get_IsReadOnly();
+ __property Object* System::Collections::IList::get_Item(System::Int32 index);
+ __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
- // System::Collections::IList interfaces
- __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ // System::Collections::IList interface methods
+ System::Int32 System::Collections::IList::Add(Object* value);
+ System::Boolean System::Collections::IList::Contains(Object* value);
+ System::Int32 System::Collections::IList::IndexOf(Object* value);
+ System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
+ System::Void System::Collections::IList::Remove(Object* value);
+/// \endcond
- __property System::Boolean System::Collections::IList::get_IsReadOnly();
-
- System::Int32 System::Collections::IList::Add(Object* value);
-
- System::Boolean System::Collections::IList::Contains(Object* value);
-
- System::Int32 System::Collections::IList::IndexOf(Object* value);
-
- System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
-
- System::Void System::Collections::IList::Remove(Object* value);
-
- __property Object* System::Collections::IList::get_Item(System::Int32 index);
-
- __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
-
public:
+ /// \brief
+ /// The defaut constructor for the object
+ ///
DataValueCollection();
+ /// \brief
+ /// Constructs a DataValueCollection object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
DataValueCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
+ /// \return
+ /// Returns the number of items in the collection.
+ ///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
+ /// \return
+ /// Returns an enumerator on the dictionary.
+ ///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th ArgumentDefinition from this collection.
+ /// Removes the index-th DataValue from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -110,63 +175,63 @@
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
/// \brief
- /// Adds a ArgumentDefinition object into the collection.
+ /// Adds a DataValue object into the collection.
///
/// \param value
- /// Input the ArgumentDefinition object to add.
+ /// Input the DataValue object to add.
///
/// \return
- /// Returns the position into which the new element was inserted.
+ /// Returns the position into which the new element was inserted.
///
System::Int32 Add(DataValue* value);
/// \brief
- /// Determines the index of a specific ArgumentDefinition object.
+ /// Determines the index of a specific DataValue object.
///
/// \param value
- /// Input the ArgumentDefinition object to locate in the collection.
+ /// Input the DataValue object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(DataValue* value);
/// \brief
- /// Inserts a ArgumentDefinition object into the collection at the specified position.
+ /// Inserts a DataValue object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
/// \param value
- /// Input the ArgumentDefinition object to insert.
+ /// Input the DataValue object to insert.
///
System::Void Insert(System::Int32 index, DataValue* value);
/// \brief
- /// Removes the first occurrence of a specific ArgumentDefinition object.
+ /// Removes the first occurrence of a specific DataValue object.
///
/// \param value
- /// Input the ArgumentDefinition object to remove from the collection.
+ /// Input the DataValue object to remove from the collection.
///
System::Void Remove(DataValue* value);
/// \brief
- /// Determines whether the collection contains a specific ArgumentDefinition object.
+ /// Determines whether the collection contains a specific DataValue object.
///
/// \param value
- /// Input The ArgumentDefinition object to search in the collection.
+ /// Input The DataValue object to search in the collection.
///
/// \return
- /// Returns true if the value is found in the collection; otherwise, false.
+ /// Returns true if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(DataValue* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -175,23 +240,55 @@
///
System::Void CopyTo(DataValue* array[],System::Int32 size);
-
/// \brief
- /// Gets or sets a ArgumentDefinition in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the ArgumentDefinition to retrieve or set (System::Int32).
+ /// The index of the item in the collection. The index is 0 based.
///
+ /// \return
+ /// Returns an instance of a the collected item.
+ /// Throws an instance of Exception if the index is out of range or an error occurs.
+ ///
__property DataValue* get_RealTypeItem(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, DataValue* value);
+ /// \brief
+ /// Gets an item in the collection.
+ ///
+ /// \param index
+ /// Input index of the item to retrieve.
+ ///
+ /// \return
+ /// Returns the item at the specified index
+ ///
__property DataValue* get_Item(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_Item(System::Int32 index, DataValue* value);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_RASTER
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-02 00:39:40 UTC (rev 705)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRaster.h 2007-02-02 00:51:18 UTC (rev 706)
@@ -31,7 +31,7 @@
public __gc __interface IRasterPropertyDictionary;
/// \brief
-/// The FdoIRaster specifies the data type and organization
+/// The IRaster interface specifies the data type and organization
/// of raster data retrieved and stored. Using this class and the image
/// extents in width and length, the binary format of the image data returned
/// by and accepted by the IoStreamReader class can be interpreted.
@@ -40,15 +40,15 @@
public:
/// \brief
- /// Returns true if the FdoIRaster represents a null value.
+ /// Returns true if the IRaster represents a null value.
///
/// \return
- /// Returns true if the FdoIRaster represents a null value.
+ /// Returns true if the IRaster represents a null value.
///
System::Boolean IsNull ();
/// \brief
- /// Sets the FdoIRaster to a null value.
+ /// Sets the IRaster to a null value.
///
/// \return
/// Returns nothing
@@ -75,7 +75,7 @@
/// Gets the currently active band/channel.
///
/// \remarks
- /// The FdoIRaster Bounds, DataModel, ImageSize, AuxilliaryProperties and Stream
+ /// IRaster Bounds, DataModel, ImageSize, AuxilliaryProperties and Stream
/// accessors all conform to the current band.
///
/// \return
@@ -87,8 +87,8 @@
/// Sets the currently active band/channel.
///
/// \remarks
- /// Setting the current band will mean that the Bounds, DataModel, ImageSize,
- /// AuxilliaryProperties and Stream accessors of FdoIRaster
+ /// 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
@@ -152,7 +152,7 @@
/// the amount of data shipped by the reader and reduce processing
/// time significantly. For example, a certain query in the
/// coordinate system of the raster object class returns a
- /// FdoIRaster object with image size 12091 by 8043. But the
+ /// IRaster object with image size 12091 by 8043. But the
/// image only needs to be displayed in an area 1167 by 776 on
/// the users monitor.
/// <p>(<b>Note:</b> The aspect ratios are the same
@@ -196,7 +196,7 @@
/// Get 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
+ /// Data values are exchanged through the DataValue object to
/// accommodate various data types, boolean, integer, double, string,
/// etc.
///
@@ -211,12 +211,12 @@
/// \remarks
/// 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(FdoRasterDataModel* datamodel) a subsequent
+ /// 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 FdoDataType 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 ();
@@ -225,7 +225,7 @@
/// Image data is shipped using a paradigm similar to BLOB I/O.
/// When inserting or updating an object with a raster property,
/// the SetStreamReader method provides a means to set a
- /// FdoIStreamReader callback.
+ /// IStreamReader callback.
/// On execution of an insert or update command, requests are made on
/// the reader for the image data (which is supplied by the FDO client
/// application).
@@ -242,7 +242,7 @@
/// Get the source of image data.
/// Image data is shipped using a paradigm similar to BLOB I/O.
/// When fetching a raster image the GetStreamReader() method provides
- /// a FdoIStreamReader from which the client may request the image data.
+ /// a IStreamReader from which the client may request the image data.
/// The format of the image data expected is determined by the
/// DataModel property. The data type, bit depth, tiling and
/// organization specify the meaning of the image data.
@@ -266,7 +266,7 @@
/// Gets the Vertical Unit of Measure corresponding to the Raster Band.
/// The string value returned will be a considered lookup value that
/// will be used to identify the properties of the Unit of Measure using
- /// the FDO FdoIGetMeasureUnits command.
+ /// the IGetMeasureUnits command.
///
/// \return
/// Returns the Unit of Measure type of data associated to the Raster Band.
@@ -279,7 +279,7 @@
/// \param units
/// The Unit of Measure type for the current band.
/// The units string value corresponds to a Unit of Measure supported
- /// through the FdoIGetMeasureUnits command.
+ /// through the IGetMeasureUnits command.
__property System::Void set_VerticalUnits (System::String* units);
};
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-02 00:39:40 UTC (rev 705)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRasterImp.h 2007-02-02 00:51:18 UTC (rev 706)
@@ -25,7 +25,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_RASTER
/// \brief
-/// The FdoIRaster specifies the data type and organization
+/// IRasterImp specifies the data type and organization
/// of raster data retrieved and stored. Using this class and the image
/// extents in width and length, the binary format of the image data returned
/// by and accepted by the IoStreamReader class can be interpreted.
@@ -33,15 +33,15 @@
{
public:
/// \brief
- /// Returns true if the FdoIRaster represents a null value.
+ /// Returns true if the IRaster represents a null value.
///
/// \return
- /// Returns true if the FdoIRaster represents a null value.
+ /// Returns true if the IRaster represents a null value.
///
System::Boolean IsNull ();
/// \brief
- /// Sets the FdoIRaster to a null value.
+ /// Sets the IRaster to a null value.
///
/// \return
/// Returns nothing
@@ -68,7 +68,7 @@
/// Gets the currently active band/channel.
///
/// \remarks
- /// The FdoIRaster Bounds, DataModel, ImageSize, AuxilliaryProperties and Stream
+ /// IRaster Bounds, DataModel, ImageSize, AuxilliaryProperties and Stream
/// accessors all conform to the current band.
///
/// \return
@@ -81,7 +81,7 @@
///
/// \remarks
/// Setting the current band will mean that the Bounds, DataModel, ImageSize,
- /// AuxilliaryProperties and Stream accessors of FdoIRaster
+ /// AuxilliaryProperties and Stream accessors of IRaster
/// will all switch to the specified band.
///
/// \return
@@ -145,7 +145,7 @@
/// the amount of data shipped by the reader and reduce processing
/// time significantly. For example, a certain query in the
/// coordinate system of the raster object class returns a
- /// FdoIRaster object with image size 12091 by 8043. But the
+ /// IRaster object with image size 12091 by 8043. But the
/// image only needs to be displayed in an area 1167 by 776 on
/// the users monitor.
/// <p>(<b>Note:</b> The aspect ratios are the same
@@ -189,7 +189,7 @@
/// Get 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
+ /// Data values are exchanged through the DataValue object to
/// accommodate various data types, boolean, integer, double, string,
/// etc.
///
@@ -204,12 +204,12 @@
/// \remarks
/// 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(FdoRasterDataModel* datamodel) a subsequent
+ /// 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 FdoDataType 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 ();
@@ -218,7 +218,7 @@
/// Image data is shipped using a paradigm similar to BLOB I/O.
/// When inserting or updating an object with a raster property,
/// the SetStreamReader method provides a means to set a
- /// FdoIStreamReader callback.
+ /// IStreamReader callback.
/// On execution of an insert or update command, requests are made on
/// the reader for the image data (which is supplied by the FDO client
/// application).
@@ -235,7 +235,7 @@
/// Get the source of image data.
/// Image data is shipped using a paradigm similar to BLOB I/O.
/// When fetching a raster image the GetStreamReader() method provides
- /// a FdoIStreamReader from which the client may request the image data.
+ /// a IStreamReader from which the client may request the image data.
/// The format of the image data expected is determined by the
/// DataModel property. The data type, bit depth, tiling and
/// organization specify the meaning of the image data.
@@ -259,7 +259,7 @@
/// Gets the Vertical Unit of Measure corresponding to the Raster Band.
/// The string value returned will be a considered lookup value that
/// will be used to identify the properties of the Unit of Measure using
- /// the FDO FdoIGetMeasureUnits command.
+ /// the IGetMeasureUnits command.
///
/// \return
/// Returns the Unit of Measure type of data associated to the Raster Band.
@@ -272,14 +272,26 @@
/// \param units
/// The Unit of Measure type for the current band.
/// The units string value corresponds to a Unit of Measure supported
- /// through the FdoIGetMeasureUnits command.
+ /// through the IGetMeasureUnits command.
__property System::Void set_VerticalUnits (System::String* units);
public:
+ /// \brief
+ /// Constructs a IRasterImp object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IRasterImp(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
inline FdoIRaster* GetImpObj();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRasterPropertyDictionary.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRasterPropertyDictionary.h 2007-02-02 00:39:40 UTC (rev 705)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRasterPropertyDictionary.h 2007-02-02 00:51:18 UTC (rev 706)
@@ -30,11 +30,11 @@
public __gc class DataValueCollection;
/// \brief
-/// The FdoIRasterPropertyDictionary exposes a dictionary style
+/// 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 FdoDataValue object to accommodate various data types,
+/// through the DataValue object to accommodate various data types,
/// boolean, integer, double, string etc.
public __gc __interface IRasterPropertyDictionary: public System::IDisposable
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRasterPropertyDictionaryImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRasterPropertyDictionaryImp.h 2007-02-02 00:39:40 UTC (rev 705)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgIRasterPropertyDictionaryImp.h 2007-02-02 00:51:18 UTC (rev 706)
@@ -23,11 +23,11 @@
BEGIN_NAMESPACE_OSGEO_FDO_RASTER
/// \brief
-/// The FdoIRasterPropertyDictionary exposes a dictionary style
+/// 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 FdoDataValue object to accommodate various data types,
+/// through the DataValue object to accommodate various data types,
/// boolean, integer, double, string etc.
private __gc class IRasterPropertyDictionaryImp: public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_RASTER::IRasterPropertyDictionary
{
@@ -139,10 +139,22 @@
///
__property System::Void set_PropertyValues (System::String* name, NAMESPACE_OSGEO_FDO_RASTER::DataValueCollection* collection);
+ /// \brief
+ /// Constructs a IRasterPropertyDictionaryImp object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IRasterPropertyDictionaryImp(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
inline FdoIRasterPropertyDictionary* GetImpObj();
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-02 00:39:40 UTC (rev 705)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataModel.h 2007-02-02 00:51:18 UTC (rev 706)
@@ -27,10 +27,10 @@
BEGIN_NAMESPACE_OSGEO_FDO_RASTER
/// \brief
-/// The FdoRasterDataModel specifies the data type and organization
+/// The RasterDataModel specifies the data type and organization
/// of raster data retrieved and stored. Using this class and the image
/// extents in width and length, the binary format of the image data returned
-/// by and accepted by the FdoIStreamReader class can be interpreted.
+/// by and accepted by the IStreamReader class can be interpreted.
public __gc class RasterDataModel: public NAMESPACE_OSGEO_RUNTIME::Disposable
{
public:
@@ -76,7 +76,7 @@
/// 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)
- /// are likely to raise a FdoException.
+ /// are likely to raise a Exception.
///
__property System ::Void set_BitsPerPixel (System::Int32 bitsPerPixel);
@@ -148,10 +148,22 @@
///
__property System::Void set_DataType (NAMESPACE_OSGEO_FDO_RASTER::RasterDataType dataType);
+ /// \brief
+ /// Constructs a RasterDataModel object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
RasterDataModel(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
inline FdoRasterDataModel* GetImpObj();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataModelType.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataModelType.h 2007-02-02 00:39:40 UTC (rev 705)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataModelType.h 2007-02-02 00:51:18 UTC (rev 706)
@@ -21,7 +21,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_RASTER
/// \brief
-/// The FdoRasterDataModelType enumeration specifies the type of
+/// The RasterDataModelType enumeration specifies the type of
/// data within each pixel. In all cases the data is 'packed', that is,
/// adjacent pixels are contiguous in memory with no unused bits between
/// them, except at the end of a row, where the row is padded to a
@@ -35,25 +35,25 @@
/// allocated to each band, so for example RGBT data with eight bits for red,
/// would also have eight bits for each of the three other bands totaling
/// thirty-two bits (BitsPerPixel=32).
-/// <param name="FdoRasterDataModelType_Unknown">
+/// <param name="RasterDataModelType_Unknown">
/// Data is organized in an unknown or provider specific manner.
/// </param>
-/// <param name="FdoRasterDataModelType_Bitonal">
+/// <param name="RasterDataModelType_Bitonal">
/// Data is organized as one bit (black/white - bitonal) data.
/// </param>
-/// <param name="FdoRasterDataModelType_Gray">
+/// <param name="RasterDataModelType_Gray">
/// Data is monochrome (black->gray->white) pixels.
/// It is necessary to know the BitsPerPixel value to interpret the data.
/// </param>
-/// <param name="FdoRasterDataModelType_RGB">
+/// <param name="RasterDataModelType_RGB">
/// Data is red/green/blue (in that order) pixels.
/// It is necessary to know the BitsPerPixel value to interpret the data.
/// </param>
-/// <param name="FdoRasterDataModelType_RGBA">
+/// <param name="RasterDataModelType_RGBA">
/// Data is red/green/blue/alpha (in that order) pixels; RGB with transparency.
/// It is necessary to know the BitsPerPixel value to interpret the data.
/// </param>
-/// <param name="FdoRasterDataModelType_Palette">
+/// <param name="RasterDataModelType_Palette">
/// Data is monochrome but backed by a pallette (value->pallette->colour) pixels.
/// It is necessary to know the BitsPerPixel value to interpret the data.
/// </param>
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataOrganization.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataOrganization.h 2007-02-02 00:39:40 UTC (rev 705)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Raster/mgRasterDataOrganization.h 2007-02-02 00:51:18 UTC (rev 706)
@@ -18,24 +18,24 @@
BEGIN_NAMESPACE_OSGEO_FDO_RASTER
/// \brief
-/// The FdoRasterDataOrganization enumeration specifies the way
+/// The RasterDataOrganization enumeration specifies the way
/// pixel data is interleaved. Data is stored/retrieved in left to right,
/// and secondarily top to bottom order within the interleave order.
/// Tiles are also stored/retrieved in left to right, top to bottom order.
/// For tiled data, data for one tile is completely stored/retrieved before
-/// the next tile, so for example, with 'FdoRasterDataOrganization_Image'
+/// the next tile, so for example, with 'RasterDataOrganization_Image'
/// organization of RGB data with 24 bits per pixel, the TileSizeX by
/// TileSizeY 8 bit data values for the red channel are stored first
/// followed by the same number of green bytes, followed by the same
/// number of blue bytes. This organization dependant storage should be
/// considered when 'skipping' to the middle of an image.
-/// <param name="FdoRasterDataOrganization_Pixel">
+/// <param name="RasterDataOrganization_Pixel">
/// Data is interleaved by pixel, with all data for a pixel contiguous in memory.
/// </param>
-/// <param name="FdoRasterDataOrganization_Row">
+/// <param name="RasterDataOrganization_Row">
/// Data is interleaved by row, with all data of a channel for one row contiguous in memory, followed by a rows worth of the next channel, etc.
/// </param>
-/// <param name="FdoRasterDataOrganization_Image">
+/// <param name="RasterDataOrganization_Image">
/// Data is interleaved by image, with all data of a channel for a complete image contiguous in memory, followed by a complete image of the next channel, etc.
/// </param>
public __value enum RasterDataOrganization
More information about the fdo-commits
mailing list