JAUS::ReportImage Class Reference

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

#include <reportimage.h>

Inheritance diagram for JAUS::ReportImage:

List of all members.

Public Member Functions
	ReportImage (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	ReportImage (const ReportImage &message)
	Copy constructor.
	~ReportImage ()
	Destructor.
void	SetFrameNumber (const UInt fnumber)
void	SetCameraID (const Byte id)
void	SetImageFormat (const Image::Format format)
void	SetImage (const Image::Format format, const Packet &imageData)
Byte	GetCameraID () const
UInt	GetFrameNumber () const
Image::Format	GetFormat () const
Packet *	GetImage ()
const Packet *	GetImage () 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
ReportImage &	operator= (const ReportImage &message)
	Sets equal to.
Protected Attributes
Image::Format	mFormat
	Format of image data.
Byte	mCameraID
	Camera ID (number).
UInt	mFrameNumber
	Frame number.
Packet	mImage
	Image data.

---

Detailed Description

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

Definition at line 58 of file reportimage.h.

---

Constructor & Destructor Documentation

ReportImage::ReportImage	(	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 reportimage.cpp.

ReportImage::ReportImage

(

const ReportImage &

message )

Copy constructor.

Definition at line 67 of file reportimage.cpp.

ReportImage::~ReportImage

(

)

Destructor.

Definition at line 81 of file reportimage.cpp.

---

Member Function Documentation

void ReportImage::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 150 of file reportimage.cpp.

virtual Message* JAUS::ReportImage::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 77 of file reportimage.h.

Byte JAUS::ReportImage::GetCameraID

(

)

const [inline]

Definition at line 69 of file reportimage.h.

Image::Format JAUS::ReportImage::GetFormat

(

)

const [inline]

Definition at line 71 of file reportimage.h.

UInt JAUS::ReportImage::GetFrameNumber

(

)

const [inline]

Definition at line 70 of file reportimage.h.

Packet* JAUS::ReportImage::GetImage

(

)

[inline]

Definition at line 72 of file reportimage.h.

const Packet* JAUS::ReportImage::GetImage

(

)

const [inline]

Definition at line 73 of file reportimage.h.

virtual UShort JAUS::ReportImage::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 81 of file reportimage.h.

virtual std::string JAUS::ReportImage::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 82 of file reportimage.h.

virtual UInt JAUS::ReportImage::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 78 of file reportimage.h.

virtual UInt JAUS::ReportImage::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 80 of file reportimage.h.

virtual UInt JAUS::ReportImage::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 79 of file reportimage.h.

virtual bool JAUS::ReportImage::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 74 of file reportimage.h.

bool ReportImage::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [virtual]

Returns:

True if the contents of the message will be larger than maximum payload size, otherwise false.

Implements JAUS::Message.

Definition at line 165 of file reportimage.cpp.

ReportImage & ReportImage::operator=

(

const ReportImage &

message )

Sets equal to.

Definition at line 177 of file reportimage.cpp.

int ReportImage::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 124 of file reportimage.cpp.

void JAUS::ReportImage::SetCameraID

(

const Byte

id )

[inline]

Definition at line 65 of file reportimage.h.

void JAUS::ReportImage::SetFrameNumber

(

const UInt

fnumber )

[inline]

Definition at line 64 of file reportimage.h.

void JAUS::ReportImage::SetImage	(	const Image::Format	format,
		const Packet &	imageData
	)		[inline]

Definition at line 67 of file reportimage.h.

void JAUS::ReportImage::SetImageFormat

(

const Image::Format

format )

[inline]

Definition at line 66 of file reportimage.h.

int ReportImage::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 98 of file reportimage.cpp.

---

Member Data Documentation

Byte JAUS::ReportImage::mCameraID [protected]

Camera ID (number).

Definition at line 88 of file reportimage.h.

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

Format of image data.

Definition at line 87 of file reportimage.h.

UInt JAUS::ReportImage::mFrameNumber [protected]

Frame number.

Definition at line 89 of file reportimage.h.

Packet JAUS::ReportImage::mImage [protected]

Image data.

Definition at line 90 of file reportimage.h.

---

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

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