MStringResourceId Class Reference

Unique identifier for an MString Resource. More...

#include <MStringResourceId.h>

Public Member Functions
	MStringResourceId ()
	The Class constructor. More...
	MStringResourceId (const char *pluginId, const char *keyString, const MString &defaultValue)
	Class constructor. More...
	MStringResourceId (const MStringResourceId &)
	Copy constructor. More...
MStringResourceId &	operator= (const MStringResourceId &)
	Assignment operator. More...
bool	operator!= (const MStringResourceId &) const
	Inequality operator. More...
bool	operator== (const MStringResourceId &) const
	Equality operator. More...
	~MStringResourceId ()
	The class destructor.

Detailed Description

Unique identifier for an MString Resource.

The MStringResourceId class implements a string lookup key to be used in conjunction with the MStringResource class to retrieve strings from externally defined string resource values.

Examples:

AbcImport/AbcImportStrings.cpp, AbcImport/AbcImportStrings.h, dx11Shader/dx11ShaderStrings.cpp, dx11Shader/dx11ShaderStrings.h, dx11Shader/dx11ShaderUniformParamBuilder.cpp, dx11Shader/dx11ShaderUniformParamBuilder.h, glslShader/GLSLShaderStrings.cpp, glslShader/GLSLShaderStrings.h, gpuCache/gpuCacheCmd.cpp, gpuCache/gpuCacheUtil.h, hwApiTextureTest/hwApiTextureTestStrings.cpp, hwApiTextureTest/hwApiTextureTestStrings.h, sceneAssembly/assemblyReference.cpp, sceneAssembly/assemblyReference.h, and sceneAssembly/sceneAssemblyPluginMain.cpp.

Constructor & Destructor Documentation

MStringResourceId

(

)

The Class constructor.

Initializes the new MStringResourceId instance to the empty string. This constructor will not be used in practice.

MStringResourceId	(	const char *	pluginId,
		const char *	keyString,
		const MString &	defaultValue
	)

Class constructor.

Create a new instance of an MStringResourceId. This object can then be used to register and retrieve MStringResource's.

The unique resource key is formed from a pair of strings: the name of the plugin the string is associated with and a unique Id for this particular string. The resourceId also contains the string's default value.

Parameters

[in]	pluginId	the name of this plugin
[in]	keyString	the unique string Id (within this plugin)
[in]	defaultValue	the default value for the string resource

MStringResourceId

(

const MStringResourceId &

other

)

Copy constructor.

Create a new MStringResourceId instance by copying another.

Parameters

[in]

other

the MStringResourceId to copy from.

Member Function Documentation

MStringResourceId & operator=

(

const MStringResourceId &

other

)

Assignment operator.

Allows assignment between MStringResourceId instances.

bool operator!=

(

const MStringResourceId &

other

)

const

Inequality operator.

Allows 2 MStringResourceIds to be compared to see if they differ.

bool operator==

(

const MStringResourceId &

other

)

const

Equality operator.

Allows 2 MStringResourceIds to be compared to see if they contain identical values.

---

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

• MStringResourceId.h
• MStringResourceId.cpp