COLLADA 1.4 DOM: domEntry Class Reference

COLLADA

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

domEntry Class Reference

#include <domEntry.h>

Inheritance diagram for domEntry:

Inheritance graph
[legend]
Collaboration diagram for domEntry:

Collaboration graph
[legend]
List of all members.

Detailed Description

The entry element declares an entry point into the executable code for a program element.

Public Types

typedef daeSmartRef< domParam > domParamRef
typedef daeTArray< domParamRef > domParam_Array

Public Member Functions

xsNMTOKEN getFunction () const
 Gets the function attribute.
void setFunction (xsNMTOKEN atFunction)
 Sets the function attribute.
xsNMTOKEN getSemantic () const
 Gets the semantic attribute.
void setSemantic (xsNMTOKEN atSemantic)
 Sets the semantic attribute.
domParam_Array & getParam_array ()
 Gets the param element array.
const domParam_Array & getParam_array () const
 Gets the param element array.

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

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

Protected Attributes

xsNMTOKEN attrFunction
 The function attribute indicates the name of the entry point.
xsNMTOKEN attrSemantic
 The semantic attribute is the user-defined meaning of the code.
domParam_Array elemParam_array
 The entry element may contain zero or more param elements.

Classes

class  domParam
 The entry element may contain zero or more param elements. More...

Member Function Documentation

daeElementRef domEntry::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.

xsNMTOKEN domEntry::getFunction (   )  const [inline]
 

Gets the function attribute.

Returns:
Returns a xsNMTOKEN of the function attribute.

const domParam_Array& domEntry::getParam_array (   )  const [inline]
 

Gets the param element array.

Returns:
Returns a constant reference to the array of param elements.

domParam_Array& domEntry::getParam_array (   )  [inline]
 

Gets the param element array.

Returns:
Returns a reference to the array of param elements.

xsNMTOKEN domEntry::getSemantic (   )  const [inline]
 

Gets the semantic attribute.

Returns:
Returns a xsNMTOKEN of the semantic attribute.

daeMetaElement * domEntry::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::setFunction (  xsNMTOKEN  atFunction  )  [inline]
 

Sets the function attribute.

Parameters:
atFunction The new value for the function attribute.

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

Sets the semantic attribute.

Parameters:
atSemantic The new value for the semantic attribute.

Member Data Documentation

xsNMTOKEN domEntry::attrFunction [protected]
 

The function attribute indicates the name of the entry point.

Required attribute.

xsNMTOKEN domEntry::attrSemantic [protected]
 

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

Optional attribute.

domParam_Array domEntry::elemParam_array [protected]
 

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.

See also:
domParam
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:08 2006 for COLLADA 1.4 DOM by doxygen 1.4.3

previous page start next page