HDK
|
#include <PDG_AttributeRef.h>
Public Types | |
using | Self = PDG_AttributeRefT< Attribute, Holder > |
Public Member Functions | |
PDG_AttributeRefT (Holder *holder, const UT_StringHolder &name, const PDG_AttributeOwner *owner, PDG_AttributeError error=PDG_AttributeError::eNone) | |
Holder * | holder () const |
Returns the underlying attribute holder. More... | |
const Attribute * | attribute () const |
Returns a const pointer to the underlying attribute instance. More... | |
template<typename T > | |
const T * | attributeT () const |
const Attribute * | operator-> () const |
Returns a const pointer to the underlying attribute instance. More... | |
bool | hasData () const |
Returns true if the contained attribute has any data. More... | |
bool | isOwner () const |
Returns true if the contained attribute holder owns its data. More... | |
PDG_AttributeType | type () const |
Returns the type of the contained attribute. More... | |
uint16 | flags () const |
Returns the flags on the contained holder. More... | |
bool | hasAnyFlags () const |
Returns true if the contained holder has any flags set. More... | |
bool | hasFlag (PDG_AttributeFlag flag) const |
Returns true if the contained holder has the specified flag set. More... | |
bool | hasFlags (uint16 flags) const |
Returns true if the contained holder has all of the specified flags set. More... | |
bool | hasAnyFlags (uint16 flags) const |
Returns true if the contained holder has any of the specified flags set. More... | |
bool | isNumeric () const |
Returns true if the attribute is numeric. More... | |
bool | isArray () const |
Returns true if the attribute is an array. More... | |
PDG_AttributeCast | asNumber (fpreal &number, exint &query_index, const PDG_AttributeQuery &query, int index, bool has_component) const |
PDG_AttributeCast | asNumber (fpreal &number, int index) const |
PDG_AttributeCast | asFile (PDG_File &file, int index, const UT_StringHolder &tag=UT_StringHolder::theEmptyString, PDG_File::Hash hash=0, bool own=false) const |
PDG_AttributeCast | asString (UT_WorkBuffer &buffer, exint &query_index, const PDG_AttributeQuery &query, int index, int pad, bool has_component) const |
PDG_AttributeCast | asString (UT_WorkBuffer &buffer, int index, int pad=0) const |
PDG_AttributeCast | asStringValues (UT_WorkBuffer &buffer, int pad=0) const |
Prints the values contained in the attribute to space-separated string. More... | |
PDG_AttributeCast | asOptions (UT_Options &options, PDG_AttributeOverwrite overwrite) const |
PDG_AttributeCast | asOptions (UT_Options &options, const UT_StringHolder &key, PDG_AttributeOverwrite overwrite) const |
int | size () const |
Returns the size of the data stored in the attribute. More... | |
Public Member Functions inherited from PDG_AttributeRef | |
PDG_AttributeRef (const UT_StringHolder &name, const PDG_AttributeOwner *owner, PDG_AttributeError error=PDG_AttributeError::eNone) | |
operator bool () const | |
Returns true if the handle is valid. More... | |
bool | isValid () const |
Returns true if the handle is valid. More... | |
PDG_AttributeError | error () const |
Returns the error state of the handle. More... | |
const UT_StringHolder & | name () const |
Returns the name of the attribute referenced by this attrib ref. More... | |
const PDG_AttributeOwner * | owner () const |
Returns the PDG_AttributeOwner that owns the underlying attribute. More... | |
bool | validate (UT_WorkBuffer &buffer) const |
bool | validate (const PDG_Node *node, bool report_errors=true, bool as_warning=false) const |
Protected Attributes | |
Holder * | myHolder |
Protected Attributes inherited from PDG_AttributeRef | |
UT_StringHolder | myName |
const PDG_AttributeOwner * | myOwner |
PDG_AttributeError | myError |
Additional Inherited Members | |
Static Public Member Functions inherited from PDG_AttributeRef | |
static bool | attributeError (UT_WorkBuffer &buffer, PDG_AttributeError error, const UT_StringHolder &attrib_name, const PDG_AttributeOwner *owner=nullptr) |
static void | attributeModified (const PDG_AttributeOwner *owner, PDG_AttributeType attrib_type, const UT_StringHolder &attrib_name) |
Emits events when the attribute is modified. More... | |
Base class for templated attribute references
Definition at line 109 of file PDG_AttributeRef.h.
using PDG_AttributeRefT< Attribute, Holder >::Self = PDG_AttributeRefT<Attribute, Holder> |
Definition at line 112 of file PDG_AttributeRef.h.
|
inlineexplicit |
Definition at line 115 of file PDG_AttributeRef.h.
|
inline |
Casts the value contained in the attribute to a PDG_File object. Only valid for string, file and PyObject attribute types
Definition at line 274 of file PDG_AttributeRef.h.
|
inline |
Casts the value contained in the attribute at the particular index to a numeric value, by looking up the value with the query string. Falls a regular cast if query strings aren't supported
Definition at line 218 of file PDG_AttributeRef.h.
|
inline |
Casts the value contained in the attribute at the particular index to a numeric value, if possible.
Definition at line 244 of file PDG_AttributeRef.h.
|
inline |
Imports the attribute data in the ref into a UT_Options instance using the name of this attribute as the key string
Definition at line 554 of file PDG_AttributeRef.h.
|
inline |
Imports the attribute data in the ref into an UT_Options instance using the specified key string
Definition at line 563 of file PDG_AttributeRef.h.
|
inline |
Casts the value contained in the attribute at the particular index to a string value, by looking up the value with the query string. Falls a regular cast if query strings aren't supported
Definition at line 341 of file PDG_AttributeRef.h.
|
inline |
Casts the value contained in the attribute at the particular index to a string value, if possible.
Definition at line 368 of file PDG_AttributeRef.h.
|
inline |
Prints the values contained in the attribute to space-separated string.
Definition at line 458 of file PDG_AttributeRef.h.
|
inline |
Returns a const pointer to the underlying attribute instance.
Definition at line 132 of file PDG_AttributeRef.h.
|
inline |
Returns a const pointer to the underlying attribute instance, casted to the specified type
Definition at line 139 of file PDG_AttributeRef.h.
|
inline |
Returns the flags on the contained holder.
Definition at line 169 of file PDG_AttributeRef.h.
|
inline |
Returns true if the contained holder has any flags set.
Definition at line 175 of file PDG_AttributeRef.h.
|
inline |
Returns true if the contained holder has any of the specified flags set.
Definition at line 193 of file PDG_AttributeRef.h.
|
inline |
Returns true if the contained attribute has any data.
Definition at line 151 of file PDG_AttributeRef.h.
|
inline |
Returns true if the contained holder has the specified flag set.
Definition at line 181 of file PDG_AttributeRef.h.
|
inline |
Returns true if the contained holder has all of the specified flags set.
Definition at line 187 of file PDG_AttributeRef.h.
|
inline |
Returns the underlying attribute holder.
Definition at line 126 of file PDG_AttributeRef.h.
|
inline |
Returns true if the attribute is an array.
Definition at line 206 of file PDG_AttributeRef.h.
|
inline |
Returns true if the attribute is numeric.
Definition at line 199 of file PDG_AttributeRef.h.
|
inline |
Returns true if the contained attribute holder owns its data.
Definition at line 157 of file PDG_AttributeRef.h.
|
inline |
Returns a const pointer to the underlying attribute instance.
Definition at line 145 of file PDG_AttributeRef.h.
|
inline |
Returns the size of the data stored in the attribute.
Definition at line 689 of file PDG_AttributeRef.h.
|
inline |
Returns the type of the contained attribute.
Definition at line 163 of file PDG_AttributeRef.h.
|
protected |
Definition at line 741 of file PDG_AttributeRef.h.