Mp7Jrs  2.7.1
IMp7JrsUsageHistoryType Class Reference

Generated interface IMp7JrsUsageHistoryType for class Mp7JrsUsageHistoryType
Located at: mpeg7-v2.xsd, line 9194
Classified: Class
Derived from: DSType (Class)
More...

Inherits IMp7JrsDSType.

Inherited by Mp7JrsUsageHistoryType.

Public Member Functions

virtual
Mp7JrsuserChoiceType::Enumeration 
GetallowCollection () const =0
 Get allowCollection attribute.
virtual bool ExistallowCollection () const =0
 Get allowCollection attribute validity information.
virtual void SetallowCollection (Mp7JrsuserChoiceType::Enumeration item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set allowCollection attribute.
virtual void InvalidateallowCollection ()=0
 Invalidate allowCollection attribute.
virtual XMLCh * Getid () const =0
 Get id attribute.
virtual bool Existid () const =0
 Get id attribute validity information.
virtual void Setid (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set id attribute.
virtual void Invalidateid ()=0
 Invalidate id attribute.
virtual Mp7JrsxPathRefPtr GettimeBase () const =0
 Get timeBase attribute.
virtual bool ExisttimeBase () const =0
 Get timeBase attribute validity information.
virtual void SettimeBase (const Mp7JrsxPathRefPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set timeBase attribute.
virtual void InvalidatetimeBase ()=0
 Invalidate timeBase attribute.
virtual Mp7JrsdurationPtr GettimeUnit () const =0
 Get timeUnit attribute.
virtual bool ExisttimeUnit () const =0
 Get timeUnit attribute validity information.
virtual void SettimeUnit (const Mp7JrsdurationPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set timeUnit attribute.
virtual void InvalidatetimeUnit ()=0
 Invalidate timeUnit attribute.
virtual Mp7JrsxPathRefPtr GetmediaTimeBase () const =0
 Get mediaTimeBase attribute.
virtual bool ExistmediaTimeBase () const =0
 Get mediaTimeBase attribute validity information.
virtual void SetmediaTimeBase (const Mp7JrsxPathRefPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set mediaTimeBase attribute.
virtual void InvalidatemediaTimeBase ()=0
 Invalidate mediaTimeBase attribute.
virtual Mp7JrsmediaDurationPtr GetmediaTimeUnit () const =0
 Get mediaTimeUnit attribute.
virtual bool ExistmediaTimeUnit () const =0
 Get mediaTimeUnit attribute validity information.
virtual void SetmediaTimeUnit (const Mp7JrsmediaDurationPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set mediaTimeUnit attribute.
virtual void InvalidatemediaTimeUnit ()=0
 Invalidate mediaTimeUnit 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 UsageHistoryType.
Sequence
virtual Mp7JrsUserIdentifierPtr GetUserIdentifier () const =0
 Get UserIdentifier element.
virtual bool IsValidUserIdentifier () const =0
virtual void SetUserIdentifier (const Mp7JrsUserIdentifierPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set UserIdentifier element.
virtual void InvalidateUserIdentifier ()=0
 Invalidate UserIdentifier element.
virtual
Mp7JrsUsageHistoryType_UserActionHistory_CollectionPtr 
GetUserActionHistory () const =0
 Get UserActionHistory element.
virtual void SetUserActionHistory (const Mp7JrsUsageHistoryType_UserActionHistory_CollectionPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set UserActionHistory element.
virtual
Mp7JrsDSType_Header_CollectionPtr 
GetHeader () const =0
 Get Header element.
virtual void SetHeader (const Mp7JrsDSType_Header_CollectionPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Header element.
Sequence

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 IMp7JrsUsageHistoryType for class Mp7JrsUsageHistoryType
Located at: mpeg7-v2.xsd, line 9194
Classified: Class
Derived from: DSType (Class)

Member Function Documentation

virtual bool IMp7JrsUsageHistoryType::ExistallowCollection ( ) const
pure virtual

Get allowCollection attribute validity information.

Returns
true if attribute value is valid, false if not.
virtual bool IMp7JrsUsageHistoryType::Existid ( ) const
pure virtual

Get id attribute validity information.

(Inherited from Mp7JrsDSType)

Returns
true if attribute value is valid, false if not.

Implements IMp7JrsDSType.

virtual bool IMp7JrsUsageHistoryType::ExistmediaTimeBase ( ) const
pure virtual

Get mediaTimeBase attribute validity information.

(Inherited from Mp7JrsDSType)

Returns
true if attribute value is valid, false if not.

Implements IMp7JrsDSType.

virtual bool IMp7JrsUsageHistoryType::ExistmediaTimeUnit ( ) const
pure virtual

Get mediaTimeUnit attribute validity information.

(Inherited from Mp7JrsDSType)

Returns
true if attribute value is valid, false if not.

Implements IMp7JrsDSType.

virtual bool IMp7JrsUsageHistoryType::ExisttimeBase ( ) const
pure virtual

Get timeBase attribute validity information.

(Inherited from Mp7JrsDSType)

Returns
true if attribute value is valid, false if not.

Implements IMp7JrsDSType.

virtual bool IMp7JrsUsageHistoryType::ExisttimeUnit ( ) const
pure virtual

Get timeUnit attribute validity information.

(Inherited from Mp7JrsDSType)

Returns
true if attribute value is valid, false if not.

Implements IMp7JrsDSType.

virtual Mp7JrsuserChoiceType::Enumeration IMp7JrsUsageHistoryType::GetallowCollection ( ) const
pure virtual

Get allowCollection attribute.

Returns
Mp7JrsuserChoiceType::Enumeration
virtual Mp7JrsDSType_Header_CollectionPtr IMp7JrsUsageHistoryType::GetHeader ( ) const
pure virtual

Get Header element.


(Inherited from Mp7JrsDSType)

Returns
Mp7JrsDSType_Header_CollectionPtr

Implements IMp7JrsDSType.

virtual XMLCh* IMp7JrsUsageHistoryType::Getid ( ) const
pure virtual

Get id attribute.


(Inherited from Mp7JrsDSType)

Returns
XMLCh *

Implements IMp7JrsDSType.

virtual Mp7JrsxPathRefPtr IMp7JrsUsageHistoryType::GetmediaTimeBase ( ) const
pure virtual

Get mediaTimeBase attribute.


(Inherited from Mp7JrsDSType)

Returns
Mp7JrsxPathRefPtr

Implements IMp7JrsDSType.

virtual Mp7JrsmediaDurationPtr IMp7JrsUsageHistoryType::GetmediaTimeUnit ( ) const
pure virtual

Get mediaTimeUnit attribute.


(Inherited from Mp7JrsDSType)

Returns
Mp7JrsmediaDurationPtr

Implements IMp7JrsDSType.

virtual Mp7JrsNodeEnum IMp7JrsUsageHistoryType::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 UsageHistoryType.

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

  • urn:mpeg:mpeg7:schema:2004:Header
  • UserIdentifier
  • urn:mpeg:mpeg7:schema:2004:UserActionHistory

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

virtual Mp7JrsxPathRefPtr IMp7JrsUsageHistoryType::GettimeBase ( ) const
pure virtual

Get timeBase attribute.


(Inherited from Mp7JrsDSType)

Returns
Mp7JrsxPathRefPtr

Implements IMp7JrsDSType.

virtual Mp7JrsdurationPtr IMp7JrsUsageHistoryType::GettimeUnit ( ) const
pure virtual

Get timeUnit attribute.


(Inherited from Mp7JrsDSType)

Returns
Mp7JrsdurationPtr

Implements IMp7JrsDSType.

virtual Mp7JrsUsageHistoryType_UserActionHistory_CollectionPtr IMp7JrsUsageHistoryType::GetUserActionHistory ( ) const
pure virtual

Get UserActionHistory element.

Returns
Mp7JrsUsageHistoryType_UserActionHistory_CollectionPtr
virtual Mp7JrsUserIdentifierPtr IMp7JrsUsageHistoryType::GetUserIdentifier ( ) const
pure virtual

Get UserIdentifier element.

Returns
Mp7JrsUserIdentifierPtr
virtual void IMp7JrsUsageHistoryType::InvalidateallowCollection ( )
pure virtual

Invalidate allowCollection attribute.

(Validate it again by setting a value)

virtual void IMp7JrsUsageHistoryType::Invalidateid ( )
pure virtual

Invalidate id attribute.

(Inherited from Mp7JrsDSType)

(Validate it again by setting a value)

Implements IMp7JrsDSType.

virtual void IMp7JrsUsageHistoryType::InvalidatemediaTimeBase ( )
pure virtual

Invalidate mediaTimeBase attribute.

(Inherited from Mp7JrsDSType)

(Validate it again by setting a value)

Implements IMp7JrsDSType.

virtual void IMp7JrsUsageHistoryType::InvalidatemediaTimeUnit ( )
pure virtual

Invalidate mediaTimeUnit attribute.

(Inherited from Mp7JrsDSType)

(Validate it again by setting a value)

Implements IMp7JrsDSType.

virtual void IMp7JrsUsageHistoryType::InvalidatetimeBase ( )
pure virtual

Invalidate timeBase attribute.

(Inherited from Mp7JrsDSType)

(Validate it again by setting a value)

Implements IMp7JrsDSType.

virtual void IMp7JrsUsageHistoryType::InvalidatetimeUnit ( )
pure virtual

Invalidate timeUnit attribute.

(Inherited from Mp7JrsDSType)

(Validate it again by setting a value)

Implements IMp7JrsDSType.

virtual void IMp7JrsUsageHistoryType::InvalidateUserIdentifier ( )
pure virtual

Invalidate UserIdentifier element.

(Validate it again by setting a value)

virtual void IMp7JrsUsageHistoryType::SetallowCollection ( Mp7JrsuserChoiceType::Enumeration  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set allowCollection attribute.

Parameters
itemMp7JrsuserChoiceType::Enumeration
virtual void IMp7JrsUsageHistoryType::SetHeader ( const Mp7JrsDSType_Header_CollectionPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Header element.


(Inherited from Mp7JrsDSType)

Parameters
itemconst Mp7JrsDSType_Header_CollectionPtr &

Implements IMp7JrsDSType.

virtual void IMp7JrsUsageHistoryType::Setid ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set id attribute.


(Inherited from Mp7JrsDSType)

Parameters
itemXMLCh *

Implements IMp7JrsDSType.

virtual void IMp7JrsUsageHistoryType::SetmediaTimeBase ( const Mp7JrsxPathRefPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set mediaTimeBase attribute.


(Inherited from Mp7JrsDSType)

Parameters
itemconst Mp7JrsxPathRefPtr &

Implements IMp7JrsDSType.

virtual void IMp7JrsUsageHistoryType::SetmediaTimeUnit ( const Mp7JrsmediaDurationPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set mediaTimeUnit attribute.


(Inherited from Mp7JrsDSType)

Parameters
itemconst Mp7JrsmediaDurationPtr &

Implements IMp7JrsDSType.

virtual void IMp7JrsUsageHistoryType::SettimeBase ( const Mp7JrsxPathRefPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set timeBase attribute.


(Inherited from Mp7JrsDSType)

Parameters
itemconst Mp7JrsxPathRefPtr &

Implements IMp7JrsDSType.

virtual void IMp7JrsUsageHistoryType::SettimeUnit ( const Mp7JrsdurationPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set timeUnit attribute.


(Inherited from Mp7JrsDSType)

Parameters
itemconst Mp7JrsdurationPtr &

Implements IMp7JrsDSType.

virtual void IMp7JrsUsageHistoryType::SetUserActionHistory ( const Mp7JrsUsageHistoryType_UserActionHistory_CollectionPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set UserActionHistory element.

Parameters
itemconst Mp7JrsUsageHistoryType_UserActionHistory_CollectionPtr &
virtual void IMp7JrsUsageHistoryType::SetUserIdentifier ( const Mp7JrsUserIdentifierPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set UserIdentifier element.

Parameters
itemconst Mp7JrsUserIdentifierPtr &