#include <APEX_ParmDict.h>

Public Member Functions
	APEX_ParmDict ()

	APEX_ParmDict (APEX_Buffer *external)

	APEX_ParmDict (const UT_OptionsHolder &opt)

void	operator= (const UT_OptionsHolder &opt)

APEX_ParmDict &	operator= (const APEX_ParmDict &other)

	APEX_ParmDict (const APEX_ParmDict &other)

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)

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)

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 69 of file APEX_ParmDict.h.

Constructor & Destructor Documentation

apex::APEX_ParmDict::APEX_ParmDict ( )

inline

Definition at line 74 of file APEX_ParmDict.h.

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

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

inline

Definition at line 82 of file APEX_ParmDict.h.

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

inline

Definition at line 115 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 284 of file APEX_ParmDict.h.

void apex::APEX_ParmDict::clear ( )

inline

Definition at line 269 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 117 of file APEX_ParmDict.h.

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

inline

Definition at line 285 of file APEX_ParmDict.h.

APEX_DataID apex::APEX_ParmDict::dataId ( ) const

inline

Definition at line 283 of file APEX_ParmDict.h.

bool apex::APEX_ParmDict::empty ( ) const

inline

Definition at line 122 of file APEX_ParmDict.h.

template<typename T >

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

inline

Definition at line 137 of file APEX_ParmDict.h.

template<typename T >

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

inline

Definition at line 146 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

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 266 of file APEX_ParmDict.h.

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

inline

Definition at line 267 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`
	)

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

inline

Definition at line 89 of file APEX_ParmDict.h.

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

inline

Definition at line 97 of file APEX_ParmDict.h.

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

This function removes any previously set value, so that subsequent execution will act as if set() were never called on that key. However, this does not destruct the previously-created value for this key, and that data will persist until this whole dictionary is cleared!

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 155 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 127 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 72 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