UN_NodeSignature Class Reference

#include <UN_NodeSignature.h>

Public Types
using	InputNameAndTypeRange = UT_IteratorRange< UN_NameAndTypeIterator >
	Iterating over all inputs in the signature. More...
using	OutputNameAndTypeRange = UT_IteratorRange< UN_NameAndTypeIterator >
	Iterating over all outputs in the signature. More...
using	ParmNameAndTypeRange = UT_IteratorRange< UN_NameAndTypeIterator >
	Iterating over all parms in the signature. More...

Public Member Functions
	UN_NodeSignature (const UT_StringRef &signature_name=UT_StringRef(), const UT_StringRef &signature_label=UT_StringRef())
	Constructor. More...
const UT_StringHolder &	name () const
	Returns the name of the signature. More...
const UT_StringHolder &	label () const
	Returns the label of the signature. More...
bool	addInput (const UT_StringRef &name, const UT_StringRef &type_name)
const UT_StringArray &	inputNames () const
	Returns the list of input names. More...
const UT_StringArray &	inputTypeNames () const
	Returns the list of input type names. More...
const UT_StringHolder &	inputTypeName (const UT_StringRef &name) const
	Returns the input type name given its name. More...
InputNameAndTypeRange	inputNameAndTypeRange () const
bool	addOutput (const UT_StringRef &name, const UT_StringRef &type_name)
const UT_StringArray &	outputNames () const
	Returns the list of output names. More...
const UT_StringArray &	outputTypeNames () const
	Returns the list of output type names. More...
OutputNameAndTypeRange	outputNameAndTypeRange () const
bool	addParm (const UT_StringRef &name, const UT_StringRef &type_name)
const UT_StringArray &	parmNames () const
	Returns the list of parameter names. More...
const UT_StringArray &	parmTypeNames () const
	Returns the list of parameter type names. More...
ParmNameAndTypeRange	parmNameAndTypeRange () const

Detailed Description

The node signature represents a set of available variations of the functional part of the node type, ie, (mainly) the different set of inputs and outputs, and their types, as well as their corresponding parameters.

Definition at line 30 of file UN_NodeSignature.h.

Member Typedef Documentation

using UN_NodeSignature::InputNameAndTypeRange = UT_IteratorRange< UN_NameAndTypeIterator >

Iterating over all inputs in the signature.

Definition at line 63 of file UN_NodeSignature.h.

using UN_NodeSignature::OutputNameAndTypeRange = UT_IteratorRange< UN_NameAndTypeIterator >

Iterating over all outputs in the signature.

Definition at line 82 of file UN_NodeSignature.h.

using UN_NodeSignature::ParmNameAndTypeRange = UT_IteratorRange< UN_NameAndTypeIterator >

Iterating over all parms in the signature.

Definition at line 101 of file UN_NodeSignature.h.

Constructor & Destructor Documentation

UN_NodeSignature::UN_NodeSignature	(	const UT_StringRef &	signature_name = UT_StringRef(),
		const UT_StringRef &	signature_label = UT_StringRef()
	)

Constructor.

Member Function Documentation

bool UN_NodeSignature::addInput	(	const UT_StringRef &	name,
		const UT_StringRef &	type_name
	)

Adds a new input to the signature, given the input's name and its type. Returns true on success, or false if a given input is badly named or already exists.

bool UN_NodeSignature::addOutput	(	const UT_StringRef &	name,
		const UT_StringRef &	type_name
	)

Adds a new output to the signature, given the output's name and type. Returns true on success, or false if a given output is badly named or already exists.

bool UN_NodeSignature::addParm	(	const UT_StringRef &	name,
		const UT_StringRef &	type_name
	)

Adds a new parameter to the signature, given the parm's name and type. Returns true on success, or false if a given parm is badly named or already exists.

InputNameAndTypeRange UN_NodeSignature::inputNameAndTypeRange

(

)

const

const UT_StringArray& UN_NodeSignature::inputNames ( ) const

inline

Returns the list of input names.

Definition at line 52 of file UN_NodeSignature.h.

const UT_StringHolder& UN_NodeSignature::inputTypeName

(

const UT_StringRef &

name

)

const

Returns the input type name given its name.

const UT_StringArray& UN_NodeSignature::inputTypeNames ( ) const

inline

Returns the list of input type names.

Definition at line 56 of file UN_NodeSignature.h.

const UT_StringHolder& UN_NodeSignature::label ( ) const

inline

Returns the label of the signature.

Definition at line 42 of file UN_NodeSignature.h.

const UT_StringHolder& UN_NodeSignature::name ( void  ) const

inline

Returns the name of the signature.

Definition at line 38 of file UN_NodeSignature.h.

OutputNameAndTypeRange UN_NodeSignature::outputNameAndTypeRange

(

)

const

const UT_StringArray& UN_NodeSignature::outputNames ( ) const

inline

Returns the list of output names.

Definition at line 74 of file UN_NodeSignature.h.

const UT_StringArray& UN_NodeSignature::outputTypeNames ( ) const

inline

Returns the list of output type names.

Definition at line 78 of file UN_NodeSignature.h.

ParmNameAndTypeRange UN_NodeSignature::parmNameAndTypeRange

(

)

const

const UT_StringArray& UN_NodeSignature::parmNames ( ) const

inline

Returns the list of parameter names.

Definition at line 93 of file UN_NodeSignature.h.

const UT_StringArray& UN_NodeSignature::parmTypeNames ( ) const

inline

Returns the list of parameter type names.

Definition at line 97 of file UN_NodeSignature.h.

---

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

• UN/UN_NodeSignature.h