sipxmedialib  Version 3.3
Public Types | Private Attributes | List of all members
MprBridgeSetGainsMsg Class Reference

Message used to set gains in bridge mix matrix. More...

#include <MprBridgeSetGainsMsg.h>

Inheritance diagram for MprBridgeSetGainsMsg:
Inheritance graph
[legend]
Collaboration diagram for MprBridgeSetGainsMsg:
Collaboration graph
[legend]

Public Types

enum  SetGainMsgType { GAINS_ROW, GAINS_COLUMN }
 Set row or column in bridge mix matrix. More...
 
- Public Types inherited from MpResourceMsg
enum  MpResourceMsgType {
  MPRM_RESOURCE_ENABLE, MPRM_RESOURCE_DISABLE, MPRM_ENABLE_ALL_NOTIFICATIONS, MPRM_DISABLE_ALL_NOTIFICATIONS,
  MPRM_START_TONE, MPRM_STOP_TONE, MPRM_BRIDGE_SET_GAINS, MPRM_DECODE_SELECT_CODECS,
  MPRM_SET_SOCKETS, MPRM_RESET_SOCKETS, MPRM_EXTERNAL_MESSAGE_START = 128
}
 Resource message types. More...
 

Public Member Functions

Creators
 MprBridgeSetGainsMsg (const UtlString &targetResourceName, int port, int numGains, const MpBridgeGain pGains[], SetGainMsgType type)
 Constructor. More...
 
 MprBridgeSetGainsMsg (const MprBridgeSetGainsMsg &resourceMsg)
 Copy constructor. More...
 
OsMsg * createCopy (void) const
 Create a copy of this msg object (which may be of a derived type) More...
 
 ~MprBridgeSetGainsMsg ()
 Destructor. More...
 
Manipulators
MprBridgeSetGainsMsgoperator= (const MprBridgeSetGainsMsg &rhs)
 Assignment operator. More...
 
Accessors
int getPort () const
 
int getGainsNum () const
 Return number of values in gains array. More...
 
const MpBridgeGaingetGains () const
 Return pointer to gains array. More...
 
SetGainMsgType getType () const
 Should row or column be set? More...
 
- Public Member Functions inherited from MpResourceMsg
 MpResourceMsg (MpResourceMsgType msg, const UtlString &msgDestName)
 Constructor. More...
 
 MpResourceMsg (const MpResourceMsg &rMpResourceMsg)
 Copy constructor. More...
 
virtual ~MpResourceMsg ()
 Destructor. More...
 
MpResourceMsgoperator= (const MpResourceMsg &rhs)
 Assignment operator. More...
 
void setDestResourceName (const UtlString &msgDestName)
 Set the name of the resource this message applies to. More...
 
int getMsg () const
 Returns the type of the media resource message. More...
 
UtlString getDestResourceName () const
 Get the name of the resource this message applies to. More...
 

Private Attributes

int mPort
 
int mGainsNum
 Number of elements in mpGains array. More...
 
MpBridgeGainmpGains
 Array of gains to set. More...
 
SetGainMsgType mType
 Should row or column be set? More...
 

Detailed Description

Message used to set gains in bridge mix matrix.

Member Enumeration Documentation

Set row or column in bridge mix matrix.

Enumerator
GAINS_ROW 

Set row in bridge mix matrix.

GAINS_COLUMN 

Set column in bridge mix matrix.

Constructor & Destructor Documentation

MprBridgeSetGainsMsg ( const UtlString &  targetResourceName,
int  port,
int  numGains,
const MpBridgeGain  pGains[],
SetGainMsgType  type 
)
inline

Constructor.

MprBridgeSetGainsMsg ( const MprBridgeSetGainsMsg resourceMsg)
inline

Copy constructor.

~MprBridgeSetGainsMsg ( )
inline

Destructor.

Member Function Documentation

OsMsg* createCopy ( void  ) const
inlinevirtual

Create a copy of this msg object (which may be of a derived type)

Reimplemented from MpResourceMsg.

MprBridgeSetGainsMsg& operator= ( const MprBridgeSetGainsMsg rhs)
inline

Assignment operator.

int getPort ( ) const
inline
int getGainsNum ( ) const
inline

Return number of values in gains array.

const MpBridgeGain* getGains ( ) const
inline

Return pointer to gains array.

SetGainMsgType getType ( ) const
inline

Should row or column be set?

Member Data Documentation

int mPort
private

Input or output port (row or column number) for which gains are set.

int mGainsNum
private

Number of elements in mpGains array.

MpBridgeGain* mpGains
private

Array of gains to set.

SetGainMsgType mType
private

Should row or column be set?