A class that represents information about a particular SoundFilter parameter. More...

#include <omSoundFilterParameterInfo.h>

Public Member Functions
	FilterParameterInfo ()
	Create an uninitialized filter parameter information class. More...

	FilterParameterInfo (UInt32 newIndex, const UTF8String &newName, FilterParameterType newType, FilterParameterUnits newUnits, FilterParameterCurve newCurve, FilterParameterValue newMinimum, FilterParameterValue newMaximum, FilterParameterValue newDefault, FilterParameterFlags newFlags)
	Create a new parameter information object with the specified attributes. More...

UInt32	getIndex () const
	Return the index of this parameter within its host SoundFilter. More...

const UTF8String &	getName () const
	Return a reference to a human-readable name string for this parameter. More...

FilterParameterType	getType () const
	Return an object indicating the actual type of this filter parameter. More...

FilterParameterUnits	getUnits () const
	Return an object indicating the units of this filter parameter. More...

FilterParameterCurve	getCurve () const
	Return an object indicating the display curve of this filter parameter. More...

FilterParameterFlags	getFlags () const
	Return an object indicating boolean attributes of this filter parameter. More...

Bool	getMinimum (Bool &booleanValue) const
	Query a boolean minimum value of this filter parameter. More...

Bool	getMinimum (Int64 &integerValue) const
	Query an integer or enumeration minimum value of this filter parameter. More...

Bool	getMinimum (Float32 &floatValue) const
	Query a float minimum value of this filter parameter. More...

Bool	getMinimum (Float64 &doubleValue) const
	Query a double minimum value of this filter parameter. More...

FilterParameter	getMinimum () const
	Return a generic-typed minimum value for this parameter. More...

Bool	getMaximum (Bool &booleanValue) const
	Query a boolean maximum value of this filter parameter. More...

Bool	getMaximum (Int64 &integerValue) const
	Query an integer or enumeration maximum value of this filter parameter. More...

Bool	getMaximum (Float32 &floatValue) const
	Query a float maximum value of this filter parameter. More...

Bool	getMaximum (Float64 &doubleValue) const
	Query a double maximum value of this filter parameter. More...

FilterParameter	getMaximum () const
	Return a generic-typed maximum value for this parameter. More...

Bool	getDefault (Bool &booleanValue) const
	Query a boolean default value of this filter parameter. More...

Bool	getDefault (Int64 &integerValue) const
	Query an integer or enumeration default value of this filter parameter. More...

Bool	getDefault (Float32 &floatValue) const
	Query a float default value of this filter parameter. More...

Bool	getDefault (Float64 &doubleValue) const
	Query a double default value of this filter parameter. More...

FilterParameter	getDefault () const
	Return a generic-typed default value for this parameter. More...

Detailed Description

A class that represents information about a particular SoundFilter parameter.

Constructor & Destructor Documentation

om::sound::filters::FilterParameterInfo::FilterParameterInfo ( )

inline

Create an uninitialized filter parameter information class.

The information stored in this class does not represent any valid parameter information.

om::sound::filters::FilterParameterInfo::FilterParameterInfo	(	UInt32	newIndex,
		const UTF8String &	newName,
		FilterParameterType	newType,
		FilterParameterUnits	newUnits,
		FilterParameterCurve	newCurve,
		FilterParameterValue	newMinimum,
		FilterParameterValue	newMaximum,
		FilterParameterValue	newDefault,
		FilterParameterFlags	newFlags
	)

inline

Create a new parameter information object with the specified attributes.

Member Function Documentation

UInt32 om::sound::filters::FilterParameterInfo::getIndex ( ) const

inline

Return the index of this parameter within its host SoundFilter.

const UTF8String& om::sound::filters::FilterParameterInfo::getName ( ) const

inline

Return a reference to a human-readable name string for this parameter.

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

inline

Return an object indicating the actual type of this filter parameter.

FilterParameterUnits om::sound::filters::FilterParameterInfo::getUnits ( ) const

inline

Return an object indicating the units of this filter parameter.

FilterParameterCurve om::sound::filters::FilterParameterInfo::getCurve ( ) const

inline

Return an object indicating the display curve of this filter parameter.

FilterParameterFlags om::sound::filters::FilterParameterInfo::getFlags ( ) const

inline

Return an object indicating boolean attributes of this filter parameter.

Bool om::sound::filters::FilterParameterInfo::getMinimum ( Bool & booleanValue ) const

inline

Query a boolean minimum value of this filter parameter.

If this parameter can be converted to a type of BOOLEAN, the method returns TRUE and the minimum boolean value for this parameter is placed in the output parameter. Otherwise, FALSE is returned and no minimum value is set.

Bool om::sound::filters::FilterParameterInfo::getMinimum ( Int64 & integerValue ) const

inline

Query an integer or enumeration minimum value of this filter parameter.

If this parameter can be converted to a type of INTEGER or ENUMERATION, the method returns TRUE and the minimum integer value for this parameter is placed in the output parameter. Otherwise, FALSE is returned and no minimum value is set.

Bool om::sound::filters::FilterParameterInfo::getMinimum ( Float32 & floatValue ) const

inline

Query a float minimum value of this filter parameter.

If this parameter can be converted to a type of FLOAT, the method returns TRUE and the minimum float value for this parameter is placed in the output parameter. Otherwise, FALSE is returned and no minimum value is set.

Bool om::sound::filters::FilterParameterInfo::getMinimum ( Float64 & doubleValue ) const

inline

Query a double minimum value of this filter parameter.

If this parameter can be converted to a type of DOUBLE, the method returns TRUE and the minimum double value for this parameter is placed in the output parameter. Otherwise, FALSE is returned and no minimum value is set.

FilterParameter om::sound::filters::FilterParameterInfo::getMinimum ( ) const

inline

Return a generic-typed minimum value for this parameter.

Bool om::sound::filters::FilterParameterInfo::getMaximum ( Bool & booleanValue ) const

inline

Query a boolean maximum value of this filter parameter.

If this parameter can be converted to a type of BOOLEAN, the method returns TRUE and the maximum boolean value for this parameter is placed in the output parameter. Otherwise, FALSE is returned and no maximum value is set.

Bool om::sound::filters::FilterParameterInfo::getMaximum ( Int64 & integerValue ) const

inline

Query an integer or enumeration maximum value of this filter parameter.

If this parameter can be converted to a type of INTEGER or ENUMERATION, the method returns TRUE and the maximum integer value for this parameter is placed in the output parameter. Otherwise, FALSE is returned and no maximum value is set.

Bool om::sound::filters::FilterParameterInfo::getMaximum ( Float32 & floatValue ) const

inline

Query a float maximum value of this filter parameter.

If this parameter can be converted to a type of FLOAT, the method returns TRUE and the maximum float value for this parameter is placed in the output parameter. Otherwise, FALSE is returned and no maximum value is set.

Bool om::sound::filters::FilterParameterInfo::getMaximum ( Float64 & doubleValue ) const

inline

Query a double maximum value of this filter parameter.

If this parameter can be converted to a type of DOUBLE, the method returns TRUE and the maximum double value for this parameter is placed in the output parameter. Otherwise, FALSE is returned and no maximum value is set.

FilterParameter om::sound::filters::FilterParameterInfo::getMaximum ( ) const

inline

Return a generic-typed maximum value for this parameter.

Bool om::sound::filters::FilterParameterInfo::getDefault ( Bool & booleanValue ) const

inline

Query a boolean default value of this filter parameter.

If this parameter can be converted to a type of BOOLEAN, the method returns TRUE and the default boolean value for this parameter is placed in the output parameter. Otherwise, FALSE is returned and no default value is set.

Bool om::sound::filters::FilterParameterInfo::getDefault ( Int64 & integerValue ) const

inline

Query an integer or enumeration default value of this filter parameter.

If this parameter can be converted to a type of INTEGER or ENUMERATION, the method returns TRUE and the default integer value for this parameter is placed in the output parameter. Otherwise, FALSE is returned and no default value is set.

Bool om::sound::filters::FilterParameterInfo::getDefault ( Float32 & floatValue ) const

inline

Query a float default value of this filter parameter.

If this parameter can be converted to a type of FLOAT, the method returns TRUE and the default float value for this parameter is placed in the output parameter. Otherwise, FALSE is returned and no default value is set.

Bool om::sound::filters::FilterParameterInfo::getDefault ( Float64 & doubleValue ) const

inline

Query a double default value of this filter parameter.

If this parameter can be converted to a type of DOUBLE, the method returns TRUE and the default double value for this parameter is placed in the output parameter. Otherwise, FALSE is returned and no default value is set.

FilterParameter om::sound::filters::FilterParameterInfo::getDefault ( ) const

inline

Return a generic-typed default value for this parameter.

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

omSoundFilterParameterInfo.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation