HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PDG_ROAttributeRef< Attribute > Class Template Reference

#include <PDG_AttributeRef.h>

+ Inheritance diagram for PDG_ROAttributeRef< Attribute >:

Public Types

using Base = PDG_AttributeRefT< Attribute, const PDG_AttributeHolder >
 
- Public Types inherited from PDG_AttributeRefT< Attribute, const PDG_AttributeHolder >
using Self = PDG_AttributeRefT< Attribute, const PDG_AttributeHolder >
 
- Public Types inherited from PDG_AttributeRef
enum  Error {
  eErrorNone, eErrorUnspecified, eErrorNotFound, eErrorReadOnly,
  eErrorInternal, eErrorAttributesReadOnly, eErrorTypeConflict, eErrorTypeUpgrade,
  eErrorOverwrite, eErrorUninitialized, eErrorInvalidFlag
}
 

Additional Inherited Members

- Public Member Functions inherited from PDG_AttributeRefT< Attribute, const PDG_AttributeHolder >
 PDG_AttributeRefT (const PDG_AttributeHolder *holder, const UT_StringHolder &name, const PDG_AttributeOwner *owner, PDG_AttributeRef::Error error=eErrorNone)
 
const PDG_AttributeHolderholder () const
 Returns the underlying attribute holder. More...
 
const Attributeattribute () const
 Returns a const pointer to the underlying attribute instance. More...
 
const TattributeT () const
 
const Attributeoperator-> () 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 hasAnyFlags (uint16 flags) const
 Returns true if the contained holder has any of the specified 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 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, const UT_StringHolder &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, const UT_StringHolder &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...
 
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, Error error=eErrorNone)
 
 operator bool () const
 Returns true if the handle is valid. More...
 
bool isValid () const
 Returns true if the handle is valid. More...
 
Error error () const
 Returns the error state of the handle. More...
 
const UT_StringHoldername () const
 Returns the name of the attribute referenced by this attrib ref. More...
 
const PDG_AttributeOwnerowner () 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
 
- Static Public Member Functions inherited from PDG_AttributeRef
static bool attributeError (UT_WorkBuffer &buffer, Error 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...
 
- Protected Attributes inherited from PDG_AttributeRefT< Attribute, const PDG_AttributeHolder >
const PDG_AttributeHoldermyHolder
 
- Protected Attributes inherited from PDG_AttributeRef
UT_StringHolder myName
 
const PDG_AttributeOwnermyOwner
 
Error myError
 

Detailed Description

template<typename Attribute>
class PDG_ROAttributeRef< Attribute >

Read-only, const attribute ref

Definition at line 610 of file PDG_AttributeRef.h.

Member Typedef Documentation

Definition at line 614 of file PDG_AttributeRef.h.


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