Public Member Functions | Protected Attributes

JAUS::QueryAudio Class Reference

This message allows a component to request audio information. More...

#include <queryaudio.h>

Inheritance diagram for JAUS::QueryAudio:
JAUS::Message

List of all members.

Public Member Functions

 QueryAudio (const Address &dest=Address(), const Address &src=Address())
 Constructor, initializes default values.
 QueryAudio (const QueryAudio &message)
 Copy constructor.
 ~QueryAudio ()
 Destructor.
void SetDeviceID (const Byte id)
Byte GetDeviceID () const
virtual bool IsCommand () const
virtual int WriteMessageBody (Packet &packet) const
 Writes message payload to the packet.
virtual int ReadMessageBody (const Packet &packet)
 Reads message payload from the packet.
virtual MessageClone () const
virtual UInt GetPresenceVector () const
virtual UInt GetPresenceVectorSize () const
virtual UInt GetPresenceVectorMask () const
virtual UShort GetMessageCodeOfResponse () const
virtual std::string GetMessageName () const
virtual void ClearMessageBody ()
 Clears message payload data.
virtual bool IsLargeDataSet (const unsigned int maxPayloadSize) const
QueryAudiooperator= (const QueryAudio &message)
 Sets equal to.

Protected Attributes

Byte mDeviceID
 Audio Device ID (e.g. microphone #).

Detailed Description

This message allows a component to request audio information.

Definition at line 55 of file queryaudio.h.


Constructor & Destructor Documentation

QueryAudio::QueryAudio ( const Address dest = Address(),
const Address src = Address() 
)

Constructor, initializes default values.

Parameters:
[in]srcSource ID of message sender.
[in]destDestination ID of message.

Definition at line 53 of file queryaudio.cpp.

QueryAudio::QueryAudio ( const QueryAudio message )

Copy constructor.

Definition at line 65 of file queryaudio.cpp.

QueryAudio::~QueryAudio (  )

Destructor.

Definition at line 76 of file queryaudio.cpp.


Member Function Documentation

void QueryAudio::ClearMessageBody (  ) [virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 131 of file queryaudio.cpp.

virtual Message* JAUS::QueryAudio::Clone (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 66 of file queryaudio.h.

Byte JAUS::QueryAudio::GetDeviceID (  ) const [inline]

Definition at line 62 of file queryaudio.h.

virtual UShort JAUS::QueryAudio::GetMessageCodeOfResponse (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 70 of file queryaudio.h.

virtual std::string JAUS::QueryAudio::GetMessageName (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 71 of file queryaudio.h.

virtual UInt JAUS::QueryAudio::GetPresenceVector (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 67 of file queryaudio.h.

virtual UInt JAUS::QueryAudio::GetPresenceVectorMask (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 69 of file queryaudio.h.

virtual UInt JAUS::QueryAudio::GetPresenceVectorSize (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 68 of file queryaudio.h.

virtual bool JAUS::QueryAudio::IsCommand (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 63 of file queryaudio.h.

virtual bool JAUS::QueryAudio::IsLargeDataSet ( const unsigned int  maxPayloadSize ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 73 of file queryaudio.h.

QueryAudio & QueryAudio::operator= ( const QueryAudio message )

Sets equal to.

Definition at line 142 of file queryaudio.cpp.

int QueryAudio::ReadMessageBody ( const Packet packet ) [virtual]

Reads message payload from the packet.

Message contents are read from the packet following the JAUS standard.

Parameters:
[in]packetPacket containing message payload data to read.
Returns:
-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 115 of file queryaudio.cpp.

void JAUS::QueryAudio::SetDeviceID ( const Byte  id ) [inline]

Definition at line 61 of file queryaudio.h.

int QueryAudio::WriteMessageBody ( Packet packet ) const [virtual]

Writes message payload to the packet.

Message contents are written to the packet following the JAUS standard.

Parameters:
[out]packetPacket to write payload to.
Returns:
-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 93 of file queryaudio.cpp.


Member Data Documentation

Audio Device ID (e.g. microphone #).

Definition at line 76 of file queryaudio.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines