Mp7Jrs  2.7.1
IMp7JrsKeyType Class Reference

Generated interface IMp7JrsKeyType for class Mp7JrsKeyType
Located at: mpeg7-v2.xsd, line 2433
Classified: Class
Derived from: AudioDSType (Class)
More...

Inherits IMp7JrsAudioDSType.

Inherited by Mp7JrsKeyType.

Public Member Functions

virtual
Mp7JrsdegreeAccidentalType::Enumeration 
Getaccidental () const =0
 Get accidental attribute.
virtual bool Existaccidental () const =0
 Get accidental attribute validity information.
virtual void Setaccidental (Mp7JrsdegreeAccidentalType::Enumeration item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set accidental attribute.
virtual void Invalidateaccidental ()=0
 Invalidate accidental attribute.
virtual Mp7JrstermReferencePtr Getmode () const =0
 Get mode attribute.
virtual bool Existmode () const =0
 Get mode attribute validity information.
virtual void Setmode (const Mp7JrstermReferencePtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set mode attribute.
virtual void Invalidatemode ()=0
 Invalidate mode attribute.
virtual Mp7JrsintegerVectorPtr Getchannels () const =0
 Get channels attribute.
virtual bool Existchannels () const =0
 Get channels attribute validity information.
virtual void Setchannels (const Mp7JrsintegerVectorPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set channels attribute.
virtual void Invalidatechannels ()=0
 Invalidate channels 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 KeyType.
Sequence
virtual
Mp7JrsKeyType_KeyNote_LocalPtr 
GetKeyNote () const =0
 Get KeyNote element.
virtual void SetKeyNote (const Mp7JrsKeyType_KeyNote_LocalPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set KeyNote 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
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 IMp7JrsKeyType for class Mp7JrsKeyType
Located at: mpeg7-v2.xsd, line 2433
Classified: Class
Derived from: AudioDSType (Class)

Member Function Documentation

virtual bool IMp7JrsKeyType::Existaccidental ( ) const
pure virtual

Get accidental attribute validity information.

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

Get channels attribute validity information.

(Inherited from Mp7JrsAudioDSType)

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

Implements IMp7JrsAudioDSType.

virtual bool IMp7JrsKeyType::Existid ( ) const
pure virtual

Get id attribute validity information.

(Inherited from Mp7JrsDSType)

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

Implements IMp7JrsAudioDSType.

virtual bool IMp7JrsKeyType::ExistmediaTimeBase ( ) const
pure virtual

Get mediaTimeBase attribute validity information.

(Inherited from Mp7JrsDSType)

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

Implements IMp7JrsAudioDSType.

virtual bool IMp7JrsKeyType::ExistmediaTimeUnit ( ) const
pure virtual

Get mediaTimeUnit attribute validity information.

(Inherited from Mp7JrsDSType)

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

Implements IMp7JrsAudioDSType.

virtual bool IMp7JrsKeyType::Existmode ( ) const
pure virtual

Get mode attribute validity information.

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

Get timeBase attribute validity information.

(Inherited from Mp7JrsDSType)

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

Implements IMp7JrsAudioDSType.

virtual bool IMp7JrsKeyType::ExisttimeUnit ( ) const
pure virtual

Get timeUnit attribute validity information.

(Inherited from Mp7JrsDSType)

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

Implements IMp7JrsAudioDSType.

virtual Mp7JrsdegreeAccidentalType::Enumeration IMp7JrsKeyType::Getaccidental ( ) const
pure virtual

Get accidental attribute.

Returns
Mp7JrsdegreeAccidentalType::Enumeration
virtual Mp7JrsintegerVectorPtr IMp7JrsKeyType::Getchannels ( ) const
pure virtual

Get channels attribute.


(Inherited from Mp7JrsAudioDSType)

Returns
Mp7JrsintegerVectorPtr

Implements IMp7JrsAudioDSType.

virtual Mp7JrsDSType_Header_CollectionPtr IMp7JrsKeyType::GetHeader ( ) const
pure virtual

Get Header element.


(Inherited from Mp7JrsDSType)

Returns
Mp7JrsDSType_Header_CollectionPtr

Implements IMp7JrsAudioDSType.

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

Get id attribute.


(Inherited from Mp7JrsDSType)

Returns
XMLCh *

Implements IMp7JrsAudioDSType.

virtual Mp7JrsKeyType_KeyNote_LocalPtr IMp7JrsKeyType::GetKeyNote ( ) const
pure virtual

Get KeyNote element.

Returns
Mp7JrsKeyType_KeyNote_LocalPtr
virtual Mp7JrsxPathRefPtr IMp7JrsKeyType::GetmediaTimeBase ( ) const
pure virtual

Get mediaTimeBase attribute.


(Inherited from Mp7JrsDSType)

Returns
Mp7JrsxPathRefPtr

Implements IMp7JrsAudioDSType.

virtual Mp7JrsmediaDurationPtr IMp7JrsKeyType::GetmediaTimeUnit ( ) const
pure virtual

Get mediaTimeUnit attribute.


(Inherited from Mp7JrsDSType)

Returns
Mp7JrsmediaDurationPtr

Implements IMp7JrsAudioDSType.

virtual Mp7JrstermReferencePtr IMp7JrsKeyType::Getmode ( ) const
pure virtual

Get mode attribute.

Returns
Mp7JrstermReferencePtr
virtual Mp7JrsNodeEnum IMp7JrsKeyType::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 KeyType.

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

  • urn:mpeg:mpeg7:schema:2004:Header
  • KeyNote

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

virtual Mp7JrsxPathRefPtr IMp7JrsKeyType::GettimeBase ( ) const
pure virtual

Get timeBase attribute.


(Inherited from Mp7JrsDSType)

Returns
Mp7JrsxPathRefPtr

Implements IMp7JrsAudioDSType.

virtual Mp7JrsdurationPtr IMp7JrsKeyType::GettimeUnit ( ) const
pure virtual

Get timeUnit attribute.


(Inherited from Mp7JrsDSType)

Returns
Mp7JrsdurationPtr

Implements IMp7JrsAudioDSType.

virtual void IMp7JrsKeyType::Invalidateaccidental ( )
pure virtual

Invalidate accidental attribute.

(Validate it again by setting a value)

virtual void IMp7JrsKeyType::Invalidatechannels ( )
pure virtual

Invalidate channels attribute.

(Inherited from Mp7JrsAudioDSType)

(Validate it again by setting a value)

Implements IMp7JrsAudioDSType.

virtual void IMp7JrsKeyType::Invalidateid ( )
pure virtual

Invalidate id attribute.

(Inherited from Mp7JrsDSType)

(Validate it again by setting a value)

Implements IMp7JrsAudioDSType.

virtual void IMp7JrsKeyType::InvalidatemediaTimeBase ( )
pure virtual

Invalidate mediaTimeBase attribute.

(Inherited from Mp7JrsDSType)

(Validate it again by setting a value)

Implements IMp7JrsAudioDSType.

virtual void IMp7JrsKeyType::InvalidatemediaTimeUnit ( )
pure virtual

Invalidate mediaTimeUnit attribute.

(Inherited from Mp7JrsDSType)

(Validate it again by setting a value)

Implements IMp7JrsAudioDSType.

virtual void IMp7JrsKeyType::Invalidatemode ( )
pure virtual

Invalidate mode attribute.

(Validate it again by setting a value)

virtual void IMp7JrsKeyType::InvalidatetimeBase ( )
pure virtual

Invalidate timeBase attribute.

(Inherited from Mp7JrsDSType)

(Validate it again by setting a value)

Implements IMp7JrsAudioDSType.

virtual void IMp7JrsKeyType::InvalidatetimeUnit ( )
pure virtual

Invalidate timeUnit attribute.

(Inherited from Mp7JrsDSType)

(Validate it again by setting a value)

Implements IMp7JrsAudioDSType.

virtual void IMp7JrsKeyType::Setaccidental ( Mp7JrsdegreeAccidentalType::Enumeration  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set accidental attribute.

Parameters
itemMp7JrsdegreeAccidentalType::Enumeration
virtual void IMp7JrsKeyType::Setchannels ( const Mp7JrsintegerVectorPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set channels attribute.


(Inherited from Mp7JrsAudioDSType)

Parameters
itemconst Mp7JrsintegerVectorPtr &

Implements IMp7JrsAudioDSType.

virtual void IMp7JrsKeyType::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 IMp7JrsAudioDSType.

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

Set id attribute.


(Inherited from Mp7JrsDSType)

Parameters
itemXMLCh *

Implements IMp7JrsAudioDSType.

virtual void IMp7JrsKeyType::SetKeyNote ( const Mp7JrsKeyType_KeyNote_LocalPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set KeyNote element.

Parameters
itemconst Mp7JrsKeyType_KeyNote_LocalPtr &
virtual void IMp7JrsKeyType::SetmediaTimeBase ( const Mp7JrsxPathRefPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set mediaTimeBase attribute.


(Inherited from Mp7JrsDSType)

Parameters
itemconst Mp7JrsxPathRefPtr &

Implements IMp7JrsAudioDSType.

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

Set mediaTimeUnit attribute.


(Inherited from Mp7JrsDSType)

Parameters
itemconst Mp7JrsmediaDurationPtr &

Implements IMp7JrsAudioDSType.

virtual void IMp7JrsKeyType::Setmode ( const Mp7JrstermReferencePtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set mode attribute.

Parameters
itemconst Mp7JrstermReferencePtr &
virtual void IMp7JrsKeyType::SettimeBase ( const Mp7JrsxPathRefPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set timeBase attribute.


(Inherited from Mp7JrsDSType)

Parameters
itemconst Mp7JrsxPathRefPtr &

Implements IMp7JrsAudioDSType.

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

Set timeUnit attribute.


(Inherited from Mp7JrsDSType)

Parameters
itemconst Mp7JrsdurationPtr &

Implements IMp7JrsAudioDSType.