om::sound::filters::FilterParameter Class Reference

A class that holds the type and value of a SoundFilter parameter. More...

#include <omSoundFilterParameter.h>

Public Member Functions
	FilterParameter ()
	Create a filter parameter with an undefined type and value. More...
	FilterParameter (Bool newBoolean)
	Create a new filter parameter with the specified boolean value. More...
	FilterParameter (Int64 newInteger)
	Create a new filter parameter with the specified integer or enumeration value. More...
	FilterParameter (Float32 newFloat)
	Create a new filter parameter with the specified float value. More...
	FilterParameter (Float64 newDouble)
	Create a new filter parameter with the specified double value. More...
	FilterParameter (FilterParameterType newType, const FilterParameterValue &newValue)
	Create a new filter parameter with the specified type and generic value union. More...
FilterParameterType	getType () const
	Return the actual type of this filter parameter. More...
Bool	getValue (Bool &output) const
	Read this filter parameter as a boolean value. More...
Bool	getValue (Int64 &output) const
	Read this filter parameter as an integer value. More...
Bool	getValue (Float32 &output) const
	Read this filter parameter as a float value. More...
Bool	getValue (Float64 &output) const
	Read this filter parameter as a double value. More...
Bool	setValue (Bool output)
	Write this filter parameter as a boolean value. More...
Bool	setValue (Int64 output)
	Write this filter parameter as an integer or enumeration value. More...
Bool	setValue (Float32 output)
	Write this filter parameter as a float value. More...
Bool	setValue (Float64 output)
	Write this filter parameter as a double value. More...
UTF8String	toString () const
	Return a string representation of this parameter's value. More...
	operator UTF8String () const
	Return a string representation of this parameter's value. More...

Detailed Description

A class that holds the type and value of a SoundFilter parameter.

The class provides ways to access the value of the generic parameter in a type-safe manner.

Constructor & Destructor Documentation

om::sound::filters::FilterParameter::FilterParameter ( )

inline

Create a filter parameter with an undefined type and value.

om::sound::filters::FilterParameter::FilterParameter ( Bool  newBoolean )

inline

Create a new filter parameter with the specified boolean value.

om::sound::filters::FilterParameter::FilterParameter ( Int64  newInteger )

inline

Create a new filter parameter with the specified integer or enumeration value.

om::sound::filters::FilterParameter::FilterParameter ( Float32  newFloat )

inline

Create a new filter parameter with the specified float value.

om::sound::filters::FilterParameter::FilterParameter ( Float64  newDouble )

inline

Create a new filter parameter with the specified double value.

om::sound::filters::FilterParameter::FilterParameter ( FilterParameterType  newType, const FilterParameterValue &  newValue  )

inline

Create a new filter parameter with the specified type and generic value union.

Member Function Documentation

FilterParameterType om::sound::filters::FilterParameter::getType ( ) const

inline

Return the actual type of this filter parameter.

Bool om::sound::filters::FilterParameter::getValue ( Bool &  output ) const

inline

Read this filter parameter as a boolean value.

If the conversion succeeds, TRUE is returned. Otherwise, if the conversion fails, FALSE is returned and no output is converted.

Bool om::sound::filters::FilterParameter::getValue ( Int64 &  output ) const

inline

Read this filter parameter as an integer value.

If the conversion succeeds, TRUE is returned. Otherwise, if the conversion fails, FALSE is returned and no output is converted.

Bool om::sound::filters::FilterParameter::getValue ( Float32 &  output ) const

inline

Read this filter parameter as a float value.

If the conversion succeeds, TRUE is returned. Otherwise, if the conversion fails, FALSE is returned and no output is converted.

Bool om::sound::filters::FilterParameter::getValue ( Float64 &  output ) const

inline

Read this filter parameter as a double value.

If the conversion succeeds, TRUE is returned. Otherwise, if the conversion fails, FALSE is returned and no output is converted.

Bool om::sound::filters::FilterParameter::setValue ( Bool  output )

inline

Write this filter parameter as a boolean value.

If the conversion succeeds, TRUE is returned. Otherwise, if the conversion fails, FALSE is returned and no value is set.

Bool om::sound::filters::FilterParameter::setValue ( Int64  output )

inline

Write this filter parameter as an integer or enumeration value.

If the conversion succeeds, TRUE is returned. Otherwise, if the conversion fails, FALSE is returned and no value is set.

Bool om::sound::filters::FilterParameter::setValue ( Float32  output )

inline

Write this filter parameter as a float value.

If the conversion succeeds, TRUE is returned. Otherwise, if the conversion fails, FALSE is returned and no value is set.

Bool om::sound::filters::FilterParameter::setValue ( Float64  output )

inline

Write this filter parameter as a double value.

If the conversion succeeds, TRUE is returned. Otherwise, if the conversion fails, FALSE is returned and no value is set.

UTF8String om::sound::filters::FilterParameter::toString

(

)

const

Return a string representation of this parameter's value.

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

inline

Return a string representation of this parameter's value.

---

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

• omSoundFilterParameter.h