FDO API Reference | Feature Data Objects |
#include <RestrictedNamedCollection.h>
Inherits FdoIDisposable.
Inheritance diagram for FdoRestrictedNamedCollection< BASEOBJ, SUBOBJ, BASECOLLECTION >:
Any class deriving from this template must also defined a:
SUBOBJ* DownCast(BASEOBJ* value )
function, which must cast the member of the base type to the subtype. It is recommended that static_cast be used, when possible, to perform the down cast.
Definition at line 42 of file RestrictedNamedCollection.h.
Public Member Functions | |
virtual FdoInt32 | Add (SUBOBJ *value) |
Adds the specified item to the end of the collection. Returns the index of the newly added item. | |
virtual void | Clear () |
Removes all items from the collection. | |
virtual bool | Contains (const SUBOBJ *value) const |
Returns true if the collection contains the specified item, false otherwise. | |
virtual SUBOBJ * | FindItem (const wchar_t *name) const |
Gets an item by name. | |
virtual const BASECOLLECTION * | GetBaseCollection () |
Returns a read only pointer to the base collection. | |
virtual FdoInt32 | GetCount () const |
Gets the number of items in the collection. | |
virtual SUBOBJ * | GetItem (const wchar_t *name) const |
Gets an item by name. Throws an invalid argument exception if the item is not in this collection. | |
virtual SUBOBJ * | GetItem (FdoInt32 index) const |
Gets the item in the collection at the specified index. Throws an invalid argument exception if the index is out of range. | |
virtual FdoInt32 | IndexOf (const SUBOBJ *value) const |
Returns the index of the specified item in the collection or -1 if the item does not exist. | |
virtual void | Insert (FdoInt32 index, SUBOBJ *value) |
Inserts the specified item at the specified index within the collection. Items following the insertion point are moved down to accommodate the new item. Throws an invalid argument exception if the specified index is out of range. | |
virtual void | Remove (const SUBOBJ *value) |
Removes the specified item from the collection. Throws an invalid argument exception if the item does not exist within the collection. | |
virtual void | RemoveAt (FdoInt32 index) |
Removes the specified item from the collection. Throws an invalid argument exception if the item does not exist within the collection. | |
virtual void | SetItem (FdoInt32 index, SUBOBJ *value) |
Sets the item in the collection at the specified index to the specified value. Throws an invalid argument exception if the index is out of range. | |
Protected Member Functions | |
virtual SUBOBJ * | DownCast (BASEOBJ *value) const =0 |
Downcasts an item from the Base to the SubType. | |
FdoRestrictedNamedCollection (BASECOLLECTION *baseCollection) | |
FdoRestrictedNamedCollection () |
|
Definition at line 45 of file RestrictedNamedCollection.h. |
|
Definition at line 46 of file RestrictedNamedCollection.h. References FDO_SAFE_ADDREF. |
|
Adds the specified item to the end of the collection. Returns the index of the newly added item.
Definition at line 134 of file RestrictedNamedCollection.h. References FdoInt32. |
|
Removes all items from the collection.
Definition at line 163 of file RestrictedNamedCollection.h. |
|
Returns true if the collection contains the specified item, false otherwise.
Definition at line 205 of file RestrictedNamedCollection.h. |
|
Downcasts an item from the Base to the SubType.
Referenced by FdoRestrictedNamedCollection< BASEOBJ, SUBOBJ, BASECOLLECTION >::FindItem(), and FdoRestrictedNamedCollection< BASEOBJ, SUBOBJ, BASECOLLECTION >::GetItem(). |
|
Gets an item by name.
Definition at line 104 of file RestrictedNamedCollection.h. References FdoRestrictedNamedCollection< BASEOBJ, SUBOBJ, BASECOLLECTION >::DownCast(). |
Here is the call graph for this function:
|
Returns a read only pointer to the base collection.
Definition at line 230 of file RestrictedNamedCollection.h. |
|
Gets the number of items in the collection.
Definition at line 59 of file RestrictedNamedCollection.h. References FdoInt32. |
|
Gets an item by name. Throws an invalid argument exception if the item is not in this collection.
Definition at line 88 of file RestrictedNamedCollection.h. References FdoRestrictedNamedCollection< BASEOBJ, SUBOBJ, BASECOLLECTION >::DownCast(). |
Here is the call graph for this function:
|
Gets the item in the collection at the specified index. Throws an invalid argument exception if the index is out of range.
Definition at line 73 of file RestrictedNamedCollection.h. References FdoRestrictedNamedCollection< BASEOBJ, SUBOBJ, BASECOLLECTION >::DownCast(). |
Here is the call graph for this function:
|
Returns the index of the specified item in the collection or -1 if the item does not exist.
Definition at line 219 of file RestrictedNamedCollection.h. References FdoInt32. |
|
Inserts the specified item at the specified index within the collection. Items following the insertion point are moved down to accommodate the new item. Throws an invalid argument exception if the specified index is out of range.
Definition at line 152 of file RestrictedNamedCollection.h. |
|
Removes the specified item from the collection. Throws an invalid argument exception if the item does not exist within the collection.
Definition at line 177 of file RestrictedNamedCollection.h. |
|
Removes the specified item from the collection. Throws an invalid argument exception if the item does not exist within the collection.
Definition at line 191 of file RestrictedNamedCollection.h. |
|
Sets the item in the collection at the specified index to the specified value. Throws an invalid argument exception if the index is out of range.
Definition at line 120 of file RestrictedNamedCollection.h. |
Comments or suggestions? Send us feedback. |