MAttributeParameterMappingList Class Reference

Search for all occurrences

Detailed Description

A list of MAttributeParameterMapping objects.

A list of MAttributeParameterMapping objects. Ownership of mapping objects added to the list remains with the caller; the list makes a copy.

#include <MPxShadingNodeOverride.h>

List of all members.

Public Member Functions
	MAttributeParameterMappingList ()
	Constructor.
	~MAttributeParameterMappingList ()
	Destructor.
unsigned int	length () const
	Get the length of the list.
const MAttributeParameterMapping *	getMapping (unsigned int index) const
	Get the mapping at the specified index.
const MAttributeParameterMapping *	findByAttributeName (const MString &attributeName) const
	Find a mapping by attribute name.
const MAttributeParameterMapping *	findByParameterName (const MString &parameterName) const
	Find a mapping by parameter name.
void	append (const MAttributeParameterMapping &mapping)
	Add a mapping to the list.
void	clear ()
	Clear all mappings from the list.
Static Public Member Functions
static const char *	className ()
	Returns the name of this class. Search for all occurrences

Member Function Documentation

unsigned int length ( ) const

Search for all occurrences

Get the length of the list.

Returns:: The length of the list

const MAttributeParameterMapping * getMapping ( unsigned int index ) const

Search for all occurrences

Get the mapping at the specified index.

Parameters:

[in] index The index of the mapping to get

Returns:: A pointer to the mapping or NULL if out of bounds

const MAttributeParameterMapping * findByAttributeName ( const MString & attributeName ) const

Search for all occurrences

Find a mapping by attribute name.

This will return the first mapping found with a matching attribute name.

Parameters:

[in] attributeName The name of the attribute to search for

Returns:: A pointer to the mapping or NULL if not found

const MAttributeParameterMapping * findByParameterName ( const MString & parameterName ) const

Search for all occurrences

Find a mapping by parameter name.

This will return the first mapping found with a matching parameter name.

Parameters:

[in] parameterName The name of the parameter to search for

Returns:: A pointer to the mapping or NULL if not found

void append ( const MAttributeParameterMapping & mapping )

Search for all occurrences

Add a mapping to the list.

The list makes a copy; ownership of the original is left with the caller.

Parameters:

[in] mapping The mapping to add to the list

const char * className ( ) [static]

Search for all occurrences

Returns the name of this class.

Returns:: Name of this class.