Mp7Jrs  2.7.1
IMp7JrsHierarchicalSummaryType_components_CollectionType Class Reference

Generated interface IMp7JrsHierarchicalSummaryType_components_CollectionType for collection Mp7JrsHierarchicalSummaryType_components_CollectionType
Located at: mpeg7-v2.xsd, line 7374
Item type: HierarchicalSummaryType_components_LocalType (Enumeration)
More...

Inherits Mp7JrsNode.

Inherited by Mp7JrsHierarchicalSummaryType_components_CollectionType.

Public Member Functions

virtual void Initialize (unsigned int maxElems)=0
 Initializes the collection.
virtual void addElement (const Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration &toAdd, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Adds a new element to the collection.
virtual void setElementAt (const Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration &toSet, unsigned int setAt, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Sets the element at the given position in the collection.
virtual void insertElementAt (const Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration &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 Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration &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
Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration 
elementAt (unsigned int getAt) const =0
 Gets the element at the given position.
virtual
Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration 
elementAt (unsigned int getAt)=0
 Gets the element at the given position.
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 Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration &toCheck) const =0
 Get the position of the specified element.
- Public Member Functions inherited from Mp7JrsNode
const char * GetTypeName () const
 Get class type name as string.
const unsigned int GetClassId () const
 Get the class ID of this node (i.e.
void SetContentName (XMLCh *contentname)
 Set the content name of this node.
const XMLCh * GetContentName () const
 Get the content name of this node.
virtual XMLCh * ToText () const =0
 Convert the content to string.
virtual bool Parse (const XMLCh *const txt)=0
 Parse the content of this type.
virtual bool ContentFromString (const XMLCh *const txt)
 Parse the content from a string.
virtual XMLCh * ContentToString () const
virtual void Serialize (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *parent, XERCES_CPP_NAMESPACE_QUALIFIER DOMElement **newElem=NULL)=0
 Serialialize this object to a DOM tree.
virtual bool Deserialize (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *parent, XERCES_CPP_NAMESPACE_QUALIFIER DOMElement **current)=0
 Deserialize this object from a DOM tree.
virtual Mp7JrsNodePtr CreateChild (const XMLCh *const elementname, const XMLCh *const xsitype)
virtual XMLCh * GetXPath () const
 Get the absolute XPath expression describing this node.
Mp7JrsNodePtr NodeFromXPath (const char *xpath) const
 Get the node represented by this xpath.
virtual Mp7JrsNodePtr NodeFromXPath (const XMLCh *xpath) const
Mp7JrsNodeEnum GetOrCreateFromXPath (const char *xpath, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT, Mp7JrsXPathCreation flag=MP7JRS_FORCECREATE)
 Get the node(s) represented by this xpath.
virtual Mp7JrsNodeEnum GetOrCreateFromXPath (const XMLCh *xpath, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT, Mp7JrsXPathCreation flag=MP7JRS_FORCECREATE, Mp7JrsXPathParseContext *context=NULL)
Mp7JrsNodeEnum GetFromXPath (const char *xpath)
 The same like GetOrCreateFromXPath() just read only.
Mp7JrsNodeEnum GetFromXPath (const XMLCh *xpath)
 The same like GetOrCreateFromXPath() just read only.
virtual Mp7JrsNodePtr GetParent () const
 Get the parent of the node.
void SetParent (const Mp7JrsNodePtr &new_parent)
virtual bool Lock (Mp7JrsClientID id, bool receiveNotification=true)
 Request to lock this node for any operation.
virtual bool Lock4Add (Mp7JrsClientID id, bool receiveNotification=true)
 Request to lock this node for add or insert.
virtual void Unlock (Mp7JrsClientID id)
 Unlock this node.
virtual void Register (Mp7JrsClientID id, Mp7JrsNotificationAction action, bool subtree=false)
 Register to receive notifications from this node.
virtual void Unregister (Mp7JrsClientID id, Mp7JrsNotificationAction action)
 Unregister from receiving notifications from this node.

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 IMp7JrsHierarchicalSummaryType_components_CollectionType for collection Mp7JrsHierarchicalSummaryType_components_CollectionType
Located at: mpeg7-v2.xsd, line 7374
Item type: HierarchicalSummaryType_components_LocalType (Enumeration)

Member Function Documentation

virtual void IMp7JrsHierarchicalSummaryType_components_CollectionType::addElement ( const Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration &  toAdd,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Adds a new element to the collection.

Parameters
toAddElement to be added.
virtual bool IMp7JrsHierarchicalSummaryType_components_CollectionType::containsElement ( const Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration &  toCheck)
pure virtual

Check whether the collection contains the given element.

Parameters
toCheckElement to be checked for.
Returns
True if the element is in the collection, false otherwise.
virtual unsigned int IMp7JrsHierarchicalSummaryType_components_CollectionType::curCapacity ( ) const
pure virtual

Get the current capacity of the collection.

Returns
The number of elements for which memory has been allocated.
virtual const Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration IMp7JrsHierarchicalSummaryType_components_CollectionType::elementAt ( unsigned int  getAt) const
pure virtual

Gets the element at the given position.

Parameters
Positionof the element to be retrieved.
Returns
the given element.
virtual Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration IMp7JrsHierarchicalSummaryType_components_CollectionType::elementAt ( unsigned int  getAt)
pure virtual

Gets the element at the given position.

Parameters
Positionof the element to be retrieved.
Returns
The given element.
virtual int IMp7JrsHierarchicalSummaryType_components_CollectionType::elementIndexOf ( const Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration &  toCheck) const
pure virtual

Get the position of the specified element.

Parameters
toCheckElement to be found in the collection.
Returns
The position of the specified element or -1 if the element has not been found.
virtual void IMp7JrsHierarchicalSummaryType_components_CollectionType::ensureExtraCapacity ( unsigned int  length)
pure virtual

Allocate additional memory for the speciifed number of elements.

Parameters
lengthNumber of elements to allcate memory for.
virtual void IMp7JrsHierarchicalSummaryType_components_CollectionType::Initialize ( unsigned int  maxElems)
pure virtual

Initializes the collection.

Parameters
maxElemsNumber of elements for which memory is initially allocated.
adoptElemsif true, the collection is responsible for deallocating the memory used by its elements. if false, the application has to deallocate the collection elements.
virtual void IMp7JrsHierarchicalSummaryType_components_CollectionType::insertElementAt ( const Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration &  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.
insertAtPosition where the element will be inserted.
virtual void IMp7JrsHierarchicalSummaryType_components_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.
virtual void IMp7JrsHierarchicalSummaryType_components_CollectionType::setElementAt ( const Mp7JrsHierarchicalSummaryType_components_LocalType::Enumeration &  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.
setAtPosition of the element which shall be set.
virtual unsigned int IMp7JrsHierarchicalSummaryType_components_CollectionType::size ( ) const
pure virtual

Get the size of the collection.

Returns
The current number of elements in the collection.