FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoPhysicalElementMappingCollection< OBJ > Class Template Reference

#include <PhysicalElementMappingCollection.h>

Inherits FdoNamedCollection< OBJ, FdoCommandException >.

Inheritance diagram for FdoPhysicalElementMappingCollection< OBJ >:

[legend]
List of all members.

Detailed Description

template<class OBJ>
class FdoPhysicalElementMappingCollection< OBJ >

FdoPhysicalElementMappingCollection is an abstract template class that is used to define collections of Physical Schema Mapping elements.

Definition at line 34 of file PhysicalElementMappingCollection.h.


Public Member Functions

virtual FdoInt32 Add (OBJ *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 void Insert (FdoInt32 index, OBJ *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 OBJ *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, OBJ *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

 FdoPhysicalElementMappingCollection (FdoPhysicalElementMapping *parent)
 FdoPhysicalElementMappingCollection ()
 DOXYGEN-IGNORE
virtual ~FdoPhysicalElementMappingCollection ()

Protected Attributes

FdoPhysicalElementMappingm_parent
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

template<class OBJ>
FdoPhysicalElementMappingCollection< OBJ >::FdoPhysicalElementMappingCollection  )  [inline, protected]
 

DOXYGEN-IGNORE

Definition at line 39 of file PhysicalElementMappingCollection.h.

template<class OBJ>
FdoPhysicalElementMappingCollection< OBJ >::FdoPhysicalElementMappingCollection FdoPhysicalElementMapping parent  )  [inline, protected]
 

Definition at line 44 of file PhysicalElementMappingCollection.h.

template<class OBJ>
virtual FdoPhysicalElementMappingCollection< OBJ >::~FdoPhysicalElementMappingCollection  )  [inline, protected, virtual]
 

Definition at line 49 of file PhysicalElementMappingCollection.h.


Member Function Documentation

template<class OBJ>
virtual FdoInt32 FdoPhysicalElementMappingCollection< OBJ >::Add OBJ *  value  )  [inline, virtual]
 

Adds the specified item to the end of the collection. Returns the index of the newly added item.

Parameters:
value Input value
Returns:
Returns the index of the newly added item

Reimplemented from FdoNamedCollection< OBJ, FdoCommandException >.

Definition at line 128 of file PhysicalElementMappingCollection.h.

template<class OBJ>
virtual void FdoPhysicalElementMappingCollection< OBJ >::Clear  )  [inline, virtual]
 

Removes all items from the collection.

Returns:
Returns nothing

Reimplemented from FdoNamedCollection< OBJ, FdoCommandException >.

Definition at line 185 of file PhysicalElementMappingCollection.h.

template<class OBJ>
virtual void FdoPhysicalElementMappingCollection< OBJ >::Insert FdoInt32  index,
OBJ *  value
[inline, virtual]
 

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.

Parameters:
index Input index
value Input value
Returns:
Returns nothing

Reimplemented from FdoNamedCollection< OBJ, FdoCommandException >.

Definition at line 160 of file PhysicalElementMappingCollection.h.

template<class OBJ>
virtual void FdoPhysicalElementMappingCollection< OBJ >::Remove const OBJ *  value  )  [inline, virtual]
 

Removes the specified item from the collection. Throws an invalid argument exception if the item does not exist within the collection.

Parameters:
value Input value
Returns:
Returns nothing

Reimplemented from FdoNamedCollection< OBJ, FdoCommandException >.

Definition at line 216 of file PhysicalElementMappingCollection.h.

template<class OBJ>
virtual void FdoPhysicalElementMappingCollection< OBJ >::RemoveAt FdoInt32  index  )  [inline, virtual]
 

Removes the specified item from the collection. Throws an invalid argument exception if the item does not exist within the collection.

Parameters:
index Input index
Returns:
Returns nothing

Reimplemented from FdoNamedCollection< OBJ, FdoCommandException >.

Definition at line 246 of file PhysicalElementMappingCollection.h.

template<class OBJ>
virtual void FdoPhysicalElementMappingCollection< OBJ >::SetItem FdoInt32  index,
OBJ *  value
[inline, virtual]
 

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.

Parameters:
index Input index
value Input value
Returns:
Returns nothing

Reimplemented from FdoNamedCollection< OBJ, FdoCommandException >.

Definition at line 85 of file PhysicalElementMappingCollection.h.


Member Data Documentation

template<class OBJ>
FdoPhysicalElementMapping* FdoPhysicalElementMappingCollection< OBJ >::m_parent [protected]
 

DOXYGEN-IGNORE

m_parent is a non-refcounted reference, to avoid circular references that prevent elements from being freed.

Definition at line 273 of file PhysicalElementMappingCollection.h.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.