HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TypeDef Class Reference

#include <Definition.h>

+ Inheritance diagram for TypeDef:

Public Member Functions

 TypeDef (ElementPtr parent, const string &name)
 
virtual ~TypeDef ()
 
Semantic
void setSemantic (const string &semantic)
 Set the semantic string of the TypeDef. More...
 
bool hasSemantic () const
 Return true if the given TypeDef has a semantic string. More...
 
const stringgetSemantic () const
 Return the semantic string of the TypeDef. More...
 
Context
void setContext (const string &context)
 Set the context string of the TypeDef. More...
 
bool hasContext () const
 Return true if the given TypeDef has a context string. More...
 
const stringgetContext () const
 Return the context string of the TypeDef. More...
 
Member Elements
MemberPtr addMember (const string &name=EMPTY_STRING)
 
MemberPtr getMember (const string &name) const
 Return the Member, if any, with the given name. More...
 
vector< MemberPtrgetMembers () const
 Return a vector of all Member elements in the TypeDef. More...
 
void removeMember (const string &name)
 Remove the Member, if any, with the given name. More...
 
- Public Member Functions inherited from Element
virtual ~Element ()
 
 Element (const Element &)=delete
 
Elementoperator= (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 stringgetCategory () const
 
void setName (const string &name)
 
const stringgetName () 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 stringgetFilePrefix () const
 Return the element's file prefix string. More...
 
const stringgetActiveFilePrefix () 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 stringgetGeomPrefix () const
 Return the element's geom prefix string. More...
 
const stringgetActiveGeomPrefix () 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 stringgetColorSpace () const
 Return the element's color space string. More...
 
const stringgetActiveColorSpace () 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 stringgetInheritString () 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 stringgetNamespace () 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< TasA ()
 Dynamic cast to an instance of the given subclass. More...
 
template<class T >
shared_ptr< const TasA () const
 Dynamic cast to a const instance of the given subclass. More...
 
template<class T >
shared_ptr< TaddChild (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< TgetChildOfType (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 stringgetAttribute (const string &attrib) const
 
const StringVecgetAttributeNames () 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 TgetAncestorOfType () 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 stringgetSourceUri () const
 Return the element's source URI. More...
 
const stringgetActiveSourceUri () const
 
virtual bool validate (string *message=nullptr) 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< TresolveRootNameReference (const string &name) const
 

Static Public Attributes

static const string CATEGORY
 
static const string SEMANTIC_ATTRIBUTE
 
static const string CONTEXT_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
 

Additional Inherited Members

- Protected Types inherited from Element
using DocumentPtr = shared_ptr< Document >
 
using ConstDocumentPtr = shared_ptr< const Document >
 
- Protected Member Functions inherited from Element
 Element (ElementPtr parent, const string &category, const string &name)
 
void validateRequire (bool expression, bool &res, string *message, 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
 
vector< ElementPtr_childOrder
 
StringMap _attributeMap
 
StringVec _attributeOrder
 
weak_ptr< Element_parent
 
weak_ptr< Element_root
 

Detailed Description

A type definition element within a Document.

Definition at line 303 of file Definition.h.

Constructor & Destructor Documentation

TypeDef::TypeDef ( ElementPtr  parent,
const string name 
)
inline

Definition at line 306 of file Definition.h.

virtual TypeDef::~TypeDef ( )
inlinevirtual

Definition at line 310 of file Definition.h.

Member Function Documentation

MemberPtr TypeDef::addMember ( const string name = EMPTY_STRING)
inline

Add a Member to the TypeDef.

Parameters
nameThe name of the new Member. If no name is specified, then a unique name will automatically be generated.
Returns
A shared pointer to the new Member.

Definition at line 364 of file Definition.h.

const string& TypeDef::getContext ( ) const
inline

Return the context string of the TypeDef.

Definition at line 350 of file Definition.h.

MemberPtr TypeDef::getMember ( const string name) const
inline

Return the Member, if any, with the given name.

Definition at line 370 of file Definition.h.

vector<MemberPtr> TypeDef::getMembers ( ) const
inline

Return a vector of all Member elements in the TypeDef.

Definition at line 376 of file Definition.h.

const string& TypeDef::getSemantic ( ) const
inline

Return the semantic string of the TypeDef.

Definition at line 328 of file Definition.h.

bool TypeDef::hasContext ( ) const
inline

Return true if the given TypeDef has a context string.

Definition at line 344 of file Definition.h.

bool TypeDef::hasSemantic ( ) const
inline

Return true if the given TypeDef has a semantic string.

Definition at line 322 of file Definition.h.

void TypeDef::removeMember ( const string name)
inline

Remove the Member, if any, with the given name.

Definition at line 382 of file Definition.h.

void TypeDef::setContext ( const string context)
inline

Set the context string of the TypeDef.

Definition at line 338 of file Definition.h.

void TypeDef::setSemantic ( const string semantic)
inline

Set the semantic string of the TypeDef.

Definition at line 316 of file Definition.h.

Member Data Documentation

const string TypeDef::CATEGORY
static

Definition at line 390 of file Definition.h.

const string TypeDef::CONTEXT_ATTRIBUTE
static

Definition at line 392 of file Definition.h.

const string TypeDef::SEMANTIC_ATTRIBUTE
static

Definition at line 391 of file Definition.h.


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