|
HDK
|
#include <Element.h>
Inheritance diagram for Token:Public Member Functions | |
| Token (ElementPtr parent, const string &name) | |
| virtual | ~Token () |
| Public Member Functions inherited from ValueElement | |
| virtual | ~ValueElement () |
| 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... | |
| string | getResolvedValueString (StringResolverPtr resolver=nullptr) const |
| void | setInterfaceName (const string &name) |
| Set the interface name of an element. More... | |
| bool | hasInterfaceName () const |
| Return true if the given element has an interface name. More... | |
| const string & | getInterfaceName () const |
| Return the interface name of an element. More... | |
| void | setImplementationName (const string &name) |
| Set the implementation name of an element. More... | |
| bool | hasImplementationName () const |
| Return true if the given element has an implementation name. More... | |
| const string & | getImplementationName () const |
| Return the implementation name of an element. More... | |
| 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 |
| ValuePtr | getResolvedValue (StringResolverPtr resolver=nullptr) const |
| ValuePtr | getDefaultValue () const |
| void | setUnit (const string &unit) |
| Set the unit string of an element. More... | |
| bool | hasUnit () const |
| Return true if the given element has a unit string. More... | |
| const string & | getUnit () const |
| Return the unit string of an element. More... | |
| const string & | getActiveUnit () const |
| void | setUnitType (const string &unit) |
| Set the unit type of an element. More... | |
| bool | hasUnitType () const |
| Return true if the given element has a unit type. More... | |
| const string & | getUnitType () const |
| Return the unit type of an element. More... | |
| void | setIsUniform (bool value) |
| Set the uniform attribute flag on this element. More... | |
| bool | getIsUniform () const |
| The the uniform attribute flag for this element. More... | |
| bool | validate (string *message=nullptr) const override |
| 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 | 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 vector< ElementPtr > & | 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< const T > | getAncestorOfType () const |
| TreeIterator | traverseTree () const |
| GraphIterator | traverseGraph () const |
| virtual Edge | getUpstreamEdge (size_t index=0) const |
| virtual size_t | getUpstreamEdgeCount () const |
| Return the number of queriable 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 |
| void | copyContentFrom (const ConstElementPtr &source) |
| 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 |
| template<class T > | |
| shared_ptr< T > | resolveRootNameReference (const string &name) const |
A token element representing a string value.
Token elements are used to define input and output values for string substitutions in image filenames.
|
inline |
1.8.6 
