Mp7Jrs  2.7.1
IMp7JrsSpeakerInfoType Class Reference

Generated interface IMp7JrsSpeakerInfoType for class Mp7JrsSpeakerInfoType
Located at: mpeg7-v2.xsd, line 2017
Classified: Class
Derived from: HeaderType (Class)
More...

Inherits IMp7JrsHeaderType.

Inherited by Mp7JrsSpeakerInfoType.

Public Member Functions

virtual XMLCh * GetphoneLexiconRef () const =0
 Get phoneLexiconRef attribute.
virtual bool ExistphoneLexiconRef () const =0
 Get phoneLexiconRef attribute validity information.
virtual void SetphoneLexiconRef (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set phoneLexiconRef attribute.
virtual void InvalidatephoneLexiconRef ()=0
 Invalidate phoneLexiconRef attribute.
virtual XMLCh * GetwordLexiconRef () const =0
 Get wordLexiconRef attribute.
virtual bool ExistwordLexiconRef () const =0
 Get wordLexiconRef attribute validity information.
virtual void SetwordLexiconRef (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set wordLexiconRef attribute.
virtual void InvalidatewordLexiconRef ()=0
 Invalidate wordLexiconRef attribute.
virtual XMLCh * GetconfusionInfoRef () const =0
 Get confusionInfoRef attribute.
virtual bool ExistconfusionInfoRef () const =0
 Get confusionInfoRef attribute validity information.
virtual void SetconfusionInfoRef (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set confusionInfoRef attribute.
virtual void InvalidateconfusionInfoRef ()=0
 Invalidate confusionInfoRef attribute.
virtual XMLCh * GetdescriptionMetadataRef () const =0
 Get descriptionMetadataRef attribute.
virtual bool ExistdescriptionMetadataRef () const =0
 Get descriptionMetadataRef attribute validity information.
virtual void SetdescriptionMetadataRef (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set descriptionMetadataRef attribute.
virtual void InvalidatedescriptionMetadataRef ()=0
 Invalidate descriptionMetadataRef attribute.
virtual
Mp7JrsSpeakerInfoType_provenance_LocalType::Enumeration 
Getprovenance () const =0
 Get provenance attribute.
virtual void Setprovenance (Mp7JrsSpeakerInfoType_provenance_LocalType::Enumeration item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set provenance 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 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 SpeakerInfoType.
Sequence
virtual XMLCh * GetSpokenLanguage () const =0
 Get SpokenLanguage element.
virtual void SetSpokenLanguage (XMLCh *item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set SpokenLanguage element.
virtual Mp7JrsPersonPtr GetPerson () const =0
 Get Person element.
virtual bool IsValidPerson () const =0
virtual void SetPerson (const Mp7JrsPersonPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set Person element.
virtual void InvalidatePerson ()=0
 Invalidate Person element.
virtual
Mp7JrsSpeakerInfoType_WordIndex_LocalPtr 
GetWordIndex () const =0
 Get WordIndex element.
virtual bool IsValidWordIndex () const =0
virtual void SetWordIndex (const Mp7JrsSpeakerInfoType_WordIndex_LocalPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set WordIndex element.
virtual void InvalidateWordIndex ()=0
 Invalidate WordIndex element.
virtual
Mp7JrsSpeakerInfoType_PhoneIndex_LocalPtr 
GetPhoneIndex () const =0
 Get PhoneIndex element.
virtual bool IsValidPhoneIndex () const =0
virtual void SetPhoneIndex (const Mp7JrsSpeakerInfoType_PhoneIndex_LocalPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set PhoneIndex element.
virtual void InvalidatePhoneIndex ()=0
 Invalidate PhoneIndex 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 IMp7JrsSpeakerInfoType for class Mp7JrsSpeakerInfoType
Located at: mpeg7-v2.xsd, line 2017
Classified: Class
Derived from: HeaderType (Class)

Member Function Documentation

virtual bool IMp7JrsSpeakerInfoType::ExistconfusionInfoRef ( ) const
pure virtual

Get confusionInfoRef attribute validity information.

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

Get descriptionMetadataRef attribute validity information.

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

Get id attribute validity information.

(Inherited from Mp7JrsHeaderType)

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

Implements IMp7JrsHeaderType.

virtual bool IMp7JrsSpeakerInfoType::ExistphoneLexiconRef ( ) const
pure virtual

Get phoneLexiconRef attribute validity information.

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

Get wordLexiconRef attribute validity information.

Returns
true if attribute value is valid, false if not.
virtual XMLCh* IMp7JrsSpeakerInfoType::GetconfusionInfoRef ( ) const
pure virtual

Get confusionInfoRef attribute.

Returns
XMLCh *
virtual XMLCh* IMp7JrsSpeakerInfoType::GetdescriptionMetadataRef ( ) const
pure virtual

Get descriptionMetadataRef attribute.

Returns
XMLCh *
virtual XMLCh* IMp7JrsSpeakerInfoType::Getid ( ) const
pure virtual

Get id attribute.


(Inherited from Mp7JrsHeaderType)

Returns
XMLCh *

Implements IMp7JrsHeaderType.

virtual Mp7JrsNodeEnum IMp7JrsSpeakerInfoType::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 SpeakerInfoType.

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

  • Person
  • WordIndex
  • PhoneIndex

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

virtual Mp7JrsPersonPtr IMp7JrsSpeakerInfoType::GetPerson ( ) const
pure virtual

Get Person element.

Returns
Mp7JrsPersonPtr
virtual Mp7JrsSpeakerInfoType_PhoneIndex_LocalPtr IMp7JrsSpeakerInfoType::GetPhoneIndex ( ) const
pure virtual

Get PhoneIndex element.

Returns
Mp7JrsSpeakerInfoType_PhoneIndex_LocalPtr
virtual XMLCh* IMp7JrsSpeakerInfoType::GetphoneLexiconRef ( ) const
pure virtual

Get phoneLexiconRef attribute.

Returns
XMLCh *
virtual Mp7JrsSpeakerInfoType_provenance_LocalType::Enumeration IMp7JrsSpeakerInfoType::Getprovenance ( ) const
pure virtual
virtual XMLCh* IMp7JrsSpeakerInfoType::GetSpokenLanguage ( ) const
pure virtual

Get SpokenLanguage element.

Returns
XMLCh *
virtual Mp7JrsSpeakerInfoType_WordIndex_LocalPtr IMp7JrsSpeakerInfoType::GetWordIndex ( ) const
pure virtual

Get WordIndex element.

Returns
Mp7JrsSpeakerInfoType_WordIndex_LocalPtr
virtual XMLCh* IMp7JrsSpeakerInfoType::GetwordLexiconRef ( ) const
pure virtual

Get wordLexiconRef attribute.

Returns
XMLCh *
virtual void IMp7JrsSpeakerInfoType::InvalidateconfusionInfoRef ( )
pure virtual

Invalidate confusionInfoRef attribute.

(Validate it again by setting a value)

virtual void IMp7JrsSpeakerInfoType::InvalidatedescriptionMetadataRef ( )
pure virtual

Invalidate descriptionMetadataRef attribute.

(Validate it again by setting a value)

virtual void IMp7JrsSpeakerInfoType::Invalidateid ( )
pure virtual

Invalidate id attribute.

(Inherited from Mp7JrsHeaderType)

(Validate it again by setting a value)

Implements IMp7JrsHeaderType.

virtual void IMp7JrsSpeakerInfoType::InvalidatePerson ( )
pure virtual

Invalidate Person element.

(Validate it again by setting a value)

virtual void IMp7JrsSpeakerInfoType::InvalidatePhoneIndex ( )
pure virtual

Invalidate PhoneIndex element.

(Validate it again by setting a value)

virtual void IMp7JrsSpeakerInfoType::InvalidatephoneLexiconRef ( )
pure virtual

Invalidate phoneLexiconRef attribute.

(Validate it again by setting a value)

virtual void IMp7JrsSpeakerInfoType::InvalidateWordIndex ( )
pure virtual

Invalidate WordIndex element.

(Validate it again by setting a value)

virtual void IMp7JrsSpeakerInfoType::InvalidatewordLexiconRef ( )
pure virtual

Invalidate wordLexiconRef attribute.

(Validate it again by setting a value)

virtual void IMp7JrsSpeakerInfoType::SetconfusionInfoRef ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set confusionInfoRef attribute.

Parameters
itemXMLCh *
virtual void IMp7JrsSpeakerInfoType::SetdescriptionMetadataRef ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set descriptionMetadataRef attribute.

Parameters
itemXMLCh *
virtual void IMp7JrsSpeakerInfoType::Setid ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set id attribute.


(Inherited from Mp7JrsHeaderType)

Parameters
itemXMLCh *

Implements IMp7JrsHeaderType.

virtual void IMp7JrsSpeakerInfoType::SetPerson ( const Mp7JrsPersonPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set Person element.

Parameters
itemconst Mp7JrsPersonPtr &
virtual void IMp7JrsSpeakerInfoType::SetPhoneIndex ( const Mp7JrsSpeakerInfoType_PhoneIndex_LocalPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set PhoneIndex element.

Parameters
itemconst Mp7JrsSpeakerInfoType_PhoneIndex_LocalPtr &
virtual void IMp7JrsSpeakerInfoType::SetphoneLexiconRef ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set phoneLexiconRef attribute.

Parameters
itemXMLCh *
virtual void IMp7JrsSpeakerInfoType::Setprovenance ( Mp7JrsSpeakerInfoType_provenance_LocalType::Enumeration  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set provenance attribute.

Parameters
itemMp7JrsSpeakerInfoType_provenance_LocalType::Enumeration
virtual void IMp7JrsSpeakerInfoType::SetSpokenLanguage ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set SpokenLanguage element.

Parameters
itemXMLCh *
virtual void IMp7JrsSpeakerInfoType::SetWordIndex ( const Mp7JrsSpeakerInfoType_WordIndex_LocalPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set WordIndex element.

Parameters
itemconst Mp7JrsSpeakerInfoType_WordIndex_LocalPtr &
virtual void IMp7JrsSpeakerInfoType::SetwordLexiconRef ( XMLCh *  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set wordLexiconRef attribute.

Parameters
itemXMLCh *