| FDO .NET API Reference | Feature Data Objects |
00001 /* 00002 * Copyright (C) 2004-2006 Autodesk, Inc. 00003 * 00004 * This library is free software; you can redistribute it and/or 00005 * modify it under the terms of version 2.1 of the GNU Lesser 00006 * General Public License as published by the Free Software Foundation. 00007 * 00008 * This library is distributed in the hope that it will be useful, 00009 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00011 * Lesser General Public License for more details. 00012 * 00013 * You should have received a copy of the GNU Lesser General Public 00014 * License along with this library; if not, write to the Free Software 00015 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00016 * 00017 */ 00018 00019 #pragma once 00020 00021 class FdoBatchParameterValueCollection; 00022 00023 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS 00024 public __gc class ParameterValueCollection; 00025 00026 /// \ingroup (OSGeoFDOCommands) 00027 /// \brief 00028 /// The BatchParameterValueCollection class represents a collection of parameter value collections that is used for 00029 /// optimized batch inserts. 00030 [System::Reflection::DefaultMemberAttribute("RealTypeItem")] 00031 public __sealed __gc class BatchParameterValueCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList 00032 { 00033 /// \cond DOXYGEN-IGNORE 00034 private: 00035 /// \brief 00036 /// A Nested class defined to provide enumeration of Dictionary elements 00037 /// 00038 /// Enumerators can be used to read the data in the collection, 00039 /// but they cannot be used to modify the underlying collection. 00040 /// 00041 /// An enumerator remains valid as long as the collection remains unchanged. 00042 /// If changes are made to the collection, such as adding, modifying, or deleting 00043 /// elements, the enumerator is irrecoverably invalidated and the next call to 00044 /// MoveNext or Reset throws an InvalidOperationException. If the collection is 00045 /// modified between MoveNext and Current, Current returns the element that it is 00046 /// set to, even if the enumerator is already invalidated. 00047 /// 00048 /// The enumerator does not have exclusive access to the collection; therefore, 00049 /// enumerating through a collection is intrinsically not a thread-safe procedure. 00050 /// Even when a collection is synchronized, other threads can still modify the 00051 /// collection, which causes the enumerator to throw an exception. To guarantee 00052 /// thread safety during enumeration, you can either lock the collection during 00053 /// the entire enumeration or catch the exceptions resulting from changes made 00054 /// by other threads. 00055 /// 00056 __gc class Enumerator : public System::Collections::IEnumerator 00057 { 00058 private: 00059 BatchParameterValueCollection* m_pCol; 00060 System::Int32 m_nIdx; 00061 00062 public: 00063 /// \brief 00064 /// Constructs a new Collection Enumerator 00065 /// 00066 /// \param col 00067 /// Input The collection to enumerate. 00068 /// 00069 Enumerator(BatchParameterValueCollection* elements) : m_pCol(elements), m_nIdx(-1) 00070 { 00071 00072 } 00073 00074 /// \brief 00075 /// Retrieves the current object at the enumerator location 00076 /// 00077 /// \return 00078 /// Retuns the current object referenced by the enumerator 00079 /// 00080 __property System::Object *get_Current(); 00081 00082 /// \brief 00083 /// Initially, the enumerator is positioned before the first element in the collection. 00084 /// At this position, calling the Current property throws an exception. 00085 /// Therefore, you must call the MoveNext method to advance the enumerator 00086 /// to the first element of the collection before reading the value of Current. 00087 /// If MoveNext passes the end of the collection, the enumerator is positioned 00088 /// after the last element in the collection and MoveNext returns false. 00089 /// When the enumerator is at this position, subsequent calls to MoveNext also return false. 00090 /// If the last call to MoveNext returned false, calling Current throws an exception. 00091 /// To set Current to the first element of the collection again, you can call Reset 00092 /// followed by MoveNext. 00093 /// 00094 /// \return 00095 /// Retuns true if the Enumerator is able to move to a valid element 00096 /// otherwise false. 00097 /// 00098 System::Boolean MoveNext(); 00099 00100 /// \brief 00101 /// Initially, the enumerator is positioned before the first element in the collection. 00102 /// The Reset method brings the enumerator back to this position. 00103 /// 00104 System::Void Reset(); 00105 }; 00106 00107 public private: 00108 BatchParameterValueCollection(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete) 00109 { 00110 00111 } 00112 00113 inline FdoBatchParameterValueCollection* GetImpObj(); 00114 00115 private: 00116 // System::Collections::ICollection interface properties 00117 __property System::Object* System::Collections::ICollection::get_SyncRoot(); 00118 __property System::Boolean System::Collections::ICollection::get_IsSynchronized(); 00119 00120 // System::Collections::ICollection interface methods 00121 System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index); 00122 00123 // System::Collections::IList interface properties 00124 __property System::Boolean System::Collections::IList::get_IsFixedSize(); 00125 __property System::Boolean System::Collections::IList::get_IsReadOnly(); 00126 __property Object* System::Collections::IList::get_Item(System::Int32 index); 00127 __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value); 00128 00129 // System::Collections::IList interface methods 00130 System::Int32 System::Collections::IList::Add(Object* value); 00131 System::Boolean System::Collections::IList::Contains(Object* value); 00132 System::Int32 System::Collections::IList::IndexOf(Object* value); 00133 System::Void System::Collections::IList::Insert(System::Int32 index, Object* value); 00134 System::Void System::Collections::IList::Remove(Object* value); 00135 00136 /// \endcond 00137 00138 public: 00139 /// \brief 00140 /// Constructs a new empty string collection 00141 /// 00142 /// \return 00143 /// Returns StringCollection 00144 /// 00145 /// 00146 BatchParameterValueCollection(); 00147 00148 /// \brief 00149 /// Gets the count of items in collection. 00150 /// 00151 /// \return 00152 /// Returns the number of items in the collection. 00153 /// 00154 __property System::Int32 get_Count(System::Void); 00155 00156 /// \brief 00157 /// Gets an enumerator that can iterate through a collection. 00158 /// 00159 /// \return 00160 /// Returns a collection enumerator. 00161 /// 00162 __sealed System::Collections::IEnumerator* GetEnumerator(System::Void); 00163 00164 /// \brief 00165 /// Removes the index-th ParameterValueCollection from this collection. 00166 /// 00167 /// \param index 00168 /// Input index of the element to remove. 00169 /// 00170 System::Void RemoveAt(System::Int32 index); 00171 00172 /// \brief 00173 /// Removes all elements from the collection. 00174 /// 00175 System::Void Clear(); 00176 00177 /// \brief 00178 /// Adds a ParameterValueCollection object into the collection. 00179 /// 00180 /// \param value 00181 /// Input the ParameterValueCollection object to add. 00182 /// 00183 /// \return 00184 /// Returns the position into which the new element was inserted. 00185 /// 00186 System::Int32 Add(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value); 00187 00188 /// \brief 00189 /// Determines the index of a specific ParameterValueCollection object. 00190 /// 00191 /// \param value 00192 /// Input the ParameterValueCollection object to locate in the collection. 00193 /// 00194 /// \return 00195 /// The index of value if found in the collection; otherwise, -1. 00196 /// 00197 System::Int32 IndexOf(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value); 00198 00199 /// \brief 00200 /// Inserts a ParameterValueCollection object into the collection at the specified position. 00201 /// 00202 /// \param index 00203 /// Input the zero-based index at which value should be inserted. 00204 /// \param value 00205 /// Input the ParameterValueCollection object to insert. 00206 /// 00207 System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value); 00208 00209 /// \brief 00210 /// Removes the first occurrence of a specific ParameterValueCollection object. 00211 /// 00212 /// \param value 00213 /// Input the ParameterValueCollection object to remove from the collection. 00214 /// 00215 System::Void Remove(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value); 00216 00217 /// \brief 00218 /// Determines whether the collection contains a specific ParameterValueCollection object. 00219 /// 00220 /// \param value 00221 /// Input The ParameterValueCollection object to search in the collection. 00222 /// 00223 /// \return 00224 /// Returns true if the value is found in the collection; otherwise, false. 00225 /// 00226 System::Boolean Contains(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value); 00227 00228 /// \brief 00229 /// Copies the elements of the collection to an array. 00230 /// 00231 /// \param array 00232 /// Output the one-dimensional Array that is the destination of the elements copied from this collection. 00233 /// 00234 /// \param index 00235 /// Input an integer that represents the index in array at which copying begins. 00236 /// 00237 System::Void CopyTo(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* array[],System::Int32 index); 00238 00239 /// \brief 00240 /// Gets the item in the collection at the specified index. 00241 /// 00242 /// \param index 00243 /// The index of the item in the collection. The index is 0 based. 00244 /// 00245 /// \return 00246 /// Returns an instance of a the collected item. 00247 /// Throws an instance of Exception if the index is out of range or an error occurs. 00248 /// 00249 __property NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* get_RealTypeItem(System::Int32 index); 00250 00251 /// \brief 00252 /// Sets the value of the item at the specified index 00253 /// 00254 /// \param index 00255 /// Input index of the item to set. 00256 /// 00257 /// \param value 00258 /// Input the value of the item 00259 /// 00260 __property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value); 00261 00262 /// \brief 00263 /// Gets an item in the collection. 00264 /// 00265 /// \param index 00266 /// Input index of the item to retrieve. 00267 /// 00268 /// \return 00269 /// Returns the item at the specified index 00270 /// 00271 __property NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* get_Item(System::Int32 index); 00272 00273 /// \brief 00274 /// Sets the value of the item at the specified index 00275 /// 00276 /// \param index 00277 /// Input index of the item to set. 00278 /// 00279 /// \param value 00280 /// Input the value of the item 00281 /// 00282 __property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value); 00283 00284 /// \cond DOXYGEN-IGNORE 00285 protected: 00286 System::Void ReleaseUnmanagedObject(); 00287 /// \endcond 00288 }; 00289 00290 END_NAMESPACE_OSGEO_FDO_COMMANDS 00291 00292
| Comments or suggestions? Send us feedback. |