daeElement Class Reference

#include <daeElement.h>

List of all members.

Classes
struct	attr
struct	compareResult
struct	matchElement
struct	matchName
struct	matchType
Public Member Functions
daeElement *	add (daeElement *elt, int index=-1)
daeElement *	add (daeString name, int index=-1)
daeElement *	addAfter (daeElement elt, daeElement index)
daeElement *	addBefore (daeElement elt, daeElement index)
daeSmartRef< daeElement >	clone (daeString idSuffix=NULL, daeString nameSuffix=NULL)
daeElement *	createAndPlace (daeString elementName)
daeElement *	createAndPlaceAt (daeInt index, daeString elementName)
daeSmartRef< daeElement >	createElement (daeString elementName)
	daeElement (DAE &dae)
	daeElement ()
daeInt	findLastIndexOf (daeString elementName)
daeElement *	getAncestor (daeString eltName)
daeElement *	getAncestor (const matchElement &matcher)
void	getAttribute (size_t i, std::string &value)
std::string	getAttribute (size_t i)
void	getAttribute (daeString name, std::string &value)
std::string	getAttribute (daeString name)
size_t	getAttributeCount ()
std::string	getAttributeName (size_t i)
daeMetaAttribute *	getAttributeObject (size_t i)
daeMetaAttribute *	getAttributeObject (daeString name)
void	getAttributes (daeTArray< attr > &attrs)
daeTArray< attr >	getAttributes ()
daeMemoryRef	getAttributeValue (daeString name)
void	getCharData (std::string &data)
std::string	getCharData ()
daeMetaAttribute *	getCharDataObject ()
daeElement *	getChild (daeString eltName)
daeElement *	getChild (const matchElement &matcher)
void	getChildren (daeTArray< daeSmartRef< daeElement > > &array)
daeTArray< daeSmartRef < daeElement > >	getChildren ()
template<typename T >
void	getChildrenByType (daeTArray< daeSmartRef< T > > &matchingChildren)
template<typename T >
daeTArray< daeSmartRef< T > >	getChildrenByType ()
daeDocument *	getCollection () const
DAE *	getDAE ()
daeElement *	getDescendant (daeString eltName)
daeElement *	getDescendant (const matchElement &matcher)
daeDocument *	getDocument () const
daeURI *	getDocumentURI () const
daeString	getElementName () const
virtual COLLADA_TYPE::TypeEnum	getElementType () const
daeString	getID () const
daeMetaElement *	getMeta ()
daeElement *	getParent ()
daeElement *	getParentElement ()
daeString	getTypeName () const
void *	getUserData ()
daeMemoryRef	getValuePointer ()
daeElement *	getXMLParentElement ()
daeBool	hasAttribute (daeString name)
daeBool	hasCharData ()
daeBool	hasValue ()
daeBool	isAttributeSet (daeString name)
daeBool	placeElement (daeElement *element)
daeBool	placeElementAfter (daeElement marker, daeElement element)
daeBool	placeElementAt (daeInt index, daeElement *element)
daeBool	placeElementBefore (daeElement marker, daeElement element)
daeBool	removeChildElement (daeElement *element)
virtual daeBool	setAttribute (size_t i, daeString value)
virtual daeBool	setAttribute (daeString name, daeString value)
daeBool	setCharData (const std::string &data)
void	setCollection (daeDocument *c)
void	setDocument (daeDocument *c)
void	setElementName (daeString nm)
void	setParentElement (daeElement *parent)
void	setup (daeMetaElement *meta)
void	setUserData (void *data)
virtual daeInt	typeID () const =0
virtual	~daeElement ()
Static Public Member Functions
static int	compare (daeElement &elt1, daeElement &elt2)
static compareResult	compareWithFullResult (daeElement &elt1, daeElement &elt2)
static void	deleteCMDataArray (daeTArray< daeCharArray * > &cmData)
static daeBool	removeFromParent (daeElement *element)
Protected Member Functions
	daeElement (const daeElement &cpy)
void	init ()
virtual daeElement &	operator= (const daeElement &cpy)
void	setDocument (daeDocument *c, bool notifyDocument)
daeElement *	simpleAdd (daeString name, int index=-1)
Protected Attributes
daeDocument *	_document
daeString	_elementName
daeMetaElement *	_meta
daeElement *	_parent
void *	_userData
daeBoolArray	_validAttributeArray

Detailed Description

The daeElement class represents an instance of a COLLADA "Element"; it is the main base class for the COLLADA Dom. Features of this class include:

Uses factory concepts defined via daeMetaElement
Composed of attributes, content elements and content values
Reference counted via daeSmartRef
Contains information for XML base URI, and XML containing element

Definition at line 43 of file daeElement.h.

Constructor & Destructor Documentation

daeElement::daeElement ( const daeElement & cpy ) [inline, protected]

Definition at line 59 of file daeElement.h.

daeElement::daeElement ( )

Element Constructor.

Note:: This should not be used externally. Use factories to create elements

daeElement::daeElement ( DAE & dae )

Element Constructor.

Note:: This should not be used externally. Use factories to create elements

virtual daeElement::~daeElement ( ) [virtual]

Element Destructor.

Note:: This should not be used externally, if daeSmartRefs are being used.

Member Function Documentation

daeElement* daeElement::add	(	daeElement *	elt,
		int	index = `-1`
	)

daeElement* daeElement::add	(	daeString	name,
		int	index = `-1`
	)

daeElement* daeElement::addAfter	(	daeElement *	elt,
		daeElement *	index
	)

daeElement* daeElement::addBefore	(	daeElement *	elt,
		daeElement *	index
	)

daeSmartRef<daeElement> daeElement::clone	(	daeString	idSuffix = `NULL`,
		daeString	nameSuffix = `NULL`
	)

Clones/deep copies this daeElement and all of it's subtree.

Parameters:

	idSuffix	A string to append to the copied element's ID, if one exists. Default is no ID mangling.
	nameSuffix	A string to append to the copied element's name, if one exists. Default is no name mangling.

Returns:: Returns a daeElement smartref of the copy of this element.

static int daeElement::compare	(	daeElement &	elt1,
		daeElement &	elt2
	)			`[static]`

static compareResult daeElement::compareWithFullResult	(	daeElement &	elt1,
		daeElement &	elt2
	)			`[static]`

daeElement* daeElement::createAndPlace ( daeString elementName )

daeElement* daeElement::createAndPlaceAt	(	daeInt	index,
		daeString	elementName
	)

daeSmartRef<daeElement> daeElement::createElement ( daeString elementName )

Creates an element via the element factory system. This creation is based only on potential child elements of this element.

Parameters:

elementName

Class name of the subelement to create.

Returns:: Returns the created daeElement, if it was successfully created.

static void daeElement::deleteCMDataArray ( daeTArray< daeCharArray * > & cmData ) [static]

daeInt daeElement::findLastIndexOf ( daeString elementName )

Finds the last index into the array of children of the name specified.

Parameters:

elementName

The name to look for.

Returns:: Returns the index into the children array of the last element with name elementName. -1 if there are no children of name elementName.

daeElement* daeElement::getAncestor ( daeString eltName )

daeElement* daeElement::getAncestor ( const matchElement & matcher )

void daeElement::getAttribute	(	size_t	i,
		std::string &	value
	)

Just like the previous method, this method gets an attribute's value as a string. It takes the string as a reference parameter instead of returning it, for extra efficiency.

Parameters:

	i	The index of the attribute to retrieve.
	A	string in which to store the value of the attribute.

std::string daeElement::getAttribute ( size_t i )

Gets an attribute's value as a string.

Parameters:

i

The index of the attribute to retrieve.

Returns:: The value of the attribute.

void daeElement::getAttribute	(	daeString	name,
		std::string &	value
	)

Just like the previous method, this method gets an attribute's value as a string. It takes the string as a reference parameter instead of returning it, for extra efficiency.

Parameters:

	name	The name of the attribute.
	A	string in which to store the value of the attribute. This will be set to an empty string if this element doesn't have the specified attribute.

std::string daeElement::getAttribute ( daeString name )

Gets an attribute's value as a string.

Parameters:

name

The name of the attribute.

Returns:: The value of the attribute. Returns an empty string if this element doesn't have the specified attribute.

size_t daeElement::getAttributeCount ( )

Returns the number of attributes in this element.

Returns:: The number of attributes this element has.

std::string daeElement::getAttributeName ( size_t i )

Returns the name of the attribute at the specified index.

Parameters:

i

The index of the attribute whose name should be retrieved.

Returns:: Returns the name of the attribute, or "" if the index is out of range.

daeMetaAttribute* daeElement::getAttributeObject ( size_t i )

Returns the daeMetaAttribute object corresponding to attribute i.

Parameters:

i

The index of the attribute to find.

Returns:: Returns the corresponding daeMetaAttribute object

daeMetaAttribute* daeElement::getAttributeObject ( daeString name )

Returns the daeMetaAttribute object corresponding to the attribute specified.

Parameters:

name

The name of the attribute to find.

Returns:: Returns the corresponding daeMetaAttribute object or NULL if this element doesn't have the specified attribute.

void daeElement::getAttributes ( daeTArray< attr > & attrs )

Just like the previous method, this method returns an array containing all the attributes of this element. It returns the result via a reference parameter for extra efficiency.

Parameters:

attrs

The array of attr objects to return.

daeTArray<attr> daeElement::getAttributes ( )

Returns an array containing all the attributes of this element.

Returns:: A daeArray of attr objects.

daeMemoryRef daeElement::getAttributeValue ( daeString name )

void daeElement::getCharData ( std::string & data )

Similar to the previous method, but fills a string passed in by the user for efficiency.

Parameters:

data

The string to be filled with this element's character content. The string is set to an empty string if this element can't have character data.

std::string daeElement::getCharData ( )

Returns this element's character data as a string.

Returns:: A string containing this element's character data, or an empty string if this element can't have character data.

daeMetaAttribute* daeElement::getCharDataObject ( )

Returns the daeMetaAttribute object corresponding to the character data for this element.

Returns:: Returns a daeMetaAttribute object or NULL if this element doesn't have character data.

daeElement* daeElement::getChild ( daeString eltName )

daeElement* daeElement::getChild ( const matchElement & matcher )

void daeElement::getChildren ( daeTArray< daeSmartRef< daeElement > > & array )

Same as the previous function, but returns the result via a parameter instead of a return value, for extra efficiency.

Parameters:

array

The return value. An elementref array to append this element's children to.

daeTArray< daeSmartRef<daeElement> > daeElement::getChildren ( )

Gets the children/sub-elements of this element. This is a helper function used to easily access an element's children without the use of the _meta objects. This function adds the convenience of the _contents array to elements that do not contain a _contents array.

Returns:: The return value. An elementref array to append this element's children to.

template<typename T >

void daeElement::getChildrenByType ( daeTArray< daeSmartRef< T > > & matchingChildren ) [inline]

Same as the previous function, but returns the result via a parameter instead of a return value, for extra efficiency.

Returns:: An array containing the matching child elements.

Definition at line 484 of file daeElement.h.

template<typename T >

daeTArray< daeSmartRef<T> > daeElement::getChildrenByType ( ) [inline]

Gets all the children of a particular type.

Returns:: An array containing the matching child elements.

Definition at line 472 of file daeElement.h.

daeDocument* daeElement::getCollection ( ) const [inline]

Deprecated.

Definition at line 315 of file daeElement.h.

DAE* daeElement::getDAE ( )

Get the associated DAE object.

Returns:: The associated DAE object.

daeElement* daeElement::getDescendant ( daeString eltName )

daeElement* daeElement::getDescendant ( const matchElement & matcher )

daeDocument* daeElement::getDocument ( ) const [inline]

Finds the database document associated with this element.

Returns:: Returns the daeDocument representing the containing file or database group.

Definition at line 310 of file daeElement.h.

daeURI* daeElement::getDocumentURI ( ) const

Gets the URI of the document containing this element, note that this is NOT the URI of the element.

Returns:: Returns a pointer to the daeURI of the document containing this element.

daeString daeElement::getElementName ( ) const

Gets this element's name.

Returns:: Returns the string for the name.

Remarks:: This function returns NULL if the element's name is identical to it's type's name.

virtual COLLADA_TYPE::TypeEnum daeElement::getElementType ( ) const [inline, virtual]

Definition at line 419 of file daeElement.h.

daeString daeElement::getID ( ) const

Gets the element ID if it exists.

Returns:: Returns the value of the ID attribute, if there is such an attribute on this element type.; the string for the element ID if it exists.

daeMetaElement* daeElement::getMeta ( ) [inline]

Gets the associated Meta information for this element. This Meta also acts as a factory. See daeMetaElement documentation for more information.

Returns:: Returns the associated meta information.

Definition at line 416 of file daeElement.h.

daeElement* daeElement::getParent ( )

Reimplemented in domInstance_physics_model, and domInstance_physics_model.

daeElement* daeElement::getParentElement ( ) [inline]

Gets the container element for this element. If createAndPlace() was used to create the element, its parent is the the caller of createAndPlace().

Returns:: Returns the parent element, if this is not the top level element.

Definition at line 352 of file daeElement.h.

daeString daeElement::getTypeName ( ) const

void* daeElement::getUserData ( )

Gets the user data pointer attached to this element.

Returns:: User data pointer previously set with setUserData.

daeMemoryRef daeElement::getValuePointer ( )

daeElement* daeElement::getXMLParentElement ( ) [inline]

Deprecated. Use getParentElement()

Deprecated:

Definition at line 357 of file daeElement.h.

daeBool daeElement::hasAttribute ( daeString name )

Checks if this element can have the attribute specified.

Parameters:

name

The name of the attribute to look for.

Returns:: Returns true is this element can have an attribute with the name specified. False otherwise.

daeBool daeElement::hasCharData ( )

Checks if this element can have character data.

Returns:: Returns true if this element can have character data, false otherwise.

daeBool daeElement::hasValue ( )

void daeElement::init ( ) [protected]

daeBool daeElement::isAttributeSet ( daeString name )

Checks if an attribute has been set either by being loaded from the COLLADA document or set programmatically.

Parameters:

name

The name of the attribute to check.

Returns:: Returns true if the attribute has been set. False if the attribute hasn't been set or doesn't exist for this element.

virtual daeElement& daeElement::operator= ( const daeElement & cpy ) [inline, protected, virtual]

Definition at line 60 of file daeElement.h.

daeBool daeElement::placeElement ( daeElement * element )

daeBool daeElement::placeElementAfter	(	daeElement *	marker,
		daeElement *	element
	)

daeBool daeElement::placeElementAt	(	daeInt	index,
		daeElement *	element
	)

daeBool daeElement::placeElementBefore	(	daeElement *	marker,
		daeElement *	element
	)

daeBool daeElement::removeChildElement ( daeElement * element )

Removes the specified element from it parent, the this element. This function is the opposite of placeElement(). It removes the specified element from the _contents array, and from wherever else it appears inside of the this element. Use this function instead of clear(), remove() or delete() if you want to keep the _contents field up-to-date.

Parameters:

element Element to be removed in the this container.

Returns:: Returns true if the element was successfully removed, false otherwise.

static daeBool daeElement::removeFromParent ( daeElement * element ) [inline, static]

Removes the specified element from its parent element. This function is the opposite of placeElement(). It removes the specified element from both the _contents array and from wherever else it appears inside of its parent. The function itself finds the parent, and is defined as a static method, since removing the element from its parent may result in the deletion of the element. If the element has no parent, nothing is done.

Use this function instead of clear(), remove() or delete() if you want to keep _contents up-to-date.

Parameters:

element

Element to remove from its parent container, the function finds the parent element.

Returns:: Returns true if the element was successfully removed, false otherwise.

Definition at line 145 of file daeElement.h.

virtual daeBool daeElement::setAttribute	(	size_t	i,
		daeString	value
	)			`[virtual]`

Sets the attribute at the specified index to the given value.

Parameters:

	i	Index of the attribute to set.
	value	Value to apply to the attribute.

Returns:: Returns true if the attribute was found and the value was set, false otherwise.

virtual daeBool daeElement::setAttribute	(	daeString	name,
		daeString	value
	)			`[virtual]`

Sets the attribute to the specified value.

Parameters:

	name	Attribute to set.
	value	Value to apply to the attribute.

Returns:: Returns true if the attribute was found and the value was set, false otherwise.

Reimplemented in domAny.

daeBool daeElement::setCharData ( const std::string & data )

Sets this element's character data.

Parameters:

data

The new character data of this element.

Returns:: Returns true if this element can have character data and the character data was successfully changed, false otherwise.

void daeElement::setCollection ( daeDocument * c )

Deprecated.

void daeElement::setDocument ( daeDocument * c ) [inline]

Sets the database document associated with this element.

Parameters:

c

The daeDocument to associate with this element.

Definition at line 327 of file daeElement.h.

void daeElement::setDocument	(	daeDocument *	c,
		bool	notifyDocument
	)			`[protected]`

void daeElement::setElementName ( daeString nm )

Sets this element's name.

Parameters:

nm

Specifies the string to use as the element's name.

Remarks:: Use caution when using this function since you can easily create invalid COLLADA documents.

void daeElement::setParentElement ( daeElement * parent ) [inline]

Sets the parent element for this element.

Parameters:

newParent

The element which is the new parent element for this element.

Note:: This function is called internally and not meant to be called form the client application.

Definition at line 363 of file daeElement.h.

void daeElement::setup ( daeMetaElement * meta )

Sets up a daeElement. Called on all daeElements as part of their initialization.

Parameters:

meta

Meta element to use to configure this element.

Note:: Should not be called externally.

void daeElement::setUserData ( void * data )

Sets the user data pointer attached to this element.

Parameters:

data

User's custom data to store.

daeElement* daeElement::simpleAdd	(	daeString	name,
		int	index = `-1`
	)			`[protected]`

virtual daeInt daeElement::typeID ( ) const [pure virtual]

Returns this element's type ID. Every element is an instance of a type specified in the Collada schema, and every schema type has a unique ID.

Returns:: The element's type ID.

Member Data Documentation

daeDocument* daeElement::_document [protected]

Definition at line 52 of file daeElement.h.

daeString daeElement::_elementName [protected]

Definition at line 54 of file daeElement.h.

daeMetaElement* daeElement::_meta [protected]

Definition at line 53 of file daeElement.h.

daeElement* daeElement::_parent [protected]

Macro that defines new and delete overrides for this class

Definition at line 51 of file daeElement.h.

void* daeElement::_userData [protected]

Definition at line 56 of file daeElement.h.

daeBoolArray daeElement::_validAttributeArray [protected]

Definition at line 55 of file daeElement.h.

The documentation for this class was generated from the following file:

daeElement.h

daeElement Class Reference

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation