COLLADA 1.4 DOM: domSource Class Reference

COLLADA

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

domSource Class Reference

#include <domSource.h>

Inheritance diagram for domSource:

Inheritance graph
[legend]
Collaboration diagram for domSource:

Collaboration graph
[legend]
List of all members.

Detailed Description

The source element declares a data repository that provides values according to the semantics of an input element that refers to it.

A data source is a well-known source of information that can be accessed through an established communication channel. The data source provides access methods to the information. These access methods implement various techniques according to the representation of the information. The information may be stored locally as an array of data or a program that generates the data. One of the array elements (array, bool_array, float_array, int_array, or Name_array) may occur zero or more times.

Public Types

typedef daeSmartRef< domTechnique > domTechniqueRef
typedef daeTArray< domTechniqueRef > domTechnique_Array

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.
domArray_Array & getArray_array ()
 Gets the array element array.
const domArray_Array & getArray_array () const
 Gets the array element array.
domBool_array_Array & getBool_array_array ()
 Gets the bool_array element array.
const domBool_array_Array & getBool_array_array () const
 Gets the bool_array element array.
domFloat_array_Array & getFloat_array_array ()
 Gets the float_array element array.
const domFloat_array_Array & getFloat_array_array () const
 Gets the float_array element array.
domInt_array_Array & getInt_array_array ()
 Gets the int_array element array.
const domInt_array_Array & getInt_array_array () const
 Gets the int_array element array.
domName_array_Array & getName_array_array ()
 Gets the Name_array element array.
const domName_array_Array & getName_array_array () const
 Gets the Name_array element array.
domTechnique_Array & getTechnique_array ()
 Gets the technique element array.
const domTechnique_Array & getTechnique_array () const
 Gets the technique element array.
daeElementRefArray & getContents ()
 Gets the _contents array.
const daeElementRefArray & getContents () const
 Gets the _contents 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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the source element.
xsNCName attrName
 The name attribute is the text string name of this element.
domArray_Array elemArray_array
domBool_array_Array elemBool_array_array
domFloat_array_Array elemFloat_array_array
domInt_array_Array elemInt_array_array
domName_array_Array elemName_array_array
domTechnique_Array elemTechnique_array
 The technique element must occur one or more times.
daeElementRefArray _contents
 Used to preserve order in elements that do not specify strict sequencing of sub-elements.

Classes

class  domTechnique
 The technique element must occur one or more times. More...

Member Function Documentation

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

const domArray_Array& domSource::getArray_array (   )  const [inline]
 

Gets the array element array.

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

domArray_Array& domSource::getArray_array (   )  [inline]
 

Gets the array element array.

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

const domBool_array_Array& domSource::getBool_array_array (   )  const [inline]
 

Gets the bool_array element array.

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

domBool_array_Array& domSource::getBool_array_array (   )  [inline]
 

Gets the bool_array element array.

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

const daeElementRefArray& domSource::getContents (   )  const [inline]
 

Gets the _contents array.

Returns:
Returns a constant reference to the _contents element array.

daeElementRefArray& domSource::getContents (   )  [inline]
 

Gets the _contents array.

Returns:
Returns a reference to the _contents element array.

const domFloat_array_Array& domSource::getFloat_array_array (   )  const [inline]
 

Gets the float_array element array.

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

domFloat_array_Array& domSource::getFloat_array_array (   )  [inline]
 

Gets the float_array element array.

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

xsID domSource::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

const domInt_array_Array& domSource::getInt_array_array (   )  const [inline]
 

Gets the int_array element array.

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

domInt_array_Array& domSource::getInt_array_array (   )  [inline]
 

Gets the int_array element array.

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

xsNCName domSource::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

const domName_array_Array& domSource::getName_array_array (   )  const [inline]
 

Gets the Name_array element array.

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

domName_array_Array& domSource::getName_array_array (   )  [inline]
 

Gets the Name_array element array.

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

const domTechnique_Array& domSource::getTechnique_array (   )  const [inline]
 

Gets the technique element array.

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

domTechnique_Array& domSource::getTechnique_array (   )  [inline]
 

Gets the technique element array.

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

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Member Data Documentation

xsID domSource::attrId [protected]
 

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

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

xsNCName domSource::attrName [protected]
 

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

Optional attribute.

domTechnique_Array domSource::elemTechnique_array [protected]
 

The technique element must occur one or more times.

Within the technique element, the common profile's accessor elements describe the output of the source element. The output is assembled from the accessor elements in the order they are specified.

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

previous page start next page