om::sound::plugins::PluginID Class Reference

A class that represents that unique identifier for an external sound filter plugin. More...

#include <omSoundPluginID.h>

Public Member Functions
	PluginID ()
	Create a new default empty plugin ID. More...
	PluginID (const PluginType &newType, const UTF8String &newManufacturer, const UTF8String &newName)
	Create a new plugin ID with the specified type, manufacturer, and name. More...
const PluginType &	getType () const
	Return a string that uniquely represents this plugin's type identifier. More...
void	setType (const PluginType &newType)
	Set a string that uniquely represents this plugin's type identifier. More...
const UTF8String &	getName () const
	Return a string that uniquely represents this plugin's name identifier. More...
void	setName (const UTF8String &newName)
	Set a string that uniquely represents this plugin's name identifier. More...
const UTF8String &	getManufacturer () const
	Return a string that uniquely represents the name of this plugin's manufacturer ID. More...
void	setManufacturer (const UTF8String &newManufacturer)
	Set a string that uniquely represents the name of this plugin's manufacturer ID. More...
Bool	operator== (const PluginID &other) const
	Return whether or not this plugin ID is equivalent to another. More...
Bool	operator!= (const PluginID &other) const
	Return whether or not this plugin ID is not equivalent to another. More...
Hash	getHashCode () const
	Return an integer hash-code value for this plugin ID. More...

Static Public Attributes
static const PluginID	INVALID
	An object that represents an invalid plugin ID. More...

Detailed Description

A class that represents that unique identifier for an external sound filter plugin.

Constructor & Destructor Documentation

om::sound::plugins::PluginID::PluginID

(

)

Create a new default empty plugin ID.

om::sound::plugins::PluginID::PluginID	(	const PluginType &	newType,
		const UTF8String &	newManufacturer,
		const UTF8String &	newName
	)

Create a new plugin ID with the specified type, manufacturer, and name.

Member Function Documentation

const PluginType& om::sound::plugins::PluginID::getType ( ) const

inline

Return a string that uniquely represents this plugin's type identifier.

void om::sound::plugins::PluginID::setType ( const PluginType &  newType )

inline

Set a string that uniquely represents this plugin's type identifier.

const UTF8String& om::sound::plugins::PluginID::getName ( ) const

inline

Return a string that uniquely represents this plugin's name identifier.

void om::sound::plugins::PluginID::setName ( const UTF8String &  newName )

inline

Set a string that uniquely represents this plugin's name identifier.

const UTF8String& om::sound::plugins::PluginID::getManufacturer ( ) const

inline

Return a string that uniquely represents the name of this plugin's manufacturer ID.

void om::sound::plugins::PluginID::setManufacturer ( const UTF8String &  newManufacturer )

inline

Set a string that uniquely represents the name of this plugin's manufacturer ID.

Bool om::sound::plugins::PluginID::operator== ( const PluginID &  other ) const

inline

Return whether or not this plugin ID is equivalent to another.

The type, manufacturer and plugin name comparisons are case-insensitive.

Bool om::sound::plugins::PluginID::operator!= ( const PluginID &  other ) const

inline

Return whether or not this plugin ID is not equivalent to another.

The type, manufacturer and plugin name comparisons are case-insensitive.

Hash om::sound::plugins::PluginID::getHashCode ( ) const

inline

Return an integer hash-code value for this plugin ID.

Member Data Documentation

const PluginID om::sound::plugins::PluginID::INVALID

static

An object that represents an invalid plugin ID.

---

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

• omSoundPluginID.h