JAUS::QueryImage Class Reference

This message allows a component to request an image or video frame. More...

#include <queryimage.h>

Inheritance diagram for JAUS::QueryImage:

List of all members.

Public Member Functions
	QueryImage (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	QueryImage (const QueryImage &message)
	Copy constructor.
	~QueryImage ()
	Destructor.
void	SetCameraID (const Byte id)
void	SetFormat (const Image::Format format)
Byte	GetCameraID () const
Image::Format	GetFormat () 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 Message *	Clone () 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
QueryImage &	operator= (const QueryImage &message)
	Sets equal to.
Protected Attributes
Image::Format	mFormat
	Format of image data.
Byte	mCameraID
	Camera ID (number).

---

Detailed Description

This message allows a component to request an image or video frame.

Definition at line 58 of file queryimage.h.

---

Constructor & Destructor Documentation

QueryImage::QueryImage	(	const Address &	dest = Address(),
		const Address &	src = Address()
	)

Constructor, initializes default values.

Parameters:

[in]	src	Source ID of message sender.
[in]	dest	Destination ID of message.

Definition at line 53 of file queryimage.cpp.

QueryImage::QueryImage

(

const QueryImage &

message )

Copy constructor.

Definition at line 66 of file queryimage.cpp.

QueryImage::~QueryImage

(

)

Destructor.

Definition at line 77 of file queryimage.cpp.

---

Member Function Documentation

void QueryImage::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 134 of file queryimage.cpp.

virtual Message* JAUS::QueryImage::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 71 of file queryimage.h.

Byte JAUS::QueryImage::GetCameraID

(

)

const [inline]

Definition at line 66 of file queryimage.h.

Image::Format JAUS::QueryImage::GetFormat

(

)

const [inline]

Definition at line 67 of file queryimage.h.

virtual UShort JAUS::QueryImage::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 75 of file queryimage.h.

virtual std::string JAUS::QueryImage::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 76 of file queryimage.h.

virtual UInt JAUS::QueryImage::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 72 of file queryimage.h.

virtual UInt JAUS::QueryImage::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 74 of file queryimage.h.

virtual UInt JAUS::QueryImage::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 73 of file queryimage.h.

virtual bool JAUS::QueryImage::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 68 of file queryimage.h.

virtual bool JAUS::QueryImage::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 78 of file queryimage.h.

QueryImage & QueryImage::operator=

(

const QueryImage &

message )

Sets equal to.

Definition at line 146 of file queryimage.cpp.

int QueryImage::ReadMessageBody

(

const Packet &

packet )

[virtual]

Reads message payload from the packet.

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

Parameters:

[in]

packet

Packet containing message payload data to read.

Returns:

-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 117 of file queryimage.cpp.

void JAUS::QueryImage::SetCameraID

(

const Byte

id )

[inline]

Definition at line 64 of file queryimage.h.

void JAUS::QueryImage::SetFormat

(

const Image::Format

format )

[inline]

Definition at line 65 of file queryimage.h.

int QueryImage::WriteMessageBody

(

Packet &

packet )

const [virtual]

Writes message payload to the packet.

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

Parameters:

[out]

packet

Packet to write payload to.

Returns:

-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 94 of file queryimage.cpp.

---

Member Data Documentation

Byte JAUS::QueryImage::mCameraID [protected]

Camera ID (number).

Definition at line 82 of file queryimage.h.

Image::Format JAUS::QueryImage::mFormat [protected]

Format of image data.

Definition at line 81 of file queryimage.h.

---

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

• jaus++/2.0/include/jaus/extras/video/queryimage.h
• jaus++/2.0/src/jaus/extras/video/queryimage.cpp