COLLADA 1.4 DOM: domEntry::domParam Class Reference

COLLADA

previous page next page
Main Page | Class Hierarchy | Class List | Directories | Class Members | Related Pages
domEntry::domParam

domEntry::domParam Class Reference

#include <domEntry.h>

Inheritance diagram for domEntry::domParam:

Inheritance graph
[legend]
Collaboration diagram for domEntry::domParam:

Collaboration graph
[legend]
List of all members.

Detailed Description

The entry element may contain zero or more param elements.

In the scope of the entry element, the param element must have the qualifier attribute. The value of the qualifier attribute depends on the technique profile in scope. Also the param element may not have the flow attribute.

Public Member Functions

xsID getId () const
 Gets the id attribute.
void setId (xsID atId)
 Sets the id attribute.
xsNCName getName () const
 Gets the name attribute.
void setName (xsNCName atName)
 Sets the name attribute.
xsNMTOKEN getQualifier () const
 Gets the qualifier attribute.
void setQualifier (xsNMTOKEN atQualifier)
 Sets the qualifier attribute.
xsToken getSemantic () const
 Gets the semantic attribute.
void setSemantic (xsToken atSemantic)
 Sets the semantic attribute.
xsNMTOKEN getType () const
 Gets the type attribute.
void setType (xsNMTOKEN atType)
 Sets the type attribute.
xsString getValue () const
 Gets the value of this element.
void setValue (xsString val)
 Sets the _value of this element.

Static Public Member Functions

static daeElementRef create (daeInt bytes)
 Creates an instance of this class and returns a daeElementRef referencing it.
static daeMetaElement * registerElement ()
 Creates a daeMetaElement object that describes this element in the meta object reflection framework.

Static Public Attributes

static daeMetaElement * _Meta = NULL
 The daeMetaElement that describes this element in the meta object reflection framework.

Protected Member Functions

 domParam ()
 Constructor.
virtual ~domParam ()
 Destructor.
 domParam (const domParam &cpy)
 Copy Constructor.
virtual domParam & operator= (const domParam &cpy)
 Overloaded assignment operator.

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the param element.
xsNCName attrName
 The name attribute is the text string name of this element.
xsNMTOKEN attrQualifier
xsToken attrSemantic
 The semantic attribute is the user-defined meaning of the parameter.
xsNMTOKEN attrType
 The type attribute indicates the type of the value data.
xsString _value
 The xsString value of the text data of this element.

Member Function Documentation

daeElementRef domEntry::domParam::create (  daeInt  bytes  )  [static]
 

Creates an instance of this class and returns a daeElementRef referencing it.

Parameters:
bytes The size allocated for this instance.
Returns:
a daeElementRef referencing an instance of this object.

xsID domEntry::domParam::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsNCName domEntry::domParam::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

xsNMTOKEN domEntry::domParam::getQualifier (   )  const [inline]
 

Gets the qualifier attribute.

Returns:
Returns a xsNMTOKEN of the qualifier attribute.

xsToken domEntry::domParam::getSemantic (   )  const [inline]
 

Gets the semantic attribute.

Returns:
Returns a xsToken of the semantic attribute.

xsNMTOKEN domEntry::domParam::getType (   )  const [inline]
 

Gets the type attribute.

Returns:
Returns a xsNMTOKEN of the type attribute.

xsString domEntry::domParam::getValue (   )  const [inline]
 

Gets the value of this element.

Returns:
a xsString of the value.

daeMetaElement * domEntry::domParam::registerElement (   )  [static]
 

Creates a daeMetaElement object that describes this element in the meta object reflection framework.

If a daeMetaElement already exists it will return that instead of creating a new one.

Returns:
A daeMetaElement describing this COLLADA element.

void domEntry::domParam::setId (  xsID  atId  )  [inline]
 

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

void domEntry::domParam::setName (  xsNCName  atName  )  [inline]
 

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

void domEntry::domParam::setQualifier (  xsNMTOKEN  atQualifier  )  [inline]
 

Sets the qualifier attribute.

Parameters:
atQualifier The new value for the qualifier attribute.

void domEntry::domParam::setSemantic (  xsToken  atSemantic  )  [inline]
 

Sets the semantic attribute.

Parameters:
atSemantic The new value for the semantic attribute.

void domEntry::domParam::setType (  xsNMTOKEN  atType  )  [inline]
 

Sets the type attribute.

Parameters:
atType The new value for the type attribute.

void domEntry::domParam::setValue (  xsString  val  )  [inline]
 

Sets the _value of this element.

Parameters:
val The new value for this element.

Member Data Documentation

xsID domEntry::domParam::attrId [protected]
 

The id attribute is a text string containing the unique identifier of the param element.

This value must be unique within the instance document. Optional attribute.

xsNCName domEntry::domParam::attrName [protected]
 

The name attribute is the text string name of this element.

Optional attribute.

xsToken domEntry::domParam::attrSemantic [protected]
 

The semantic attribute is the user-defined meaning of the parameter.

Optional attribute.

xsNMTOKEN domEntry::domParam::attrType [protected]
 

The type attribute indicates the type of the value data.

This text string must be understood by the application. Required attribute.

The documentation for this class was generated from the following files:
  • C:/SVN_wf/COLLADA_DOM/include/1.3/dom/domEntry.h
  • C:/SVN_wf/COLLADA_DOM/src/1.3/dom/domEntry.cpp
©2005 Sony Computer Entertainment Inc.. All Rights Reserved.
Generated on Fri Feb 10 16:48:10 2006 for COLLADA 1.4 DOM by doxygen 1.4.3

previous page start next page