om::sound::filters::FilterParameterFlags Class Reference

A class that encapsulates the different flags that a sound filter parameter can have. More...

#include <omSoundFilterParameterFlags.h>

Public Types
enum	Enum { READ_ACCESS = 1 << 0, WRITE_ACCESS = 1 << 1, NAMED_VALUES = 1 << 2, UNDEFINED = 0 }
	An enum that specifies the different filter parameter flags. More...

Public Member Functions
	FilterParameterFlags ()
	Create a new filter parameter flags object with no flags set. More...
	FilterParameterFlags (UInt32 newFlags)
	Create a new filter parameter flags object with the specified flags value. More...
	operator UInt32 () const
	Convert this filter parameter flags object to an integer value. More...
Bool	getIsReadable () const
	Return whether or not these parameter flags indicate that read access is enabled. More...
void	setIsReadable (Bool newIsReadable)
	Set whether or not these parameter flags indicate that read access is enabled. More...
Bool	getIsWriteable () const
	Return whether or not these parameter flags indicate that write access is enabled. More...
void	setIsWriteable (Bool newIsWritable)
	Set whether or not these parameter flags indicate that write access is enabled. More...
Bool	getHasNamedValues () const
	Return whether or not these parameter flags indicate the parameter has any specially named values. More...
void	setHasNamedValues (Bool newHasNamedValues)
	Set whether or not these parameter flags indicate the parameter has any specially named values. More...

Detailed Description

A class that encapsulates the different flags that a sound filter parameter can have.

These flags provide boolean information about a certain filter parameter. For example, flags can indicate the read/write status of a parameter. Flags are indicated by setting a single bit of a 32-bit unsigned integer to 1.

Enum values for the different flags are defined as members of the class. Typically, the user would bitwise-OR the flag enum values together to produce a final set of set flags.

Member Enumeration Documentation

enum om::sound::filters::FilterParameterFlags::Enum

An enum that specifies the different filter parameter flags.

Enumerator
READ_ACCESS	A flag set when a parameter's value can be read.
WRITE_ACCESS	A flag set when a parameter's value can be changed.
NAMED_VALUES	A flag set when some of a parameter's values may have special names associated with them.
UNDEFINED	The flag value when all flags are not set.

Constructor & Destructor Documentation

om::sound::filters::FilterParameterFlags::FilterParameterFlags ( )

inline

Create a new filter parameter flags object with no flags set.

om::sound::filters::FilterParameterFlags::FilterParameterFlags ( UInt32  newFlags )

inline

Create a new filter parameter flags object with the specified flags value.

Member Function Documentation

om::sound::filters::FilterParameterFlags::operator UInt32 ( ) const

inline

Convert this filter parameter flags object to an integer value.

This operator is provided so that the FilterParameterFlags object can be used as an integer value for bitwise logical operations.

Bool om::sound::filters::FilterParameterFlags::getIsReadable ( ) const

inline

Return whether or not these parameter flags indicate that read access is enabled.

void om::sound::filters::FilterParameterFlags::setIsReadable ( Bool  newIsReadable )

inline

Set whether or not these parameter flags indicate that read access is enabled.

Bool om::sound::filters::FilterParameterFlags::getIsWriteable ( ) const

inline

Return whether or not these parameter flags indicate that write access is enabled.

void om::sound::filters::FilterParameterFlags::setIsWriteable ( Bool  newIsWritable )

inline

Set whether or not these parameter flags indicate that write access is enabled.

Bool om::sound::filters::FilterParameterFlags::getHasNamedValues ( ) const

inline

Return whether or not these parameter flags indicate the parameter has any specially named values.

void om::sound::filters::FilterParameterFlags::setHasNamedValues ( Bool  newHasNamedValues )

inline

Set whether or not these parameter flags indicate the parameter has any specially named values.

---

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

• omSoundFilterParameterFlags.h