COLLADA 1.4 DOM: domParam Class Reference

COLLADA

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

domParam Class Reference

#include <domParam.h>

Inheritance diagram for domParam:

Inheritance graph
[legend]
Collaboration diagram for domParam:

Collaboration graph
[legend]
List of all members.

Detailed Description

The param element declares parametric information regarding its parent element.

The param element describes parameters for generic data flow, program data, and entry points. A functional or programmatical format requires a means for users to specify parametric information. This information represents function parameter (argument) data. The basic declaration of a parameter describes the name, data type, and value data of the parameter. That parameter name identifies it to the function or program. The parameter type indicates the encoding of its value. The parameter value is the actual data.

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.
xsNCName getSid () const
 Gets the sid attribute.
void setSid (xsNCName atSid)
 Sets the sid attribute.
domFlowType getFlow () const
 Gets the flow attribute.
void setFlow (domFlowType atFlow)
 Sets the flow 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.
xsNCName attrSid
 The sid attribute is a text string value containing the sub-identifier of this element.
domFlowType attrFlow
 The flow attribute indicates the direction of data flow.
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 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.

domFlowType domParam::getFlow (   )  const [inline]
 

Gets the flow attribute.

Returns:
Returns a domFlowType of the flow attribute.

xsID domParam::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsNCName domParam::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

xsToken domParam::getSemantic (   )  const [inline]
 

Gets the semantic attribute.

Returns:
Returns a xsToken of the semantic attribute.

xsNCName domParam::getSid (   )  const [inline]
 

Gets the sid attribute.

Returns:
Returns a xsNCName of the sid attribute.

xsNMTOKEN domParam::getType (   )  const [inline]
 

Gets the type attribute.

Returns:
Returns a xsNMTOKEN of the type attribute.

xsString domParam::getValue (   )  const [inline]
 

Gets the value of this element.

Returns:
a xsString of the value.

daeMetaElement * 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 domParam::setFlow (  domFlowType  atFlow  )  [inline]
 

Sets the flow attribute.

Parameters:
atFlow The new value for the flow attribute.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

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

Sets the semantic attribute.

Parameters:
atSemantic The new value for the semantic attribute.

void domParam::setSid (  xsNCName  atSid  )  [inline]
 

Sets the sid attribute.

Parameters:
atSid The new value for the sid attribute.

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

Sets the type attribute.

Parameters:
atType The new value for the type attribute.

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

Sets the _value of this element.

Parameters:
val The new value for this element.

Member Data Documentation

domFlowType domParam::attrFlow [protected]
 

The flow attribute indicates the direction of data flow.

Optional attribute.

xsID 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 domParam::attrName [protected]
 

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

Optional attribute.

xsToken domParam::attrSemantic [protected]
 

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

Optional attribute.

xsNCName domParam::attrSid [protected]
 

The sid attribute is a text string value containing the sub-identifier of this element.

This value must be unique within the scope of the parent element. Optional attribute.

xsNMTOKEN 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/domParam.h
  • C:/SVN_wf/COLLADA_DOM/src/1.3/dom/domParam.cpp
©2005 Sony Computer Entertainment Inc.. All Rights Reserved.
Generated on Fri Feb 10 16:49:17 2006 for COLLADA 1.4 DOM by doxygen 1.4.3

previous page start next page