om::engine::sound::SoundConnection Class Reference

A class that manages the connection between two objects that process sound data. More...

#include <omEngineSoundConnections.h>

Inheritance diagram for om::engine::sound::SoundConnection:

Public Member Functions
	SoundConnection ()
	Create a new sound connection object that has no valid objects connected. More...
Public Member Functions inherited from om::engine::base::Connection
	Connection ()
	Create a new default connection that is not connected to anything. More...
	Connection (Connector *newConnector1, Connector *newConnector2)
	Create a new connection between the specified two connectors. More...
Connector *	getConnector1 () const
	Return a pointer to the first connector in this connection, the source of the data. More...
void	setConnector1 (Connector *newConnector1)
	Set a pointer to the first connector in this connection, the source of the data. More...
Connector *	getConnector2 () const
	Return a pointer to the second connector in this connection, the source of the data. More...
void	setConnector2 (Connector *newConnector2)
	Set a pointer to the second connector in this connection, the source of the data. More...
const Time &	getPeriod () const
	Return the nominal period at which this connection should be updated during a simulation. More...
void	setPeriod (const Time &newPeriod)
	Set the nominal period at which this connection should be updated during a simulation. More...
ConnectionFlags &	getFlags ()
	Return a reference to an object that contains boolean parameters of the connection. More...
const ConnectionFlags &	getFlags () const
	Return an object that contains boolean parameters of the connection. More...
void	setFlags (const ConnectionFlags &newFlags)
	Set an object that contains boolean parameters of the connection. More...
Bool	flagIsSet (ConnectionFlags::Flag flag) const
	Return whether or not the specified boolan flag is set for this connection. More...
Bool	flagsAreSet (const ConnectionFlags &otherFlags) const
	Return whether or not all of the specified boolan flags are set for this connection. More...
void	setFlag (ConnectionFlags::Flag flag, Bool newIsSet=true)
	Set whether or not the specified boolan flag is set for this connection. More...
Bool	isDisabled () const
	Return whether or not this connection is currently disabled. More...
Bool	getIsEnabled () const
	Return whether or not this connection is currently enabled. More...
void	setIsEnabled (Bool newIsEnabled)
	Set whether or not this connection should be enabled. More...

Public Attributes
OpaqueResource	object1
	An opaque reference to the first object in the connection. More...
OpaqueResource	object2
	An opaque reference to the second object in the connection. More...
Index	object1Output
	The index of the sound output on the first object in the connection. More...
Index	object2Input
	The index of the sound input on the second object in the connection. More...
Gain	gain
	A linear gain factor for this sound connection. More...

Static Public Attributes
static const ResourceType	RESOURCE_TYPE
	The resource type for a sound connection. More...

Detailed Description

A class that manages the connection between two objects that process sound data.

Constructor & Destructor Documentation

om::engine::sound::SoundConnection::SoundConnection ( )

inline

Create a new sound connection object that has no valid objects connected.

Member Data Documentation

const ResourceType om::engine::sound::SoundConnection::RESOURCE_TYPE

static

The resource type for a sound connection.

OpaqueResource om::engine::sound::SoundConnection::object1

An opaque reference to the first object in the connection.

OpaqueResource om::engine::sound::SoundConnection::object2

An opaque reference to the second object in the connection.

Index om::engine::sound::SoundConnection::object1Output

The index of the sound output on the first object in the connection.

Index om::engine::sound::SoundConnection::object2Input

The index of the sound input on the second object in the connection.

Gain om::engine::sound::SoundConnection::gain

A linear gain factor for this sound connection.

---

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

• omEngineSoundConnections.h