om::sound::acoustics::contexts::AcousticResultFlags Class Reference

A class that specifies the requested output flags for an acoustic simulation. More...

#include <omAcousticResultFlags.h>

Public Types
enum	Flag {   UNDEFINED = 0, PRESSURE_IR = (1 << 0), ENERGY_IR = (1 << 1), DIRECTION_IR = (1 << 2),   METRICS = (1 << 3), STATISTICS = (1 << 4), DEFAULT = UNDEFINED }
	An enum that specifies the different acoustic simulation result flags. More...

Public Member Functions
	AcousticResultFlags ()
	Create a new acoustic result flags object with no flags set. More...
	AcousticResultFlags (Flag flag)
	Create a new acoustic result flags object with the specified flag value initially set. More...
	AcousticResultFlags (UInt32 newFlags)
	Create a new acoustic result flags object with the specified initial combined flags value. More...
	operator UInt32 () const
	Convert this acoustic flags object to an integer value. More...
Bool	isSet (Flag flag) const
	Return whether or not the specified flag value is set for this flags object. More...
void	set (Flag flag, Bool newIsSet)
	Set whether or not the specified flag value is set for this flags object. More...

Detailed Description

A class that specifies the requested output flags for an acoustic simulation.

These flags provide boolean information about the desired output. 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::acoustics::contexts::AcousticResultFlags::Flag

An enum that specifies the different acoustic simulation result flags.

Enumerator
UNDEFINED	The flag value when all flags are not set.
PRESSURE_IR	A flag indicating whether or not a spatial pressure impulse response should be computed.
ENERGY_IR	A flag indicating whether or not an energy impulse response should be computed.
DIRECTION_IR	A flag indicating whether or not a directional impulse response should be computed.
METRICS	A flag indicating whether or not impulse response metrics should be computed.
STATISTICS	A flag indicating whether or not global simulation statistics should be reported.
DEFAULT	The default result flags to use for an acoustic simulation.

Constructor & Destructor Documentation

om::sound::acoustics::contexts::AcousticResultFlags::AcousticResultFlags ( )

inline

Create a new acoustic result flags object with no flags set.

om::sound::acoustics::contexts::AcousticResultFlags::AcousticResultFlags ( Flag  flag )

inline

Create a new acoustic result flags object with the specified flag value initially set.

om::sound::acoustics::contexts::AcousticResultFlags::AcousticResultFlags ( UInt32  newFlags )

inline

Create a new acoustic result flags object with the specified initial combined flags value.

Member Function Documentation

om::sound::acoustics::contexts::AcousticResultFlags::operator UInt32 ( ) const

inline

Convert this acoustic flags object to an integer value.

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

Bool om::sound::acoustics::contexts::AcousticResultFlags::isSet ( Flag  flag ) const

inline

Return whether or not the specified flag value is set for this flags object.

void om::sound::acoustics::contexts::AcousticResultFlags::set ( Flag  flag, Bool  newIsSet  )

inline

Set whether or not the specified flag value is set for this flags object.

---

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

• omAcousticResultFlags.h