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

FdoDataPropertyDefinitionCollection Class Reference

#include <DataPropertyDefinitionCollection.h>

Inherits FdoSchemaCollection< FdoDataPropertyDefinition >.

Inheritance diagram for FdoDataPropertyDefinitionCollection:

[legend]
List of all members.

Detailed Description

The FdoDataPropertyDefinitionCollection class represents a collection of FdoDataPropertyDefinition objects.

Definition at line 33 of file DataPropertyDefinitionCollection.h.


Public Member Functions

virtual FDO_API FdoInt32 Add (FdoDataPropertyDefinition *value)
 Adds the specified item to the end of the collection. Returns the index of the newly added item.
virtual FDO_API void Insert (FdoInt32 index, FdoDataPropertyDefinition *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 FDO_API void SetItem (FdoInt32 index, FdoDataPropertyDefinition *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.

Static Public Member Functions

FDO_API FdoDataPropertyDefinitionCollectionCreate (FdoSchemaElement *parent)
 Constructs an instance of an FdoDataPropertyDefinitionCollection using the specified argument.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoDataPropertyDefinitionCollection (FdoSchemaElement *parent)
 Constructs an instance of a DataPropertyDefinitionCollection using the specified argument.
 FdoDataPropertyDefinitionCollection ()
 DOXYGEN-IGNORE
virtual ~FdoDataPropertyDefinitionCollection ()

Friends

class FdoAssociationPropertyDefinition
class FdoClassDefinition

Constructor & Destructor Documentation

FdoDataPropertyDefinitionCollection::FdoDataPropertyDefinitionCollection  )  [inline, protected]
 

DOXYGEN-IGNORE

Definition at line 42 of file DataPropertyDefinitionCollection.h.

FdoDataPropertyDefinitionCollection::FdoDataPropertyDefinitionCollection FdoSchemaElement parent  )  [inline, protected]
 

Constructs an instance of a DataPropertyDefinitionCollection using the specified argument.

DataPropertyCollection is only used for identityProperties, which only reference items in the Properties collection. Since it doesn't own these items, the parent shouldn't be set when adding to this collection.

Definition at line 46 of file DataPropertyDefinitionCollection.h.

virtual FdoDataPropertyDefinitionCollection::~FdoDataPropertyDefinitionCollection  )  [inline, protected, virtual]
 

Definition at line 54 of file DataPropertyDefinitionCollection.h.


Member Function Documentation

virtual FDO_API FdoInt32 FdoDataPropertyDefinitionCollection::Add FdoDataPropertyDefinition value  )  [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 FdoSchemaCollection< FdoDataPropertyDefinition >.

FDO_API FdoDataPropertyDefinitionCollection* FdoDataPropertyDefinitionCollection::Create FdoSchemaElement parent  )  [static]
 

Constructs an instance of an FdoDataPropertyDefinitionCollection using the specified argument.

Parameters:
parent Input parent
Returns:
Returns FdoDataPropertyDefinitionCollection

virtual void FdoDataPropertyDefinitionCollection::Dispose  )  [inline, protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

Definition at line 58 of file DataPropertyDefinitionCollection.h.

virtual FDO_API void FdoDataPropertyDefinitionCollection::Insert FdoInt32  index,
FdoDataPropertyDefinition value
[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 FdoSchemaCollection< FdoDataPropertyDefinition >.

virtual FDO_API void FdoDataPropertyDefinitionCollection::SetItem FdoInt32  index,
FdoDataPropertyDefinition value
[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 FdoSchemaCollection< FdoDataPropertyDefinition >.


Friends And Related Function Documentation

friend class FdoAssociationPropertyDefinition [friend]
 

Definition at line 36 of file DataPropertyDefinitionCollection.h.

friend class FdoClassDefinition [friend]
 

Definition at line 35 of file DataPropertyDefinitionCollection.h.


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