Mp7Jrs  2.7.1
IMp7JrsVisualSummaryComponentType Class Reference

Generated interface IMp7JrsVisualSummaryComponentType for class Mp7JrsVisualSummaryComponentType
Located at: mpeg7-v2.xsd, line 7513
Classified: Class
Derived from: DType (Class)
More...

Inherits IMp7JrsDType.

Inherited by Mp7JrsVisualSummaryComponentType.

Public Member Functions

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 VisualSummaryComponentType.
Sequence
virtual Mp7JrsUniqueIDPtr GetVideoSourceID () const =0
 Get VideoSourceID element.
virtual bool IsValidVideoSourceID () const =0
virtual void SetVideoSourceID (const Mp7JrsUniqueIDPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set VideoSourceID element.
virtual void InvalidateVideoSourceID ()=0
 Invalidate VideoSourceID element.
virtual
Mp7JrsTemporalSegmentLocatorPtr 
GetVideoSourceLocator () const =0
 Get VideoSourceLocator element.
virtual bool IsValidVideoSourceLocator () const =0
virtual void SetVideoSourceLocator (const Mp7JrsTemporalSegmentLocatorPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set VideoSourceLocator element.
virtual void InvalidateVideoSourceLocator ()=0
 Invalidate VideoSourceLocator element.
virtual Mp7JrsMediaTimePtr GetComponentSourceTime () const =0
 Get ComponentSourceTime element.
virtual bool IsValidComponentSourceTime () const =0
virtual void SetComponentSourceTime (const Mp7JrsMediaTimePtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set ComponentSourceTime element.
virtual void InvalidateComponentSourceTime ()=0
 Invalidate ComponentSourceTime element.
virtual Mp7JrsImageLocatorPtr GetImageLocator () const =0
 Get ImageLocator element.
virtual bool IsValidImageLocator () const =0
virtual void SetImageLocator (const Mp7JrsImageLocatorPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set ImageLocator element.
virtual void InvalidateImageLocator ()=0
 Invalidate ImageLocator element.
virtual Mp7JrsMediaTimePtr GetSyncTime () const =0
 Get SyncTime element.
virtual bool IsValidSyncTime () const =0
virtual void SetSyncTime (const Mp7JrsMediaTimePtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set SyncTime element.
virtual void InvalidateSyncTime ()=0
 Invalidate SyncTime element.
virtual Mp7JrszeroToOnePtr GetFrameActivity () const =0
 Get FrameActivity element.
virtual bool IsValidFrameActivity () const =0
virtual void SetFrameActivity (const Mp7JrszeroToOnePtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set FrameActivity element.
virtual void InvalidateFrameActivity ()=0
 Invalidate FrameActivity element.
virtual Mp7JrsRegionLocatorPtr GetRegion () const =0
 Get Region element.
virtual bool IsValidRegion () const =0
virtual void SetRegion (const Mp7JrsRegionLocatorPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Region element.
virtual void InvalidateRegion ()=0
 Invalidate Region 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 IMp7JrsVisualSummaryComponentType for class Mp7JrsVisualSummaryComponentType
Located at: mpeg7-v2.xsd, line 7513
Classified: Class
Derived from: DType (Class)

Member Function Documentation

virtual Mp7JrsMediaTimePtr IMp7JrsVisualSummaryComponentType::GetComponentSourceTime ( ) const
pure virtual

Get ComponentSourceTime element.

Returns
Mp7JrsMediaTimePtr
virtual Mp7JrszeroToOnePtr IMp7JrsVisualSummaryComponentType::GetFrameActivity ( ) const
pure virtual

Get FrameActivity element.

Returns
Mp7JrszeroToOnePtr
virtual Mp7JrsImageLocatorPtr IMp7JrsVisualSummaryComponentType::GetImageLocator ( ) const
pure virtual

Get ImageLocator element.

Returns
Mp7JrsImageLocatorPtr
virtual Mp7JrsNodeEnum IMp7JrsVisualSummaryComponentType::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 VisualSummaryComponentType.

Currently this type contains 7 child elements of type "Mp7JrsNodePtr".

  • VideoSourceID
  • VideoSourceLocator
  • ComponentSourceTime
  • ImageLocator
  • SyncTime
  • FrameActivity
  • Region

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.
@A
  • Force creation of a child attribute named A.
  • This is valid only, if the type of attribute is derived from Mp7JrsNodePtr.
  • Evaluating this expression for a plain type like int or string results in an exception.
A
  • Select all child elements named A.
  • In case of no element, create a new one.
  • For collections: all subsequent XPath expressions are applied on all collection items (e.g. A/B query or create, childnodes B of all As).
A[i]
  • Select the ith child element of all A.
  • Please note, that XPath indexes start at 1.
  • If there is no such ith element, try to create a new one at index i.
  • Single elements require i to be 1 otherwise an exception is thrown.
  • For collections, i must not exceed the number of existing items +1 (appending is allowed, filling gaps not).
  • If the index is too high, a MissingElementException is thrown, and you can extract the last valid index. (Example: If a collection contains 2 elements and you are requesting the 4th element).
A[@xsi:type="T"]
  • Select all child elements named A of type T.
  • Currently only typenames without namespace are recognised.
  • If there is no such element, create and append a new one.
A[i][@xsi:type="T"]
  • Select the ith child element named A, which must be of type T.
  • If there is no such element at index i, a new one is created and inserted (appended).
A[@xsi:type="T"][i]
  • Out of all child elements named A of type T, take the ith one.
  • If there is no such element at index i, create and append one.
A[last()]
  • Select the last child element named A.
  • In case of no element, create a new one.
A[last()][@xsi:type="T"]
  • Select the last child element named A, which must be of type T.
  • For collections: in case of no such type, create and append a new one.
  • For single elements: if an element with different type exists, return the empty list.
A[@xsi:type="T"][last()]
  • Out of all child elements named A of type T, take the last one.
  • For collections: in case of no such type, create and append a new one.
  • For single elements: if an element with different type exists, return the empty list.
A[position() > last()]
  • Force creation of a child element named A with its default type.
  • For collections: create and append the default element.
  • For single elements: if any element exists, an exception is thrown.
A[position() > last()][@xsi:type="T"]
  • Force creation of a child element named A of type T.
  • For collections: create and append the element.
  • For single elements: if any element exists, an exception is thrown.
A[@xsi:type="T"][position() > last()]
  • Force creation of a child element named A of type T.
  • Behaves the same way as the previous expression.

Supported XPath expressions for GetFromXPath
The same expressions like GetOrCreateFromXPath plus

A[position() < i]
  • Select all child elements named A at indexes lower than i.
  • i must be greater than -1, otherwise an exception is thrown.
A[position() > i]
  • Select all child elements named A at indexes greater than i.
  • i must be greater than -1, otherwise an exception is thrown.
A[position() > i | position() < j]
  • Select all child elements named A at indexes greater than i and lower than j.
  • i and j must be greater than -1, otherwise an exception is thrown.
  • If i is greater than j then an empty list is returned.

These three expressions can be combined with the @xsi:type attribute to get a more restricted query.

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 IMp7JrsDType.

virtual Mp7JrsRegionLocatorPtr IMp7JrsVisualSummaryComponentType::GetRegion ( ) const
pure virtual

Get Region element.

Returns
Mp7JrsRegionLocatorPtr
virtual Mp7JrsMediaTimePtr IMp7JrsVisualSummaryComponentType::GetSyncTime ( ) const
pure virtual

Get SyncTime element.

Returns
Mp7JrsMediaTimePtr
virtual Mp7JrsUniqueIDPtr IMp7JrsVisualSummaryComponentType::GetVideoSourceID ( ) const
pure virtual

Get VideoSourceID element.

Returns
Mp7JrsUniqueIDPtr
virtual Mp7JrsTemporalSegmentLocatorPtr IMp7JrsVisualSummaryComponentType::GetVideoSourceLocator ( ) const
pure virtual

Get VideoSourceLocator element.

Returns
Mp7JrsTemporalSegmentLocatorPtr
virtual void IMp7JrsVisualSummaryComponentType::InvalidateComponentSourceTime ( )
pure virtual

Invalidate ComponentSourceTime element.

(Validate it again by setting a value)

virtual void IMp7JrsVisualSummaryComponentType::InvalidateFrameActivity ( )
pure virtual

Invalidate FrameActivity element.

(Validate it again by setting a value)

virtual void IMp7JrsVisualSummaryComponentType::InvalidateImageLocator ( )
pure virtual

Invalidate ImageLocator element.

(Validate it again by setting a value)

virtual void IMp7JrsVisualSummaryComponentType::InvalidateRegion ( )
pure virtual

Invalidate Region element.

(Validate it again by setting a value)

virtual void IMp7JrsVisualSummaryComponentType::InvalidateSyncTime ( )
pure virtual

Invalidate SyncTime element.

(Validate it again by setting a value)

virtual void IMp7JrsVisualSummaryComponentType::InvalidateVideoSourceID ( )
pure virtual

Invalidate VideoSourceID element.

(Validate it again by setting a value)

virtual void IMp7JrsVisualSummaryComponentType::InvalidateVideoSourceLocator ( )
pure virtual

Invalidate VideoSourceLocator element.

(Validate it again by setting a value)

virtual void IMp7JrsVisualSummaryComponentType::SetComponentSourceTime ( const Mp7JrsMediaTimePtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set ComponentSourceTime element.

Parameters
itemconst Mp7JrsMediaTimePtr &
virtual void IMp7JrsVisualSummaryComponentType::SetFrameActivity ( const Mp7JrszeroToOnePtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set FrameActivity element.

Parameters
itemconst Mp7JrszeroToOnePtr &
virtual void IMp7JrsVisualSummaryComponentType::SetImageLocator ( const Mp7JrsImageLocatorPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set ImageLocator element.

Parameters
itemconst Mp7JrsImageLocatorPtr &
virtual void IMp7JrsVisualSummaryComponentType::SetRegion ( const Mp7JrsRegionLocatorPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Region element.

Parameters
itemconst Mp7JrsRegionLocatorPtr &
virtual void IMp7JrsVisualSummaryComponentType::SetSyncTime ( const Mp7JrsMediaTimePtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set SyncTime element.

Parameters
itemconst Mp7JrsMediaTimePtr &
virtual void IMp7JrsVisualSummaryComponentType::SetVideoSourceID ( const Mp7JrsUniqueIDPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set VideoSourceID element.

Parameters
itemconst Mp7JrsUniqueIDPtr &
virtual void IMp7JrsVisualSummaryComponentType::SetVideoSourceLocator ( const Mp7JrsTemporalSegmentLocatorPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set VideoSourceLocator element.

Parameters
itemconst Mp7JrsTemporalSegmentLocatorPtr &