om::sound::filters::FilterParameterValue Class Reference

A class that holds a union of data representing a filter parameter value. More...

#include <omSoundFilterParameterValue.h>

Public Member Functions
	FilterParameterValue ()
	Create a filter parameter value with an undefined (unset) value. More...
	FilterParameterValue (Bool newBoolean)
	Create a new filter parameter value with the specified boolean value. More...
	FilterParameterValue (Int64 newInteger)
	Create a new filter parameter value with the specified integer value. More...
	FilterParameterValue (Float32 newFloat)
	Create a new filter parameter value with the specified float value. More...
	FilterParameterValue (Float64 newDouble)
	Create a new filter parameter value with the specified double value. More...
Bool	getValueAsType (FilterParameterType type, Bool &output) const
	Interpret this value as the specified type and convert it to a boolean value. More...
Bool	getValueAsType (FilterParameterType type, Int64 &output) const
	Interpret this value as the specified type and convert it to an integer value. More...
Bool	getValueAsType (FilterParameterType type, Float32 &output) const
	Interpret this value as the specified type and convert it to a float value. More...
Bool	getValueAsType (FilterParameterType type, Float64 &output) const
	Interpret this value as the specified type and convert it to a double value. More...
Bool	setValueAsType (FilterParameterType type, Bool newValue)
	Interpret this value as the specified type and set it to a boolean value. More...
Bool	setValueAsType (FilterParameterType type, Int64 newValue)
	Interpret this value as the specified type and set it to an integer value. More...
Bool	setValueAsType (FilterParameterType type, Float32 newValue)
	Interpret this value as the specified type and set it to a float value. More...
Bool	setValueAsType (FilterParameterType type, Float64 newValue)
	Interpret this value as the specified type and set it to a double value. More...

Detailed Description

A class that holds a union of data representing a filter parameter value.

This class is a wrapper around a union value that contains accessor methods and conversion methods for all necessary types.

The user shouldn't have to interact with this class directly - the filter framework should automatically handle value conversions from this class to user types.

Constructor & Destructor Documentation

om::sound::filters::FilterParameterValue::FilterParameterValue ( )

inline

Create a filter parameter value with an undefined (unset) value.

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

inline

Create a new filter parameter value with the specified boolean value.

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

inline

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

This constructor works for parameters with INTEGER or ENUMERATION types.

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

inline

Create a new filter parameter value with the specified float value.

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

inline

Create a new filter parameter value with the specified double value.

Member Function Documentation

Bool om::sound::filters::FilterParameterValue::getValueAsType ( FilterParameterType  type, Bool &  output  ) const

inline

Interpret this value as the specified type and convert it to 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::FilterParameterValue::getValueAsType ( FilterParameterType  type, Int64 &  output  ) const

inline

Interpret this value as the specified type and convert it to 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::FilterParameterValue::getValueAsType ( FilterParameterType  type, Float32 &  output  ) const

inline

Interpret this value as the specified type and convert it to 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::FilterParameterValue::getValueAsType ( FilterParameterType  type, Float64 &  output  ) const

inline

Interpret this value as the specified type and convert it to 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::FilterParameterValue::setValueAsType ( FilterParameterType  type, Bool  newValue  )

inline

Interpret this value as the specified type and set it to 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::FilterParameterValue::setValueAsType ( FilterParameterType  type, Int64  newValue  )

inline

Interpret this value as the specified type and set it to 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::FilterParameterValue::setValueAsType ( FilterParameterType  type, Float32  newValue  )

inline

Interpret this value as the specified type and set it to 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::FilterParameterValue::setValueAsType ( FilterParameterType  type, Float64  newValue  )

inline

Interpret this value as the specified type and set it to a double value.

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

Member Data Documentation

UInt64 om::sound::filters::FilterParameterValue::booleanValue

Int64 om::sound::filters::FilterParameterValue::integerValue

Int64 om::sound::filters::FilterParameterValue::enumValue

Float32 om::sound::filters::FilterParameterValue::floatValue

Float64 om::sound::filters::FilterParameterValue::doubleValue

---

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

• omSoundFilterParameterValue.h