Mp7Jrs  2.7.1
IMp7JrsRegionLocatorType_Box_LocalType Class Reference

Generated interface IMp7JrsRegionLocatorType_Box_LocalType for class Mp7JrsRegionLocatorType_Box_LocalType
Located at: mpeg7-v2.xsd, line 1272
Classified: Class
Derived from: BoxListType (Class)
More...

Inherits IMp7JrsBoxListType.

Inherited by Mp7JrsRegionLocatorType_Box_LocalType.

Public Member Functions

virtual Mp7JrsPtr
< Mp7JrsintegerVector > 
GetBaseCollection () const =0
 Retrieves the base collection of Mp7JrsIntegerMatrixType (Inherited from Mp7JrsIntegerMatrixType)
virtual void Initialize (unsigned int maxElems)=0
 Initializes the collection.
virtual void addElement (const int &toAdd, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Adds a new element to the collection.
virtual void setElementAt (const int &toSet, unsigned int setAt, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Sets the element at the given position in the collection.
virtual void insertElementAt (const int &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 int &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 int elementAt (unsigned int getAt) const =0
 Gets a constant pointer to the element at the given position.
virtual int elementAt (unsigned int getAt)=0
 Gets a pointer to 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 int &toCheck) const =0
 Get the position of the specified element.
virtual bool GetunlocatedRegion () const =0
 Get unlocatedRegion attribute.
virtual bool ExistunlocatedRegion () const =0
 Get unlocatedRegion attribute validity information.
virtual void SetunlocatedRegion (bool item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set unlocatedRegion attribute.
virtual void InvalidateunlocatedRegion ()=0
 Invalidate unlocatedRegion attribute.
virtual Mp7Jrsdim_LocalPtr Getdim () const =0
 Get dim attribute.
virtual void Setdim (const Mp7Jrsdim_LocalPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set dim attribute.
virtual Mp7JrsNodeEnum GetOrCreateFromXPath (const XMLCh *xpath, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT, Mp7JrsXPathCreation flag=MP7JRS_FORCECREATE, Mp7JrsXPathParseContext *context=NULL)=0
 Gets or creates Mp7JrsNodePtr child elements of RegionLocatorType_Box_LocalType.

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 IMp7JrsRegionLocatorType_Box_LocalType for class Mp7JrsRegionLocatorType_Box_LocalType
Located at: mpeg7-v2.xsd, line 1272
Classified: Class
Derived from: BoxListType (Class)

Member Function Documentation

virtual void IMp7JrsRegionLocatorType_Box_LocalType::addElement ( const int &  toAdd,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Adds a new element to the collection.

(Inherited from Mp7JrsintegerVector)

Parameters
toAddElement to be added. Default element type: integer

Implements IMp7JrsBoxListType.

virtual bool IMp7JrsRegionLocatorType_Box_LocalType::containsElement ( const int &  toCheck)
pure virtual

Check whether the collection contains the given element.

(Inherited from Mp7JrsintegerVector)

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

Implements IMp7JrsBoxListType.

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

Get the current capacity of the collection.

(Inherited from Mp7JrsintegerVector)

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

Implements IMp7JrsBoxListType.

virtual const int IMp7JrsRegionLocatorType_Box_LocalType::elementAt ( unsigned int  getAt) const
pure virtual

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

(Inherited from Mp7JrsintegerVector)

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: integer.

Implements IMp7JrsBoxListType.

virtual int IMp7JrsRegionLocatorType_Box_LocalType::elementAt ( unsigned int  getAt)
pure virtual

Gets a pointer to the element at the given position.

(Inherited from Mp7JrsintegerVector)

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: integer.

Implements IMp7JrsBoxListType.

virtual int IMp7JrsRegionLocatorType_Box_LocalType::elementIndexOf ( const int &  toCheck) const
pure virtual

Get the position of the specified element.

(Inherited from Mp7JrsintegerVector)

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

Implements IMp7JrsBoxListType.

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

Allocate additional memory for the speciifed number of elements.

(Inherited from Mp7JrsintegerVector)

Parameters
lengthNumber of elements to allocate memory for.

Implements IMp7JrsBoxListType.

virtual bool IMp7JrsRegionLocatorType_Box_LocalType::ExistunlocatedRegion ( ) const
pure virtual

Get unlocatedRegion attribute validity information.

Returns
true if attribute value is valid, false if not.
virtual Mp7JrsPtr< Mp7JrsintegerVector > IMp7JrsRegionLocatorType_Box_LocalType::GetBaseCollection ( ) const
pure virtual

Retrieves the base collection of Mp7JrsIntegerMatrixType (Inherited from Mp7JrsIntegerMatrixType)

Returns
Mp7JrsPtr< Mp7JrsintegerVector >

Implements IMp7JrsBoxListType.

virtual Mp7Jrsdim_LocalPtr IMp7JrsRegionLocatorType_Box_LocalType::Getdim ( ) const
pure virtual

Get dim attribute.


(Inherited from Mp7JrsIntegerMatrixType)

Returns
Mp7Jrsdim_LocalPtr

Implements IMp7JrsBoxListType.

virtual Mp7JrsNodeEnum IMp7JrsRegionLocatorType_Box_LocalType::GetOrCreateFromXPath ( const XMLCh *  xpath,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT,
Mp7JrsXPathCreation  flag = MP7JRS_FORCECREATE,
Mp7JrsXPathParseContext *  context = NULL 
)
pure virtual

Gets or creates Mp7JrsNodePtr child elements of RegionLocatorType_Box_LocalType.

Currently just supports rudimentary XPath expressions as RegionLocatorType_Box_LocalType contains no child elements of type "Mp7JrsNodePtr" at all.

Supported XPath expressions for GetOrCreateFromXPath

/
  • Get the root of this node.
..
  • This feature is experimental.
  • Get the ancestor (parent node), or an empty list if the node already is the root node.
Parameters
xpaththe xpath expression to get or create.
clientthe ID in case of locking.
Returns
the appropriate subelement node list. Can be empty in case of incompatible name/type/index settings.

Implements IMp7JrsBoxListType.

virtual bool IMp7JrsRegionLocatorType_Box_LocalType::GetunlocatedRegion ( ) const
pure virtual

Get unlocatedRegion attribute.

Returns
bool
virtual void IMp7JrsRegionLocatorType_Box_LocalType::Initialize ( unsigned int  maxElems)
pure virtual

Initializes the collection.

(Inherited from Mp7JrsintegerVector)

Parameters
maxElemsNumber of elements for which memory is initially allocated.

Implements IMp7JrsBoxListType.

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

Inserts the element at the given position in the collection.

(Inherited from Mp7JrsintegerVector)

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

Implements IMp7JrsBoxListType.

virtual void IMp7JrsRegionLocatorType_Box_LocalType::InvalidateunlocatedRegion ( )
pure virtual

Invalidate unlocatedRegion attribute.

(Validate it again by setting a value)

virtual void IMp7JrsRegionLocatorType_Box_LocalType::removeAllElements ( Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT)
pure virtual

Removes all elements from the collection.

(Inherited from Mp7JrsintegerVector)

Implements IMp7JrsBoxListType.

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

Removes the specified element from the collection.

(Inherited from Mp7JrsintegerVector)

Parameters
removeAtPosition of the element to be removed.

Implements IMp7JrsBoxListType.

virtual void IMp7JrsRegionLocatorType_Box_LocalType::Setdim ( const Mp7Jrsdim_LocalPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set dim attribute.


(Inherited from Mp7JrsIntegerMatrixType)

Parameters
itemconst Mp7Jrsdim_LocalPtr &

Implements IMp7JrsBoxListType.

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

Sets the element at the given position in the collection.

(Inherited from Mp7JrsintegerVector)

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

Implements IMp7JrsBoxListType.

virtual void IMp7JrsRegionLocatorType_Box_LocalType::SetunlocatedRegion ( bool  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set unlocatedRegion attribute.

Parameters
itembool
virtual unsigned int IMp7JrsRegionLocatorType_Box_LocalType::size ( ) const
pure virtual

Get the size of the collection.

(Inherited from Mp7JrsintegerVector)

Returns
The current number of elements in the collection.

Implements IMp7JrsBoxListType.