om::sound::filters::FilterParameterType Class Reference

A class that represents the actual type of a SoundFilter parameter. More...

#include <omSoundFilterParameterType.h>

Public Types
enum	Enum {   UNDEFINED = 0, BOOLEAN = 1, INTEGER = 2, ENUMERATION = 3,   FLOAT = 4, DOUBLE = 5 }
	An enum that specifies the allowed SoundFilter parameter types. More...

Public Member Functions
	FilterParameterType ()
	Create a new filter parameter type object with an UNDEFINED parameter type. More...
	FilterParameterType (Enum newType)
	Create a new filter parameter type object with the specified type enum value. More...
	operator Enum () const
	Convert this filter parameter type to an enum value. More...
UTF8String	toString () const
	Return a string representation of the parameter type. More...
	operator UTF8String () const
	Convert this parameter type into a string representation. More...

Detailed Description

A class that represents the actual type of a SoundFilter parameter.

Member Enumeration Documentation

enum om::sound::filters::FilterParameterType::Enum

An enum that specifies the allowed SoundFilter parameter types.

Enumerator
UNDEFINED	A undefined filter parameter type.
BOOLEAN	A filter parameter type which indicates a boolean parameter value.
INTEGER	A filter parameter type which indicates an integral parameter value.
ENUMERATION	A filter parameter type that is an enumeration of possible integer values.
FLOAT	A filter parameter type which indicates a single-precision parameter value.
DOUBLE	A filter parameter type which indicates a double-precision parameter value.

Constructor & Destructor Documentation

om::sound::filters::FilterParameterType::FilterParameterType ( )

inline

Create a new filter parameter type object with an UNDEFINED parameter type.

om::sound::filters::FilterParameterType::FilterParameterType ( Enum  newType )

inline

Create a new filter parameter type object with the specified type enum value.

Member Function Documentation

om::sound::filters::FilterParameterType::operator Enum ( ) const

inline

Convert this filter parameter type to an enum value.

This operator is provided so that the FilterParameterType object can be used directly in a switch statement without the need to explicitly access the underlying enum value.

Returns

the enum representation of this parameter type.

UTF8String om::sound::filters::FilterParameterType::toString

(

)

const

Return a string representation of the parameter type.

om::sound::filters::FilterParameterType::operator UTF8String ( ) const

inline

Convert this parameter type into a string representation.

---

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

• omSoundFilterParameterType.h