#include <APEX_ParmDict.h>

Public Member Functions
	APEX_ParmDict ()

	APEX_ParmDict (APEX_Buffer *external)

	APEX_ParmDict (const UT_OptionsHolder &opt)

	APEX_ParmDict (const APEX_ParmDict &other)

APEX_ParmDict &	operator= (const APEX_ParmDict &other)

void	operator= (const UT_OptionsHolder &opt)

bool	contains (const UT_StringRef &key) const

bool	empty () const

exint	size () const

void	bindGraphData (const APEX_Graph &graph, const APEX_PortIDRange &ports)

APEX_TrackedArgument *	getHandle (const UT_StringRef &key)

const APEX_TrackedArgument *	getHandle (const UT_StringRef &key) const

template<typename T >
const T *	get (const UT_StringRef &key) const

template<typename T >
T *	get (const UT_StringRef &key)

const UT_Optional< Bool >	getBoolOrInt (const UT_StringRef &key) const
	Helper function to extract a boolean value from either an int or bool dict value. More...

template<typename T >
T	getValueOr (const UT_StringRef &key, T defValue) const

template<typename T >
void	set (const UT_StringRef &key, const T &value, bool add_missing=true, bool allow_type_change=false, bool bump_data_id=true)

bool	set (const UT_StringRef &key, const APEX_Argument &arg, bool add_missing=true, bool allow_type_change=false, bool force_update=false, bool bump_data_id=true, bool bump_data_id_on_conversion=true)

bool	set (const UT_StringRef &key, const APEX_TrackedArgument &arg, bool add_missing=true, bool allow_type_change=false, bool force_update=false, bool bump_data_id=true, bool bump_data_id_on_conversion=true)

void	renameEntry (const UT_StringRef &key, const UT_StringRef &newname)

bool	sharesBuffer (const APEX_ParmDict &other) const

APEX_Buffer *	buffer () const

UT_StringArray	compareDataIds (const APEX_ParmDict &other, bool check_missing=false)

void	update (const APEX_ParmDict &other, bool add_missing=false, bool allow_type_change=false, bool force_copy=false, UT_StringArray *changelist=nullptr, bool bump_data_id_on_conversion=true)

void	mergeUtOptions (const UT_OptionsHolder &opt_h, bool clear=false, bool add_missing=true, bool allow_type_change=true, const APEX_Signature *signature=nullptr)

void	updateUtOptions (UT_Options &opt_h, bool clear=false, bool include_geometry=false, bool include_typeinfo=true) const

void	updateUtOptions (UT_OptionsHolder &opt_h, bool clear=false, bool include_geometry=false, bool include_typeinfo=true) const

UT_ArrayStringMap < APEX_TrackedArgument > &	map ()

const UT_ArrayStringMap < APEX_TrackedArgument > &	map () const

void	clear ()

bool	remove (const UT_StringRef &key)

APEX_DataID	dataId () const

void	bumpDataId ()

void	copyDataId (const APEX_ParmDict &other)

int64	getMemoryUsage () const

Static Public Member Functions
static bool	isValidKey (const UT_StringRef &key, UT_StringHolder *err_msg=nullptr)

Static Public Attributes
static constexpr UT_StringLit	theTypeSuffix = ".__type__"

Detailed Description

Definition at line 72 of file APEX_ParmDict.h.

Constructor & Destructor Documentation

apex::APEX_ParmDict::APEX_ParmDict ( )

inline

Definition at line 77 of file APEX_ParmDict.h.

apex::APEX_ParmDict::APEX_ParmDict ( APEX_Buffer * external )

inlineexplicit

Definition at line 82 of file APEX_ParmDict.h.

apex::APEX_ParmDict::APEX_ParmDict ( const UT_OptionsHolder & opt )

inline

Definition at line 87 of file APEX_ParmDict.h.

apex::APEX_ParmDict::APEX_ParmDict ( const APEX_ParmDict & other )

inline

Definition at line 93 of file APEX_ParmDict.h.

Member Function Documentation

void apex::APEX_ParmDict::bindGraphData	(	const APEX_Graph &	graph,
		const APEX_PortIDRange &	ports
	)

APEX_Buffer* apex::APEX_ParmDict::buffer ( ) const

void apex::APEX_ParmDict::bumpDataId ( )

inline

Definition at line 328 of file APEX_ParmDict.h.

void apex::APEX_ParmDict::clear ( )

inline

Definition at line 312 of file APEX_ParmDict.h.

UT_StringArray apex::APEX_ParmDict::compareDataIds	(	const APEX_ParmDict &	other,
		bool	check_missing = `false`
	)

bool apex::APEX_ParmDict::contains ( const UT_StringRef & key ) const

inline

Definition at line 139 of file APEX_ParmDict.h.

void apex::APEX_ParmDict::copyDataId ( const APEX_ParmDict & other )

inline

Definition at line 329 of file APEX_ParmDict.h.

APEX_DataID apex::APEX_ParmDict::dataId ( ) const

inline

Definition at line 327 of file APEX_ParmDict.h.

bool apex::APEX_ParmDict::empty ( ) const

inline

Definition at line 144 of file APEX_ParmDict.h.

template<typename T >

const T* apex::APEX_ParmDict::get ( const UT_StringRef & key ) const

inline

Definition at line 159 of file APEX_ParmDict.h.

template<typename T >

T* apex::APEX_ParmDict::get ( const UT_StringRef & key )

inline

Definition at line 168 of file APEX_ParmDict.h.

const UT_Optional<Bool> apex::APEX_ParmDict::getBoolOrInt ( const UT_StringRef & key ) const

inline

Helper function to extract a boolean value from either an int or bool dict value.

Definition at line 178 of file APEX_ParmDict.h.

APEX_TrackedArgument* apex::APEX_ParmDict::getHandle ( const UT_StringRef & key )

const APEX_TrackedArgument* apex::APEX_ParmDict::getHandle ( const UT_StringRef & key ) const

int64 apex::APEX_ParmDict::getMemoryUsage ( ) const

template<typename T >

T apex::APEX_ParmDict::getValueOr	(	const UT_StringRef &	key,
		T	defValue
	)		const

inline

Definition at line 189 of file APEX_ParmDict.h.

static bool apex::APEX_ParmDict::isValidKey	(	const UT_StringRef &	key,
		UT_StringHolder *	err_msg = `nullptr`
	)

static

UT_ArrayStringMap<APEX_TrackedArgument>& apex::APEX_ParmDict::map ( )

inline

Definition at line 309 of file APEX_ParmDict.h.

const UT_ArrayStringMap<APEX_TrackedArgument>& apex::APEX_ParmDict::map ( ) const

inline

Definition at line 310 of file APEX_ParmDict.h.

void apex::APEX_ParmDict::mergeUtOptions	(	const UT_OptionsHolder &	opt_h,
		bool	clear = `false`,
		bool	add_missing = `true`,
		bool	allow_type_change = `true`,
		const APEX_Signature *	signature = `nullptr`
	)

APEX_ParmDict& apex::APEX_ParmDict::operator= ( const APEX_ParmDict & other )

inline

Definition at line 108 of file APEX_ParmDict.h.

void apex::APEX_ParmDict::operator= ( const UT_OptionsHolder & opt )

inline

Definition at line 131 of file APEX_ParmDict.h.

bool apex::APEX_ParmDict::remove ( const UT_StringRef & key )

This function removes any previously set value such that subsequent execution will act as if set() were never called on that key. It will also reset the value back to its default state. However, the default value will continue to occupy memory in the buffer until the entire buffer is cleared using clear().

void apex::APEX_ParmDict::renameEntry	(	const UT_StringRef &	key,
		const UT_StringRef &	newname
	)

template<typename T >

void apex::APEX_ParmDict::set	(	const UT_StringRef &	key,
		const T &	value,
		bool	add_missing = `true`,
		bool	allow_type_change = `false`,
		bool	bump_data_id = `true`
	)

inline

Definition at line 198 of file APEX_ParmDict.h.

bool apex::APEX_ParmDict::set	(	const UT_StringRef &	key,
		const APEX_Argument &	arg,
		bool	add_missing = `true`,
		bool	allow_type_change = `false`,
		bool	force_update = `false`,
		bool	bump_data_id = `true`,
		bool	bump_data_id_on_conversion = `true`
	)

bool apex::APEX_ParmDict::set	(	const UT_StringRef &	key,
		const APEX_TrackedArgument &	arg,
		bool	add_missing = `true`,
		bool	allow_type_change = `false`,
		bool	force_update = `false`,
		bool	bump_data_id = `true`,
		bool	bump_data_id_on_conversion = `true`
	)

bool apex::APEX_ParmDict::sharesBuffer ( const APEX_ParmDict & other ) const

exint apex::APEX_ParmDict::size ( ) const

inline

Definition at line 149 of file APEX_ParmDict.h.

void apex::APEX_ParmDict::update	(	const APEX_ParmDict &	other,
		bool	add_missing = `false`,
		bool	allow_type_change = `false`,
		bool	force_copy = `false`,
		UT_StringArray *	changelist = `nullptr`,
		bool	bump_data_id_on_conversion = `true`
	)

void apex::APEX_ParmDict::updateUtOptions	(	UT_Options &	opt_h,
		bool	clear = `false`,
		bool	include_geometry = `false`,
		bool	include_typeinfo = `true`
	)		const

void apex::APEX_ParmDict::updateUtOptions	(	UT_OptionsHolder &	opt_h,
		bool	clear = `false`,
		bool	include_geometry = `false`,
		bool	include_typeinfo = `true`
	)		const

Member Data Documentation

constexpr UT_StringLit apex::APEX_ParmDict::theTypeSuffix = ".__type__"

static

Definition at line 75 of file APEX_ParmDict.h.

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

APEX/APEX_ParmDict.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation