Mp7Jrs  2.7.1
IMp7JrsCompleteDescriptionType_Relationships_CollectionType Class Reference

Generated interface IMp7JrsCompleteDescriptionType_Relationships_CollectionType for collection Mp7JrsCompleteDescriptionType_Relationships_CollectionType
Located at: mpeg7-v2.xsd, line 2792
Item type: GraphType (Class)
More...

Inherits Mp7JrsNodeCollection.

Inherited by Mp7JrsCompleteDescriptionType_Relationships_CollectionType.

Public Member Functions

virtual void Initialize (unsigned int maxElems)=0
 Initializes the collection.
virtual void addElement (const Mp7JrsNodePtr &toAdd, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Adds a new element to the collection.
virtual void setElementAt (const Mp7JrsNodePtr &toSet, unsigned int setAt, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Sets the element at the given position in the collection.
virtual void insertElementAt (const Mp7JrsNodePtr &toInsert, unsigned int insertAt, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Inserts the element at the given position in the collection.
virtual void removeAllElements (Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Removes all elements from the collection.
virtual void removeElementAt (unsigned int removeAt, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Removes the specified element from the collection.
virtual bool containsElement (const Mp7JrsNodePtr &toCheck)=0
 Check whether the collection contains the given element.
virtual unsigned int curCapacity () const =0
 Get the current capacity of the collection.
virtual const Mp7JrsNodePtr elementAt (unsigned int getAt) const =0
 Gets a constant pointer to the element at the given position.
virtual Mp7JrsNodePtr elementAt (unsigned int getAt)=0
 Gets a pointer to the element at the given position.
virtual Mp7JrsNodeEnum GetElementsOfType (unsigned int id) const =0
 Gets an enumeration of all contained elements of the specified type.
virtual Mp7JrsNodeEnum GetElements () const =0
 Gets an enumeration of all contained elements.
virtual unsigned int size () const =0
 Get the size of the collection.
virtual void ensureExtraCapacity (unsigned int length)=0
 Allocate additional memory for the speciifed number of elements.
virtual int elementIndexOf (const Mp7JrsNodePtr &toCheck) const =0
 Get the position of the specified element.

Additional Inherited Members

- Public Attributes inherited from Mp7JrsNode
bool UseTypeAttribute
 Set if xsi:type attribute shall be written when serialising this node (useful for elements having abstract types).
Mp7JrsWeakPtr< Mp7JrsNode > m_myself
- Protected Member Functions inherited from Mp7JrsNode
Mp7JrsNodePtr UpwardWithXPath (const XMLCh *xpath) const
virtual void DeepCopy (const Mp7JrsNodePtr &original)=0
virtual bool IsLocked (Mp7JrsClientID id)
virtual Mp7JrsNodeEnum GetAllChildElements () const =0
virtual Mp7JrsNodePtr GetBaseRoot ()
virtual const Mp7JrsNodePtr GetBaseRoot () const
- Protected Attributes inherited from Mp7JrsNode
Mp7JrsClientID lockOwner
unsigned int m_ClassId
XMLCh * m_ContentName
Mp7JrsWeakPtr< Mp7JrsNode > m_Parent

Detailed Description

Generated interface IMp7JrsCompleteDescriptionType_Relationships_CollectionType for collection Mp7JrsCompleteDescriptionType_Relationships_CollectionType
Located at: mpeg7-v2.xsd, line 2792
Item type: GraphType (Class)

Member Function Documentation

virtual void IMp7JrsCompleteDescriptionType_Relationships_CollectionType::addElement ( const Mp7JrsNodePtr &  toAdd,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Adds a new element to the collection.

Parameters
toAddElement to be added. Default element type: IMp7JrsGraphType

Implements Mp7JrsNodeCollection.

virtual bool IMp7JrsCompleteDescriptionType_Relationships_CollectionType::containsElement ( const Mp7JrsNodePtr &  toCheck)
pure virtual

Check whether the collection contains the given element.

Parameters
toCheckElement to be checked for. Default element type: IMp7JrsGraphType
Returns
True if the element is in the collection, false otherwise.

Implements Mp7JrsNodeCollection.

virtual unsigned int IMp7JrsCompleteDescriptionType_Relationships_CollectionType::curCapacity ( ) const
pure virtual

Get the current capacity of the collection.

Returns
The number of elements for which memory has been allocated.

Implements Mp7JrsNodeCollection.

virtual const Mp7JrsNodePtr IMp7JrsCompleteDescriptionType_Relationships_CollectionType::elementAt ( unsigned int  getAt) const
pure virtual

Gets a constant pointer to the element at the given position.

Parameters
Positionof the element to be retrieved.
Returns
A pointer to the given element or a null pointer if there is no element at the specified position. Default element type: Mp7JrsGraphType.

Implements Mp7JrsNodeCollection.

virtual Mp7JrsNodePtr IMp7JrsCompleteDescriptionType_Relationships_CollectionType::elementAt ( unsigned int  getAt)
pure virtual

Gets a pointer to the element at the given position.

Parameters
Positionof the element to be retrieved.
Returns
A pointer to the given element or a null pointer if there is no element at the specified position. Default element type: Mp7JrsGraphType.

Implements Mp7JrsNodeCollection.

virtual int IMp7JrsCompleteDescriptionType_Relationships_CollectionType::elementIndexOf ( const Mp7JrsNodePtr &  toCheck) const
pure virtual

Get the position of the specified element.

Parameters
toCheckElement to be found in the collection. Default element type: IMp7JrsGraphType
Returns
The position of the specified element or -1 if the element has not been found.

Implements Mp7JrsNodeCollection.

virtual void IMp7JrsCompleteDescriptionType_Relationships_CollectionType::ensureExtraCapacity ( unsigned int  length)
pure virtual

Allocate additional memory for the speciifed number of elements.

Parameters
lengthNumber of elements to allocate memory for.

Implements Mp7JrsNodeCollection.

virtual Mp7JrsNodeEnum IMp7JrsCompleteDescriptionType_Relationships_CollectionType::GetElements ( ) const
pure virtual

Gets an enumeration of all contained elements.

Returns
A (possibly empty) enumeration of all contained elements.

Implements Mp7JrsNodeCollection.

virtual Mp7JrsNodeEnum IMp7JrsCompleteDescriptionType_Relationships_CollectionType::GetElementsOfType ( unsigned int  id) const
pure virtual

Gets an enumeration of all contained elements of the specified type.

Parameters
Theclass id of the wanted elements.
Returns
A (possibly empty) enumeration of all contained elements of type id.

Implements Mp7JrsNodeCollection.

virtual void IMp7JrsCompleteDescriptionType_Relationships_CollectionType::Initialize ( unsigned int  maxElems)
pure virtual

Initializes the collection.

Parameters
maxElemsNumber of elements for which memory is initially allocated.

Implements Mp7JrsNodeCollection.

virtual void IMp7JrsCompleteDescriptionType_Relationships_CollectionType::insertElementAt ( const Mp7JrsNodePtr &  toInsert,
unsigned int  insertAt,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Inserts the element at the given position in the collection.

Parameters
toInsertElement to be inserted. Default element type: IMp7JrsGraphType
insertAtPosition where the element will be inserted.

Implements Mp7JrsNodeCollection.

virtual void IMp7JrsCompleteDescriptionType_Relationships_CollectionType::removeElementAt ( unsigned int  removeAt,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Removes the specified element from the collection.

Parameters
removeAtPosition of the element to be removed.

Implements Mp7JrsNodeCollection.

virtual void IMp7JrsCompleteDescriptionType_Relationships_CollectionType::setElementAt ( const Mp7JrsNodePtr &  toSet,
unsigned int  setAt,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Sets the element at the given position in the collection.

Parameters
toSetNew value of the element. Default element type: IMp7JrsGraphType
setAtPosition of the element which shall be set.

Implements Mp7JrsNodeCollection.

virtual unsigned int IMp7JrsCompleteDescriptionType_Relationships_CollectionType::size ( ) const
pure virtual

Get the size of the collection.

Returns
The current number of elements in the collection.

Implements Mp7JrsNodeCollection.