COLLADA 1.4 DOM: domCode Class Reference

COLLADA

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

domCode Class Reference

#include <domCode.h>

Inheritance diagram for domCode:

Inheritance graph
[legend]
Collaboration diagram for domCode:

Collaboration graph
[legend]
List of all members.

Detailed Description

The code element declares the executable code for a program element.

The code element may contain a text string value. This string value is interpreted as source code.

Public Member Functions

xsID getId () const
 Gets the id attribute.
void setId (xsID atId)
 Sets the id attribute.
xsNMTOKEN getLang () const
 Gets the lang attribute.
void setLang (xsNMTOKEN atLang)
 Sets the lang attribute.
xsString getProfile () const
 Gets the profile attribute.
void setProfile (xsString atProfile)
 Sets the profile attribute.
xsNMTOKEN getSemantic () const
 Gets the semantic attribute.
void setSemantic (xsNMTOKEN atSemantic)
 Sets the semantic attribute.
xsAnyURI & getUrl ()
 Gets the url attribute.
const xsAnyURI & getUrl () const
 Gets the url attribute.
void setUrl (const xsAnyURI &atUrl)
 Sets the url 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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the code element.
xsNMTOKEN attrLang
 The lang attribute indicates the programming language that the code is stored in.
xsString attrProfile
 The profile attribute indicates the type of profile.
xsNMTOKEN attrSemantic
 The semantic attribute is the user-defined meaning of the code.
xsAnyURI attrUrl
 The url attribute is a valid URL to the location of the code resource.
xsString _value
 The xsString value of the text data of this element.

Member Function Documentation

daeElementRef domCode::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 domCode::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsNMTOKEN domCode::getLang (   )  const [inline]
 

Gets the lang attribute.

Returns:
Returns a xsNMTOKEN of the lang attribute.

xsString domCode::getProfile (   )  const [inline]
 

Gets the profile attribute.

Returns:
Returns a xsString of the profile attribute.

xsNMTOKEN domCode::getSemantic (   )  const [inline]
 

Gets the semantic attribute.

Returns:
Returns a xsNMTOKEN of the semantic attribute.

const xsAnyURI& domCode::getUrl (   )  const [inline]
 

Gets the url attribute.

Returns:
Returns a constant xsAnyURI reference of the url attribute.

xsAnyURI& domCode::getUrl (   )  [inline]
 

Gets the url attribute.

Returns:
Returns a xsAnyURI reference of the url attribute.

xsString domCode::getValue (   )  const [inline]
 

Gets the value of this element.

Returns:
a xsString of the value.

daeMetaElement * domCode::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 domCode::setId (  xsID  atId  )  [inline]
 

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

void domCode::setLang (  xsNMTOKEN  atLang  )  [inline]
 

Sets the lang attribute.

Parameters:
atLang The new value for the lang attribute.

void domCode::setProfile (  xsString  atProfile  )  [inline]
 

Sets the profile attribute.

Parameters:
atProfile The new value for the profile attribute.

void domCode::setSemantic (  xsNMTOKEN  atSemantic  )  [inline]
 

Sets the semantic attribute.

Parameters:
atSemantic The new value for the semantic attribute.

void domCode::setUrl (  const xsAnyURI &  atUrl  )  [inline]
 

Sets the url attribute.

Parameters:
atUrl The new value for the url attribute.

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

Sets the _value of this element.

Parameters:
val The new value for this element.

Member Data Documentation

xsID domCode::attrId [protected]
 

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

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

xsNMTOKEN domCode::attrLang [protected]
 

The lang attribute indicates the programming language that the code is stored in.

Required attribute.

xsString domCode::attrProfile [protected]
 

The profile attribute indicates the type of profile.

This is a vendor defined character string that indicates the platform or capability target for the code. Optional attribute.

xsNMTOKEN domCode::attrSemantic [protected]
 

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

Optional attribute.

xsAnyURI domCode::attrUrl [protected]
 

The url attribute is a valid URL to the location of the code resource.

Optional attribute.

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

previous page start next page