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

FdoReadOnlyCollection< OBJ, BASE, EXC > Class Template Reference

#include <ReadOnlyCollection.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoReadOnlyCollection< OBJ, BASE, EXC >:

[legend]
List of all members.

Detailed Description

template<class OBJ, class BASE, class EXC>
class FdoReadOnlyCollection< OBJ, BASE, EXC >

FdoReadOnlyCollection is an abstract template class used to define a collection that can not be modified after it is constructed, i.e. provides read-only access.

Definition at line 30 of file ReadOnlyCollection.h.


Public Member Functions

virtual FDO_API bool Contains (const OBJ *value)
 Returns true if the collection contains the specified item, false otherwise.
virtual FDO_API FdoInt32 GetCount ()
 Gets the number of items in the collection.
virtual FDO_API OBJ * GetItem (FdoString *name)
 Gets the item in the collection with the specified name. Throws an invalid argument exception if an item with the specified name does not exist in the collection.
virtual FDO_API OBJ * GetItem (FdoInt32 index)
 Gets the item in the collection at the specified index. Throws an invalid argument exception if the index is out of range.
virtual FDO_API FdoInt32 IndexOf (const OBJ *value)
 Returns the index of the specified item in the collection or -1 if the item does not exist.

Protected Member Functions

FDO_API FdoReadOnlyCollection ()
void SetBaseCollection (BASE *base)
virtual FDO_API ~FdoReadOnlyCollection ()

Constructor & Destructor Documentation

template<class OBJ, class BASE, class EXC>
FDO_API FdoReadOnlyCollection< OBJ, BASE, EXC >::FdoReadOnlyCollection  )  [inline, protected]
 

Definition at line 33 of file ReadOnlyCollection.h.

template<class OBJ, class BASE, class EXC>
virtual FDO_API FdoReadOnlyCollection< OBJ, BASE, EXC >::~FdoReadOnlyCollection  )  [inline, protected, virtual]
 

Definition at line 37 of file ReadOnlyCollection.h.


Member Function Documentation

template<class OBJ, class BASE, class EXC>
virtual FDO_API bool FdoReadOnlyCollection< OBJ, BASE, EXC >::Contains const OBJ *  value  )  [inline, virtual]
 

Returns true if the collection contains the specified item, false otherwise.

Parameters:
value Input value
Returns:
Returns true if the collection contains the specified item, false otherwise

Definition at line 114 of file ReadOnlyCollection.h.

template<class OBJ, class BASE, class EXC>
virtual FDO_API FdoInt32 FdoReadOnlyCollection< OBJ, BASE, EXC >::GetCount  )  [inline, virtual]
 

Gets the number of items in the collection.

Returns:
Returns number of items in the collection

Reimplemented in FdoReadOnlyDataPropertyDefinitionCollection, and FdoReadOnlyPropertyDefinitionCollection.

Definition at line 55 of file ReadOnlyCollection.h.

Referenced by FdoReadOnlyCollection< FdoArgumentDefinition, FdoArgumentDefinitionCollection, FdoConnectionException >::GetItem().

template<class OBJ, class BASE, class EXC>
virtual FDO_API OBJ* FdoReadOnlyCollection< OBJ, BASE, EXC >::GetItem FdoString name  )  [inline, virtual]
 

Gets the item in the collection with the specified name. Throws an invalid argument exception if an item with the specified name does not exist in the collection.

Parameters:
name Input name to find
Returns:
Returns the item in the collection with the specified name

Reimplemented in FdoReadOnlyDataPropertyDefinitionCollection, and FdoReadOnlyPropertyDefinitionCollection.

Definition at line 89 of file ReadOnlyCollection.h.

template<class OBJ, class BASE, class EXC>
virtual FDO_API OBJ* FdoReadOnlyCollection< OBJ, BASE, EXC >::GetItem FdoInt32  index  )  [inline, virtual]
 

Gets the item in the collection at the specified index. Throws an invalid argument exception if the index is out of range.

Parameters:
index Input index
Returns:
Returns the item in the collection at the specified index

Reimplemented in FdoReadOnlyDataPropertyDefinitionCollection, and FdoReadOnlyPropertyDefinitionCollection.

Definition at line 72 of file ReadOnlyCollection.h.

Referenced by FdoReadOnlyCollection< FdoArgumentDefinition, FdoArgumentDefinitionCollection, FdoConnectionException >::GetItem().

template<class OBJ, class BASE, class EXC>
virtual FDO_API FdoInt32 FdoReadOnlyCollection< OBJ, BASE, EXC >::IndexOf const OBJ *  value  )  [inline, virtual]
 

Returns the index of the specified item in the collection or -1 if the item does not exist.

Parameters:
value Input value
Returns:
Returns the index of the specified item in the collection or -1 if the item does not exist

Definition at line 131 of file ReadOnlyCollection.h.

template<class OBJ, class BASE, class EXC>
void FdoReadOnlyCollection< OBJ, BASE, EXC >::SetBaseCollection BASE *  base  )  [inline, protected]
 

Definition at line 42 of file ReadOnlyCollection.h.


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