#include <PDG_AttributeDictionary.h>

Inheritance diagram for PDG_AttributeDictionary:

Public Types
using	Base = PDG_AttributeArray< PDG_AttributeType::eDictArray, UT_OptionsHolder, UT_Array< UT_OptionsHolder >>

Public Types inherited from PDG_AttributeArray< PDG_AttributeType::eDictArray, UT_OptionsHolder, UT_Array< UT_OptionsHolder > >
using	Self = PDG_AttributeArray< AttribType, UT_OptionsHolder, UT_Array< UT_OptionsHolder > >

using	Data = UT_OptionsHolder

using	Array = UT_Array< UT_OptionsHolder >

using	Map = UT_StringMap< UT_Array< UT_OptionsHolder > >

Public Member Functions
	~PDG_AttributeDictionary () override

int64	getMemoryUsage (bool inclusive) const override
	Returns the total memory usage of all data on this attribute. More...

PDG_AttributeData *	clone () const override

bool	saveData (UT_JSONWriter &writer) const override
	Writes the dictionary data to the json writer. More...

void	saveData (const UT_StringHolder &key, UT_OptionsHolder &dict) const override
	Writes the dictionary data to the json writer. More...

bool	loadData (const UT_JSONValue &value) override
	Reads the dictionary data from the json value. More...

bool	loadData (const UT_StringHolder &key, const UT_OptionsHolder &dict) override
	Reads the dictionary data from the dict. More...

bool	desc (UT_WorkBuffer &result, bool pretty_print=false) const
	Writes a string representation of the dictionaries to the buffer. More...

bool	desc (UT_StringHolder &result, bool pretty_print=false) const

bool	desc (UT_WorkBuffer &result, int component, bool pretty_print=false) const

bool	desc (UT_StringHolder &result, int component, bool pretty_print=false) const

void	setValue (const UT_StringArray &reprs)
	Sets values from an array of python dictionary representations. More...

void	setValue (const UT_StringHolder &repr, int component)
	Sets a value from a python dictionary string representation. More...

void	mergeValue (const UT_OptionsHolder &options, int component)

void	removeKeys (const PDG_AttributePattern &pattern, int component)

void	importAttributes (const PDG_AttributePattern &pattern, const PDG_AttributeMap &attributes, int component, PDG_AttributeOverwrite overwrite)
	Imports the specified attributes as key/value pairs in the dictionary. More...

void	mergeAttributes (const PDG_AttributePattern &pattern, const PDG_AttributeMap &attributes, int component)

PDG_AttributeCast	query (fpreal &result, const PDG_AttributeQuery &query, exint &query_index, int component) const

PDG_AttributeCast	query (fpreal &result, const UT_StringHolder &str, int component) const

PDG_AttributeCast	query (UT_WorkBuffer &result, const PDG_AttributeQuery &query, exint &query_index, int component) const

PDG_AttributeCast	query (UT_WorkBuffer &result, const UT_StringHolder &str, int component) const

Public Member Functions inherited from PDG_AttributeArray< PDG_AttributeType::eDictArray, UT_OptionsHolder, UT_Array< UT_OptionsHolder > >
	PDG_AttributeArray ()

	PDG_AttributeArray (const UT_Array< UT_OptionsHolder > &data)

	~PDG_AttributeArray () override

bool	hasData () const

int	size () const

bool	valid (int component) const

bool	value (UT_OptionsHolder &data, int component) const

const UT_OptionsHolder &	value (int component) const

UT_OptionsHolder &	value (int component)

void	setValue (const UT_Array< UT_OptionsHolder > &data)

void	setValue (const UT_Array< UT_OptionsHolder > &&data)

void	setValue (const UT_OptionsHolder &value, int component)

void	setValues (const UT_Array< UT_OptionsHolder > &data)

const UT_OptionsHolder &	appendValue (const UT_OptionsHolder &value)

const UT_Array < UT_OptionsHolder > &	values () const

UT_Array< UT_OptionsHolder > &	values ()

void	clear ()

void	truncate (int length)

bool	concat (const Self *other)

bool	adjustSize (int offset)

bool	setSize (int size)

bool	hash (SYS_HashType &hash_value, exint index, UT_WorkBuffer &errors) const override
	Return a hash value derived from the attribute data. More...

void	swap (Self *other)

void	copy (const Self *other, PDG_AttributeCopyOp copy_op)

void	copy (const UT_Array< UT_OptionsHolder > &data, PDG_AttributeCopyOp copy_op)

bool	compare (const PDG_AttributeData *other) const override
	Compares this data object with another data object. More...

PDG_AttributeMergeError	merge (PDG_AttributeMergeOp merge_op, int stride) override
	Applies a merge op to the data in this attribute. More...

bool	slice (UT_Array< UT_OptionsHolder > &result, exint start, UT_Optional< exint > end_opt=UT_Optional< exint >(), UT_Optional< exint > step_opt=UT_Optional< exint >()) const

Public Member Functions inherited from PDG_AttributeData
	PDG_AttributeData ()

virtual	~PDG_AttributeData ()

Additional Inherited Members
Static Public Member Functions inherited from PDG_AttributeData
static PDG_AttributeData *	fromType (PDG_AttributeType type)

static PDG_EventType	eventType (PDG_AttributeType type)
	Static utility for returnign an event from type from an attribute type. More...

static PDG_AttributeType	typeFromString (const UT_StringHolder &type_name)
	Returns an attribute type enum from the specified string name. More...

static PDG_AttributeIntrinsic	intrinsicFromName (const UT_StringRef &name)
	Returns an intrinsic type from an attribue name. More...

static UT_StringHolder	nameFromIntrinsic (PDG_AttributeIntrinsic attrib_type, const UT_StringHolder &name)
	Returns an attribute name from a intrinsic type a name string. More...

static bool	validName (const UT_StringHolder &str, bool allow_internal=false)

static bool	makeValidName (UT_StringHolder &name, const UT_StringHolder &str, bool allow_internal=false)

static UT_StringHolder	typeName (PDG_AttributeType type)
	Returns the string name for the specififed attribute type. More...

static UT_StringHolder	mergeName (PDG_AttributeMergeOp merge)
	Returns the string name for the specified merge op. More...

static bool	isArrayType (PDG_AttributeType type)
	Returns true if the specified type is an array type. More...

static PDG_AttributeType	compatibleType (PDG_AttributeType left, PDG_AttributeType right)

Static Public Attributes inherited from PDG_AttributeArray< PDG_AttributeType::eDictArray, UT_OptionsHolder, UT_Array< UT_OptionsHolder > >
static constexpr PDG_AttributeType	TypeEnum

Static Public Attributes inherited from PDG_AttributeData
static constexpr PDG_AttributeType	TypeEnum = PDG_AttributeType::eUndefined
	Attribute data version number. More...

static const UT_StringHolder	theFlagKey

static const UT_StringHolder	theTypeKey

static const UT_StringHolder	theRuntimeKey

static const UT_StringHolder	theConcatKey

static const UT_StringHolder	theOwnKey

static const UT_StringHolder	theValueKey

Protected Member Functions inherited from PDG_AttributeArray< PDG_AttributeType::eDictArray, UT_OptionsHolder, UT_Array< UT_OptionsHolder > >
void	expand (const UT_OptionsHolder &value, int component)

void	expandIfNeeded (const UT_OptionsHolder &default_value, int component)

Static Protected Member Functions inherited from PDG_AttributeData
static PDG_AttributeMergeError	merge (UT_StringArray &data, PDG_AttributeMergeOp merge_op, int stride)
	Merge op utility for string array data. More...

static PDG_AttributeMergeError	merge (PDG_File::Array &data, PDG_AttributeMergeOp merge_op, int stride)
	Merge op utility for file array data. More...

static PDG_AttributeMergeError	merge (UT_ValArray< fpreal > &data, PDG_AttributeMergeOp merge_op, int stride)
	Merge op utility for float array data. More...

static PDG_AttributeMergeError	merge (UT_ValArray< exint > &data, PDG_AttributeMergeOp merge_op, int stride)
	Merge op utility for int array data. More...

static PDG_AttributeMergeError	merge (UT_Array< UT_OptionsHolder > &data, PDG_AttributeMergeOp merge_op, int stride)
	Merge op utility for dict array data. More...

Protected Attributes inherited from PDG_AttributeArray< PDG_AttributeType::eDictArray, UT_OptionsHolder, UT_Array< UT_OptionsHolder > >
UT_Array< UT_OptionsHolder >	myData

Detailed Description

Dictionary attribute type

Definition at line 31 of file PDG_AttributeDictionary.h.

Member Typedef Documentation

using PDG_AttributeDictionary::Base = PDG_AttributeArray< PDG_AttributeType::eDictArray, UT_OptionsHolder, UT_Array<UT_OptionsHolder>>

Definition at line 40 of file PDG_AttributeDictionary.h.

Constructor & Destructor Documentation

PDG_AttributeDictionary::~PDG_AttributeDictionary ( )

override

Member Function Documentation

PDG_AttributeData* PDG_AttributeDictionary::clone ( ) const

overridevirtual

Constructs a new dictionary attribute that copies the data from this attribute

Implements PDG_AttributeData.

bool PDG_AttributeDictionary::desc	(	UT_WorkBuffer &	result,
		bool	pretty_print = `false`
	)		const

Writes a string representation of the dictionaries to the buffer.

bool PDG_AttributeDictionary::desc	(	UT_StringHolder &	result,
		bool	pretty_print = `false`
	)		const

bool PDG_AttributeDictionary::desc	(	UT_WorkBuffer &	result,
		int	component,
		bool	pretty_print = `false`
	)		const

Writes a string representation of the dictionary at the specified index to the buffer

bool PDG_AttributeDictionary::desc	(	UT_StringHolder &	result,
		int	component,
		bool	pretty_print = `false`
	)		const

int64 PDG_AttributeDictionary::getMemoryUsage ( bool inclusive ) const

overridevirtual

Returns the total memory usage of all data on this attribute.

Implements PDG_AttributeData.

void PDG_AttributeDictionary::importAttributes	(	const PDG_AttributePattern &	pattern,
		const PDG_AttributeMap &	attributes,
		int	component,
		PDG_AttributeOverwrite	overwrite
	)

Imports the specified attributes as key/value pairs in the dictionary.

bool PDG_AttributeDictionary::loadData ( const UT_JSONValue & value )

overridevirtual

Reads the dictionary data from the json value.

Implements PDG_AttributeData.

bool PDG_AttributeDictionary::loadData	(	const UT_StringHolder &	key,
		const UT_OptionsHolder &	dict
	)

overridevirtual

Reads the dictionary data from the dict.

Implements PDG_AttributeData.

void PDG_AttributeDictionary::mergeAttributes	(	const PDG_AttributePattern &	pattern,
		const PDG_AttributeMap &	attributes,
		int	component
	)

Imports the specified dictionary attribute key/value pairs into this dictionary.

void PDG_AttributeDictionary::mergeValue	(	const UT_OptionsHolder &	options,
		int	component
	)

Merges the dictionary into a dictionary in this attribute at the specified index

PDG_AttributeCast PDG_AttributeDictionary::query	(	fpreal &	result,
		const PDG_AttributeQuery &	query,
		exint &	query_index,
		int	component
	)		const

Queries a floating point value from the dictionary, using the specified query string and index

PDG_AttributeCast PDG_AttributeDictionary::query	(	fpreal &	result,
		const UT_StringHolder &	str,
		int	component
	)		const

PDG_AttributeCast PDG_AttributeDictionary::query	(	UT_WorkBuffer &	result,
		const PDG_AttributeQuery &	query,
		exint &	query_index,
		int	component
	)		const

Queries a string value from the dictionary, using the specified query string and index

PDG_AttributeCast PDG_AttributeDictionary::query	(	UT_WorkBuffer &	result,
		const UT_StringHolder &	str,
		int	component
	)		const

void PDG_AttributeDictionary::removeKeys	(	const PDG_AttributePattern &	pattern,
		int	component
	)

Removes any dictionary entries at the specified index that match the attribute pattern

bool PDG_AttributeDictionary::saveData ( UT_JSONWriter & writer ) const

overridevirtual

Writes the dictionary data to the json writer.

Implements PDG_AttributeData.

void PDG_AttributeDictionary::saveData	(	const UT_StringHolder &	key,
		UT_OptionsHolder &	dict
	)		const

overridevirtual

Writes the dictionary data to the json writer.

Implements PDG_AttributeData.

void PDG_AttributeDictionary::setValue ( const UT_StringArray & reprs )

Sets values from an array of python dictionary representations.

void PDG_AttributeDictionary::setValue	(	const UT_StringHolder &	repr,
		int	component
	)

Sets a value from a python dictionary string representation.

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

PDG/PDG_AttributeDictionary.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation