daeMetaElementArrayAttribute Class Reference

#include <daeMetaElementAttribute.h>

Inheritance diagram for daeMetaElementArrayAttribute:

[legend]

List of all members.

Public Member Functions
virtual void	copy (daeElement *toElement, daeElement *fromElement)
	daeMetaElementArrayAttribute (daeMetaElement *container, daeMetaCMPolicy *parent=NULL, daeUInt ordinal=0, daeInt minO=1, daeInt maxO=1)
virtual daeMemoryRef	get (daeElement *e, daeInt index)
void	getChildren (daeElement *parent, daeElementRefArray &array)
virtual daeInt	getCount (daeElement *e)
virtual daeBool	isArrayAttribute ()
virtual daeElement *	placeElement (daeElement *parent, daeElement *child, daeUInt &ordinal, daeInt offset=0, daeElement *before=NULL, daeElement *after=NULL)
virtual daeBool	removeElement (daeElement *parent, daeElement *child)
void	setCollection (daeElement *parent, daeDocument *c)
virtual void	setDocument (daeElement *parent, daeDocument *c)
	~daeMetaElementArrayAttribute ()

---

Detailed Description

The daeMetaElementArrayAttribute class is similar to daeMetaElementAttribute except that this meta attribute describes an array of elements rather than a singleton.

Definition at line 123 of file daeMetaElementAttribute.h.

---

Constructor & Destructor Documentation

daeMetaElementArrayAttribute::daeMetaElementArrayAttribute	(	daeMetaElement *	container,
		daeMetaCMPolicy *	parent = NULL,
		daeUInt	ordinal = 0,
		daeInt	minO = 1,
		daeInt	maxO = 1
	)

Constructor.

Parameters:

	container	The daeMetaElement that this policy object belongs to.
	parent	The daeMetaCMPolicy parent of this policy object.
	odinal	The ordinal value offset of this specific policy object. Used for maintaining the correct order of child elements.
	minO	The minimum number of times this CMPolicy object must appear. This value comes from the COLLADA schema.
	maxO	The maximum number of times this CMPolicy object may appear. This value comes from the COLLADA schema.

daeMetaElementArrayAttribute::~daeMetaElementArrayAttribute

(

)

---

Member Function Documentation

virtual void daeMetaElementArrayAttribute::copy	(	daeElement *	toElement,
		daeElement *	fromElement
	)			[virtual]

Defines the override version of this method from daeMetaElement.

Parameters:

	toElement	Pointer to a daeElement to copy this attribute to.
	fromElement	Pointer to a daeElement to copy this attribute from.

Reimplemented from daeMetaElementAttribute.

virtual daeMemoryRef daeMetaElementArrayAttribute::get	(	daeElement *	e,
		daeInt	index
	)			[virtual]

Defines the override version of this method from daeMetaElement.

Parameters:

	e	Containing element from which to get the element.
	index	Index of the particle to retrieve if indeed there is an array of elements rather than a singleton.

Returns:

Returns the associated particle out of parent element e, based on index, if necessary.

Reimplemented from daeMetaElementAttribute.

void daeMetaElementArrayAttribute::getChildren	(	daeElement *	parent,
		daeElementRefArray &	array
	)			[virtual]

Populates an array with the children of parent based on this content model object.

Parameters:

	parent	The parent element whos children you want.
	array	The array where you the children will be appended to.

Reimplemented from daeMetaElementAttribute.

virtual daeInt daeMetaElementArrayAttribute::getCount

(

daeElement *

e

)

[virtual]

Defines the override version of this method from daeMetaElement.

Parameters:

e

Containing element to run the operation on.

Returns:

Returns the number of particles associated with this attribute in instance e.

Reimplemented from daeMetaElementAttribute.

virtual daeBool daeMetaElementArrayAttribute::isArrayAttribute

(

)

[inline, virtual]

Gets if this attribute is an array attribute.

Returns:

Returns true if this attribute is an array type.

Reimplemented from daeMetaElementAttribute.

Definition at line 178 of file daeMetaElementAttribute.h.

virtual daeElement* daeMetaElementArrayAttribute::placeElement	(	daeElement *	parent,
		daeElement *	child,
		daeUInt &	ordinal,
		daeInt	offset = 0,
		daeElement *	before = NULL,
		daeElement *	after = NULL
	)			[virtual]

Places an element into the parent element based on this content model policy object.

Parameters:

	parent	The parent element for which the child element will be placed.
	child	The new child element.
	ordinal	A reference to a daeUInt which holds the ordinal return value for a placed child. Used to maintain proper ording of child elements.
	offset	The offset to used when attempting to place this element. Affects comparison against minOccurs and maxOccurs.
	before	The element that the child should appear before. Optional.
	after	The element that the child should appear after. Optional.

Returns:

Returns The child element that was placed within this content model object or any of its children. NULL if placement failed.

Reimplemented from daeMetaElementAttribute.

virtual daeBool daeMetaElementArrayAttribute::removeElement	(	daeElement *	parent,
		daeElement *	child
	)			[virtual]

Removes an element from the parent based on this content model object.

Parameters:

	parent	The parent element for which child you want to remove.
	child	The child that will be removed from the parent.

Returns:

Returns true if the child was successfully removed from this content model object or any of its children. False otherwise.

Reimplemented from daeMetaElementAttribute.

void daeMetaElementArrayAttribute::setCollection	(	daeElement *	parent,
		daeDocument *	c
	)			[inline]

Reimplemented from daeMetaElementAttribute.

Definition at line 148 of file daeMetaElementAttribute.h.

virtual void daeMetaElementArrayAttribute::setDocument	(	daeElement *	parent,
		daeDocument *	c
	)			[virtual]

Sets the database document associated with this element.

Parameters:

c

The daeDocument to associate with this element.

Reimplemented from daeMetaElementAttribute.

---

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

• daeMetaElementAttribute.h