COLLADA 1.4 DOM: domArray Class Reference

COLLADA

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

domArray Class Reference

#include <domArray.h>

Inheritance diagram for domArray:

Inheritance graph
[legend]
Collaboration diagram for domArray:

Collaboration graph
[legend]
List of all members.

Detailed Description

The array element declares the storage for a homogenous array of generic data values.

The array element is deprecated in this version of COLLADA and may be removed in the future.

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.
xsNonNegativeInteger getCount () const
 Gets the count attribute.
void setCount (xsNonNegativeInteger atCount)
 Sets the count attribute.
domArrayTypes getType () const
 Gets the type attribute.
void setType (domArrayTypes atType)
 Sets the type attribute.
xsInteger getMinInclusive () const
 Gets the minInclusive attribute.
void setMinInclusive (xsInteger atMinInclusive)
 Sets the minInclusive attribute.
xsInteger getMaxInclusive () const
 Gets the maxInclusive attribute.
void setMaxInclusive (xsInteger atMaxInclusive)
 Sets the maxInclusive attribute.
xsShort getDigits () const
 Gets the digits attribute.
void setDigits (xsShort atDigits)
 Sets the digits attribute.
xsShort getMagnitude () const
 Gets the magnitude attribute.
void setMagnitude (xsShort atMagnitude)
 Sets the magnitude attribute.
domListOfTokens & getValue ()
 Gets the _value array.
const domListOfTokens & getValue () const
 Gets the _value array.
void setValue (const domListOfTokens &val)
 Sets the _value 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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the array element.
xsNCName attrName
 The name attribute is the text string name of this element.
xsNonNegativeInteger attrCount
 The count attribute indicates the number of values in the array.
domArrayTypes attrType
 The type attribute indicates the data type, such as floating-point or integer numbers of the values contained in the array.
xsInteger attrMinInclusive
 The minInclusive attribute indicates the smallest integer value that can be contained in the array.
xsInteger attrMaxInclusive
 The maxInclusive attribute indicates the largest integer value that can be contained in the array.
xsShort attrDigits
 The digits attribute indicates the number of significant decimal digits of the float values that can be contained in the array.
xsShort attrMagnitude
 The magnitude attribute indicates the largest exponent of the float values that can be contained in the array.
domListOfTokens _value
 The domListOfTokens value of the text data of this element.

Member Function Documentation

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

xsNonNegativeInteger domArray::getCount (   )  const [inline]
 

Gets the count attribute.

Returns:
Returns a xsNonNegativeInteger of the count attribute.

xsShort domArray::getDigits (   )  const [inline]
 

Gets the digits attribute.

Returns:
Returns a xsShort of the digits attribute.

xsID domArray::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsShort domArray::getMagnitude (   )  const [inline]
 

Gets the magnitude attribute.

Returns:
Returns a xsShort of the magnitude attribute.

xsInteger domArray::getMaxInclusive (   )  const [inline]
 

Gets the maxInclusive attribute.

Returns:
Returns a xsInteger of the maxInclusive attribute.

xsInteger domArray::getMinInclusive (   )  const [inline]
 

Gets the minInclusive attribute.

Returns:
Returns a xsInteger of the minInclusive attribute.

xsNCName domArray::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

domArrayTypes domArray::getType (   )  const [inline]
 

Gets the type attribute.

Returns:
Returns a domArrayTypes of the type attribute.

const domListOfTokens& domArray::getValue (   )  const [inline]
 

Gets the _value array.

Returns:
Returns a constant domListOfTokens reference of the _value array.

domListOfTokens& domArray::getValue (   )  [inline]
 

Gets the _value array.

Returns:
Returns a domListOfTokens reference of the _value array.

daeMetaElement * domArray::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 domArray::setCount (  xsNonNegativeInteger  atCount  )  [inline]
 

Sets the count attribute.

Parameters:
atCount The new value for the count attribute.

void domArray::setDigits (  xsShort  atDigits  )  [inline]
 

Sets the digits attribute.

Parameters:
atDigits The new value for the digits attribute.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

void domArray::setMagnitude (  xsShort  atMagnitude  )  [inline]
 

Sets the magnitude attribute.

Parameters:
atMagnitude The new value for the magnitude attribute.

void domArray::setMaxInclusive (  xsInteger  atMaxInclusive  )  [inline]
 

Sets the maxInclusive attribute.

Parameters:
atMaxInclusive The new value for the maxInclusive attribute.

void domArray::setMinInclusive (  xsInteger  atMinInclusive  )  [inline]
 

Sets the minInclusive attribute.

Parameters:
atMinInclusive The new value for the minInclusive attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

void domArray::setType (  domArrayTypes  atType  )  [inline]
 

Sets the type attribute.

Parameters:
atType The new value for the type attribute.

void domArray::setValue (  const domListOfTokens &  val  )  [inline]
 

Sets the _value array.

Parameters:
atMagnitude The new value for the _value array.

Member Data Documentation

xsNonNegativeInteger domArray::attrCount [protected]
 

The count attribute indicates the number of values in the array.

Required attribute.

xsShort domArray::attrDigits [protected]
 

The digits attribute indicates the number of significant decimal digits of the float values that can be contained in the array.

The default value is 6. Optional attribute.

xsID domArray::attrId [protected]
 

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

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

xsShort domArray::attrMagnitude [protected]
 

The magnitude attribute indicates the largest exponent of the float values that can be contained in the array.

The default value is 38. Optional attribute.

xsInteger domArray::attrMaxInclusive [protected]
 

The maxInclusive attribute indicates the largest integer value that can be contained in the array.

The default value is 2147483647. Optional attribute.

xsInteger domArray::attrMinInclusive [protected]
 

The minInclusive attribute indicates the smallest integer value that can be contained in the array.

The default value is -2147483648. Optional attribute.

xsNCName domArray::attrName [protected]
 

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

Optional attribute.

domArrayTypes domArray::attrType [protected]
 

The type attribute indicates the data type, such as floating-point or integer numbers of the values contained in the array.

The array may also contain a list of names or tokens conforming to the XML Schema Language derived types xs:Name and xs:token, respectively. Required attribute.

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

previous page start next page