#include <Definition.h>

Inheritance diagram for AttributeDef:

Public Member Functions
	AttributeDef (ElementPtr parent, const string &name)

virtual	~AttributeDef ()

Attribute name
void	setAttrName (const string &name)
	Set the element's attrname string. More...

bool	hasAttrName () const
	Return true if this element has an attrname string. More...

const string &	getAttrName () const
	Return the element's attrname string. More...

Value String
void	setValueString (const string &value)
	Set the value string of an element. More...

bool	hasValueString () const
	Return true if the given element has a value string. More...

const string &	getValueString () const
	Get the value string of a element. More...

Typed Value
template<class T >
void	setValue (const T &value, const string &type=EMPTY_STRING)
	Set the typed value of an element. More...

void	setValue (const char *value, const string &type=EMPTY_STRING)
	Set the typed value of an element from a C-style string. More...

bool	hasValue () const
	Return true if the element possesses a typed value. More...

ValuePtr	getValue () const

Elements
void	setElements (const string &elements)
	Set the element's elements string. More...

bool	hasElements () const
	Return true if the element has an elements string. More...

const string &	getElements () const
	Return the element's elements string. More...

Exportable
void	setExportable (bool value)
	Set the exportable boolean for the element. More...

bool	getExportable () const

Public Member Functions inherited from TypedElement
virtual	~TypedElement ()

void	setType (const string &type)
	Set the element's type string. More...

bool	hasType () const
	Return true if the given element has a type string. More...

virtual const string &	getType () const
	Return the element's type string. More...

bool	isColorType () const
	Return true if the element is of color type. More...

bool	isMultiOutputType () const
	Return true if the element is of multi-output type. More...

TypeDefPtr	getTypeDef () const

Public Member Functions inherited from Element
virtual	~Element ()

	Element (const Element &)=delete

Element &	operator= (const Element &)=delete

bool	operator== (const Element &rhs) const

bool	operator!= (const Element &rhs) const

void	setCategory (const string &category)
	Set the element's category string. More...

const string &	getCategory () const

void	setName (const string &name)

const string &	getName () const
	Return the element's name string. More...

string	getNamePath (ConstElementPtr relativeTo=nullptr) const

ElementPtr	getDescendant (const string &namePath) const

void	setFilePrefix (const string &prefix)
	Set the element's file prefix string. More...

bool	hasFilePrefix () const
	Return true if the given element has a file prefix string. More...

const string &	getFilePrefix () const
	Return the element's file prefix string. More...

const string &	getActiveFilePrefix () const

void	setGeomPrefix (const string &prefix)
	Set the element's geom prefix string. More...

bool	hasGeomPrefix () const
	Return true if the given element has a geom prefix string. More...

const string &	getGeomPrefix () const
	Return the element's geom prefix string. More...

const string &	getActiveGeomPrefix () const

void	setColorSpace (const string &colorSpace)
	Set the element's color space string. More...

bool	hasColorSpace () const
	Return true if the given element has a color space string. More...

const string &	getColorSpace () const
	Return the element's color space string. More...

const string &	getActiveColorSpace () const

void	setInheritString (const string &inherit)
	Set the inherit string of this element. More...

bool	hasInheritString () const
	Return true if this element has an inherit string. More...

const string &	getInheritString () const
	Return the inherit string of this element. More...

void	setInheritsFrom (ConstElementPtr super)
	Set the element that this one directly inherits from. More...

ElementPtr	getInheritsFrom () const
	Return the element, if any, that this one directly inherits from. More...

bool	hasInheritedBase (ConstElementPtr base) const

bool	hasInheritanceCycle () const
	Return true if the inheritance chain for this element contains a cycle. More...

void	setNamespace (const string &space)
	Set the namespace string of this element. More...

bool	hasNamespace () const
	Return true if this element has a namespace string. More...

const string &	getNamespace () const
	Return the namespace string of this element. More...

string	getQualifiedName (const string &name) const

void	setDocString (const string &doc)
	Set the documentation string of this element. More...

string	getDocString () const
	Return the documentation string of this element. More...

template<class T >
bool	isA (const string &category=EMPTY_STRING) const

template<class T >
shared_ptr< T >	asA ()
	Dynamic cast to an instance of the given subclass. More...

template<class T >
shared_ptr< const T >	asA () const
	Dynamic cast to a const instance of the given subclass. More...

template<class T >
shared_ptr< T >	addChild (const string &name=EMPTY_STRING)

ElementPtr	addChildOfCategory (const string &category, string name=EMPTY_STRING)

ElementPtr	changeChildCategory (ElementPtr child, const string &category)

ElementPtr	getChild (const string &name) const
	Return the child element, if any, with the given name. More...

template<class T >
shared_ptr< T >	getChildOfType (const string &name) const

const ElementVec &	getChildren () const

template<class T >
vector< shared_ptr< T > >	getChildrenOfType (const string &category=EMPTY_STRING) const

void	setChildIndex (const string &name, int index)

int	getChildIndex (const string &name) const

void	removeChild (const string &name)
	Remove the child element, if any, with the given name. More...

template<class T >
void	removeChildOfType (const string &name)

void	setAttribute (const string &attrib, const string &value)
	Set the value string of the given attribute. More...

bool	hasAttribute (const string &attrib) const
	Return true if the given attribute is present. More...

const string &	getAttribute (const string &attrib) const

const StringVec &	getAttributeNames () const
	Return a vector of stored attribute names, in the order they were set. More...

template<class T >
void	setTypedAttribute (const string &attrib, const T &data)

template<class T >
T	getTypedAttribute (const string &attrib) const

void	removeAttribute (const string &attrib)
	Remove the given attribute, if present. More...

ElementPtr	getSelf ()
	Return our self pointer. More...

ConstElementPtr	getSelf () const
	Return our self pointer. More...

ElementPtr	getParent ()
	Return our parent element. More...

ConstElementPtr	getParent () const
	Return our parent element. More...

ElementPtr	getRoot ()
	Return the root element of our tree. More...

ConstElementPtr	getRoot () const
	Return the root element of our tree. More...

DocumentPtr	getDocument ()
	Return the root document of our tree. More...

ConstDocumentPtr	getDocument () const
	Return the root document of our tree. More...

template<class T >
shared_ptr< T >	getAncestorOfType ()

template<class T >
shared_ptr< const T >	getAncestorOfType () const

bool	isEquivalent (ConstElementPtr rhs, const ElementEquivalenceOptions &options, string *message=nullptr) const

virtual bool	isAttributeEquivalent (ConstElementPtr rhs, const string &attributeName, const ElementEquivalenceOptions &options, string *message=nullptr) const

TreeIterator	traverseTree () const

GraphIterator	traverseGraph () const

virtual Edge	getUpstreamEdge (size_t index=0) const

virtual size_t	getUpstreamEdgeCount () const
	Return the number of queryable upstream edges for this element. More...

ElementPtr	getUpstreamElement (size_t index=0) const

InheritanceIterator	traverseInheritance () const

void	setSourceUri (const string &sourceUri)

bool	hasSourceUri () const
	Return true if this element has a source URI. More...

const string &	getSourceUri () const
	Return the element's source URI. More...

const string &	getActiveSourceUri () const

virtual bool	validate (string *message=nullptr) const

void	copyContentFrom (const ConstElementPtr &source)

virtual void	clearContent ()
	Clear all attributes and descendants from this element. More...

string	createValidChildName (string name) const

StringResolverPtr	createStringResolver (const string &geom=EMPTY_STRING) const

string	asString () const

Static Public Attributes
static const string	CATEGORY

static const string	ATTRNAME_ATTRIBUTE

static const string	VALUE_ATTRIBUTE

static const string	ELEMENTS_ATTRIBUTE

static const string	EXPORTABLE_ATTRIBUTE

Static Public Attributes inherited from TypedElement
static const string	TYPE_ATTRIBUTE

Static Public Attributes inherited from Element
static const string	NAME_ATTRIBUTE

static const string	FILE_PREFIX_ATTRIBUTE

static const string	GEOM_PREFIX_ATTRIBUTE

static const string	COLOR_SPACE_ATTRIBUTE

static const string	INHERIT_ATTRIBUTE

static const string	NAMESPACE_ATTRIBUTE

static const string	DOC_ATTRIBUTE

static const string	XPOS_ATTRIBUTE

static const string	YPOS_ATTRIBUTE

Additional Inherited Members
Protected Types inherited from TypedElement
using	TypeDefPtr = shared_ptr< class TypeDef >

Protected Types inherited from Element
using	DocumentPtr = shared_ptr< Document >

using	ConstDocumentPtr = shared_ptr< const Document >

Protected Member Functions inherited from TypedElement
	TypedElement (ElementPtr parent, const string &category, const string &name)

Protected Member Functions inherited from Element
	Element (ElementPtr parent, const string &category, const string &name)

template<class T >
shared_ptr< T >	resolveNameReference (const string &name, ConstElementPtr parent=nullptr) const

void	validateRequire (bool expression, bool &res, string *message, const string &errorDesc) const

virtual void	registerChildElement (ElementPtr child)

virtual void	unregisterChildElement (ElementPtr child)

ElementPtr	getSelfNonConst () const

Protected Attributes inherited from Element
string	_category

string	_name

string	_sourceUri

ElementMap	_childMap

ElementVec	_childOrder

StringMap	_attributeMap

StringVec	_attributeOrder

weak_ptr< Element >	_parent

weak_ptr< Element >	_root

Detailed Description

An attribute definition element within a Document.

Definition at line 548 of file Definition.h.

Constructor & Destructor Documentation

AttributeDef::AttributeDef	(	ElementPtr	parent,
		const string &	name
	)

inline

Definition at line 551 of file Definition.h.

virtual AttributeDef::~AttributeDef ( )

inlinevirtual

Definition at line 555 of file Definition.h.

Member Function Documentation

const string& AttributeDef::getAttrName ( ) const

inline

Return the element's attrname string.

Definition at line 573 of file Definition.h.

const string& AttributeDef::getElements ( ) const

inline

Return the element's elements string.

Definition at line 647 of file Definition.h.

bool AttributeDef::getExportable ( ) const

inline

Return the exportable boolean for the element. Defaults to false if exportable is not set.

Definition at line 664 of file Definition.h.

ValuePtr AttributeDef::getValue ( ) const

Return the typed value of an element as a generic value object, which may be queried to access its data.

Returns: A shared pointer to the typed value of this element, or an empty shared pointer if no value is present.

const string& AttributeDef::getValueString ( ) const

inline

Get the value string of a element.

Definition at line 595 of file Definition.h.

bool AttributeDef::hasAttrName ( ) const

inline

Return true if this element has an attrname string.

Definition at line 567 of file Definition.h.

bool AttributeDef::hasElements ( ) const

inline

Return true if the element has an elements string.

Definition at line 641 of file Definition.h.

bool AttributeDef::hasValue ( ) const

inline

Return true if the element possesses a typed value.

Definition at line 618 of file Definition.h.

bool AttributeDef::hasValueString ( ) const

inline

Return true if the given element has a value string.

Definition at line 589 of file Definition.h.

void AttributeDef::setAttrName ( const string & name )

inline

Set the element's attrname string.

Definition at line 561 of file Definition.h.

void AttributeDef::setElements ( const string & elements )

inline

Set the element's elements string.

Definition at line 635 of file Definition.h.

void AttributeDef::setExportable ( bool value )

inline

Set the exportable boolean for the element.

Definition at line 657 of file Definition.h.

template<class T >

void AttributeDef::setValue	(	const T &	value,
		const string &	type = `EMPTY_STRING`
	)

inline

Set the typed value of an element.

Definition at line 605 of file Definition.h.

void AttributeDef::setValue	(	const char *	value,
		const string &	type = `EMPTY_STRING`
	)

inline

Set the typed value of an element from a C-style string.

Definition at line 612 of file Definition.h.

void AttributeDef::setValueString ( const string & value )

inline

Set the value string of an element.

Definition at line 583 of file Definition.h.

Member Data Documentation

const string AttributeDef::ATTRNAME_ATTRIBUTE

static

Definition at line 673 of file Definition.h.

const string AttributeDef::CATEGORY

static

Definition at line 672 of file Definition.h.

const string AttributeDef::ELEMENTS_ATTRIBUTE

static

Definition at line 675 of file Definition.h.

const string AttributeDef::EXPORTABLE_ATTRIBUTE

static

Definition at line 676 of file Definition.h.

const string AttributeDef::VALUE_ATTRIBUTE

static

Definition at line 674 of file Definition.h.

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

MaterialXCore/Definition.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation