Mp7Jrs  2.7.1
IMp7JrsMediaTranscodingHintsType Class Reference

Generated interface IMp7JrsMediaTranscodingHintsType for class Mp7JrsMediaTranscodingHintsType
Located at: mpeg7-v2.xsd, line 5231
Classified: Class
Derived from: DType (Class)
More...

Inherits IMp7JrsDType.

Inherited by Mp7JrsMediaTranscodingHintsType.

Public Member Functions

virtual Mp7JrszeroToOnePtr Getdifficulty () const =0
 Get difficulty attribute.
virtual bool Existdifficulty () const =0
 Get difficulty attribute validity information.
virtual void Setdifficulty (const Mp7JrszeroToOnePtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set difficulty attribute.
virtual void Invalidatedifficulty ()=0
 Invalidate difficulty attribute.
virtual Mp7JrszeroToOnePtr Getimportance () const =0
 Get importance attribute.
virtual bool Existimportance () const =0
 Get importance attribute validity information.
virtual void Setimportance (const Mp7JrszeroToOnePtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set importance attribute.
virtual void Invalidateimportance ()=0
 Invalidate importance attribute.
virtual Mp7JrszeroToOnePtr GetspatialResolutionHint () const =0
 Get spatialResolutionHint attribute.
virtual bool ExistspatialResolutionHint () const =0
 Get spatialResolutionHint attribute validity information.
virtual void SetspatialResolutionHint (const Mp7JrszeroToOnePtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set spatialResolutionHint attribute.
virtual void InvalidatespatialResolutionHint ()=0
 Invalidate spatialResolutionHint 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 MediaTranscodingHintsType.
Sequence
virtual
Mp7JrsMediaTranscodingHintsType_MotionHint_LocalPtr 
GetMotionHint () const =0
 Get MotionHint element.
virtual bool IsValidMotionHint () const =0
virtual void SetMotionHint (const Mp7JrsMediaTranscodingHintsType_MotionHint_LocalPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set MotionHint element.
virtual void InvalidateMotionHint ()=0
 Invalidate MotionHint element.
virtual
Mp7JrsMediaTranscodingHintsType_ShapeHint_LocalPtr 
GetShapeHint () const =0
 Get ShapeHint element.
virtual bool IsValidShapeHint () const =0
virtual void SetShapeHint (const Mp7JrsMediaTranscodingHintsType_ShapeHint_LocalPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set ShapeHint element.
virtual void InvalidateShapeHint ()=0
 Invalidate ShapeHint element.
virtual
Mp7JrsMediaTranscodingHintsType_CodingHints_LocalPtr 
GetCodingHints () const =0
 Get CodingHints element.
virtual bool IsValidCodingHints () const =0
virtual void SetCodingHints (const Mp7JrsMediaTranscodingHintsType_CodingHints_LocalPtr &item, Mp7JrsClientID client=MP7JRS_UNDEFINED_CLIENT)=0
 Set CodingHints element.
virtual void InvalidateCodingHints ()=0
 Invalidate CodingHints 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 IMp7JrsMediaTranscodingHintsType for class Mp7JrsMediaTranscodingHintsType
Located at: mpeg7-v2.xsd, line 5231
Classified: Class
Derived from: DType (Class)

Member Function Documentation

virtual bool IMp7JrsMediaTranscodingHintsType::Existdifficulty ( ) const
pure virtual

Get difficulty attribute validity information.

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

Get importance attribute validity information.

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

Get spatialResolutionHint attribute validity information.

Returns
true if attribute value is valid, false if not.
virtual Mp7JrsMediaTranscodingHintsType_CodingHints_LocalPtr IMp7JrsMediaTranscodingHintsType::GetCodingHints ( ) const
pure virtual

Get CodingHints element.

Returns
Mp7JrsMediaTranscodingHintsType_CodingHints_LocalPtr
virtual Mp7JrszeroToOnePtr IMp7JrsMediaTranscodingHintsType::Getdifficulty ( ) const
pure virtual

Get difficulty attribute.

Returns
Mp7JrszeroToOnePtr
virtual Mp7JrszeroToOnePtr IMp7JrsMediaTranscodingHintsType::Getimportance ( ) const
pure virtual

Get importance attribute.

Returns
Mp7JrszeroToOnePtr
virtual Mp7JrsMediaTranscodingHintsType_MotionHint_LocalPtr IMp7JrsMediaTranscodingHintsType::GetMotionHint ( ) const
pure virtual

Get MotionHint element.

Returns
Mp7JrsMediaTranscodingHintsType_MotionHint_LocalPtr
virtual Mp7JrsNodeEnum IMp7JrsMediaTranscodingHintsType::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 MediaTranscodingHintsType.

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

  • MotionHint
  • ShapeHint
  • CodingHints

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 Mp7JrsMediaTranscodingHintsType_ShapeHint_LocalPtr IMp7JrsMediaTranscodingHintsType::GetShapeHint ( ) const
pure virtual

Get ShapeHint element.

Returns
Mp7JrsMediaTranscodingHintsType_ShapeHint_LocalPtr
virtual Mp7JrszeroToOnePtr IMp7JrsMediaTranscodingHintsType::GetspatialResolutionHint ( ) const
pure virtual

Get spatialResolutionHint attribute.

Returns
Mp7JrszeroToOnePtr
virtual void IMp7JrsMediaTranscodingHintsType::InvalidateCodingHints ( )
pure virtual

Invalidate CodingHints element.

(Validate it again by setting a value)

virtual void IMp7JrsMediaTranscodingHintsType::Invalidatedifficulty ( )
pure virtual

Invalidate difficulty attribute.

(Validate it again by setting a value)

virtual void IMp7JrsMediaTranscodingHintsType::Invalidateimportance ( )
pure virtual

Invalidate importance attribute.

(Validate it again by setting a value)

virtual void IMp7JrsMediaTranscodingHintsType::InvalidateMotionHint ( )
pure virtual

Invalidate MotionHint element.

(Validate it again by setting a value)

virtual void IMp7JrsMediaTranscodingHintsType::InvalidateShapeHint ( )
pure virtual

Invalidate ShapeHint element.

(Validate it again by setting a value)

virtual void IMp7JrsMediaTranscodingHintsType::InvalidatespatialResolutionHint ( )
pure virtual

Invalidate spatialResolutionHint attribute.

(Validate it again by setting a value)

virtual void IMp7JrsMediaTranscodingHintsType::SetCodingHints ( const Mp7JrsMediaTranscodingHintsType_CodingHints_LocalPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set CodingHints element.

Parameters
itemconst Mp7JrsMediaTranscodingHintsType_CodingHints_LocalPtr &
virtual void IMp7JrsMediaTranscodingHintsType::Setdifficulty ( const Mp7JrszeroToOnePtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set difficulty attribute.

Parameters
itemconst Mp7JrszeroToOnePtr &
virtual void IMp7JrsMediaTranscodingHintsType::Setimportance ( const Mp7JrszeroToOnePtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set importance attribute.

Parameters
itemconst Mp7JrszeroToOnePtr &
virtual void IMp7JrsMediaTranscodingHintsType::SetMotionHint ( const Mp7JrsMediaTranscodingHintsType_MotionHint_LocalPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set MotionHint element.

Parameters
itemconst Mp7JrsMediaTranscodingHintsType_MotionHint_LocalPtr &
virtual void IMp7JrsMediaTranscodingHintsType::SetShapeHint ( const Mp7JrsMediaTranscodingHintsType_ShapeHint_LocalPtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set ShapeHint element.

Parameters
itemconst Mp7JrsMediaTranscodingHintsType_ShapeHint_LocalPtr &
virtual void IMp7JrsMediaTranscodingHintsType::SetspatialResolutionHint ( const Mp7JrszeroToOnePtr &  item,
Mp7JrsClientID  client = MP7JRS_UNDEFINED_CLIENT 
)
pure virtual

Set spatialResolutionHint attribute.

Parameters
itemconst Mp7JrszeroToOnePtr &