firevision::FuseLutListContent Class Reference
[FireVision FUSE Network ProtocolFireVision Image Processing Framework and Applications]

FUSE lookup table list content. More...

#include <fvutils/net/fuse_lutlist_content.h>

Inheritance diagram for firevision::FuseLutListContent:

[legend]
List of all members.

Public Member Functions

 FuseLutListContent ()
 Constructor.
 FuseLutListContent (uint32_t type, void *payload, size_t payload_size)
 Parsing constructor.
 ~FuseLutListContent ()
 Destructor.
void add_lutinfo (const char *lut_id, unsigned int width, unsigned int height, unsigned int depth, unsigned int bytes_per_cell)
 Add LUT info.
void reset_iterator ()
 Reset iterator.
bool has_next ()
 Check if another LUT info is available.
FUSE_lutinfo_tnext ()
 Get next LUT info.
virtual void serialize ()
 Serialize message content.

Detailed Description

FUSE lookup table list content.

This content provides means to send an arbitrary length list of LUT information chunks.

Author:
Tim Niemueller

Definition at line 36 of file fuse_lutlist_content.h.


Constructor & Destructor Documentation

firevision::FuseLutListContent::FuseLutListContent (  ) 

Constructor.

Creates an empty list.

Definition at line 52 of file fuse_lutlist_content.cpp.

References firevision::FuseMessageContent::_payload, firevision::FuseMessageContent::_payload_size, and firevision::FUSE_lutlist_message_t::lut_list.

firevision::FuseLutListContent::FuseLutListContent ( uint32_t  type,
void *  payload,
size_t  payload_size 
)

Parsing constructor.

Can be used with the FuseContent::fmsg() method to get correctly parsed output.

Parameters:
type message type, must be FUSE_MT_LUT_LIST
payload payload
payload_size size of payload
Exceptions:
TypeMismatchException thrown if the type is not FUSE_MT_LUT_LIST

Definition at line 68 of file fuse_lutlist_content.cpp.

References firevision::FUSE_lutlist_message_t::lut_list.

firevision::FuseLutListContent::~FuseLutListContent (  ) 

Destructor.

Definition at line 78 of file fuse_lutlist_content.cpp.


Member Function Documentation

void firevision::FuseLutListContent::add_lutinfo ( const char *  lut_id,
unsigned int  width,
unsigned int  height,
unsigned int  depth,
unsigned int  bytes_per_cell 
)

Add LUT info.

Parameters:
lut_id LUT ID
width width of LUT
height height of LUT
depth depth of LUT
bytes_per_cell bytes per cell

Definition at line 92 of file fuse_lutlist_content.cpp.

References fawkes::DynamicBuffer::append().

Referenced by firevision::FuseServerClientThread::process_getlutlist_message().

bool firevision::FuseLutListContent::has_next (  ) 

Check if another LUT info is available.

Returns:
true if another LUT info is available, false otherwise

Definition at line 121 of file fuse_lutlist_content.cpp.

References fawkes::DynamicBuffer::has_next().

Referenced by FireVisionNetworkTool::fuse_inbound_received().

FUSE_lutinfo_t * firevision::FuseLutListContent::next (  ) 

Get next LUT info.

Returns:
next LUT info
Exceptions:
TypeMismatchException thrown if the content contained invalid data
OutOfBoundsException thrown if no more data is available

Definition at line 133 of file fuse_lutlist_content.cpp.

References fawkes::DynamicBuffer::next().

Referenced by FireVisionNetworkTool::fuse_inbound_received().

void firevision::FuseLutListContent::reset_iterator (  ) 

Reset iterator.

Definition at line 111 of file fuse_lutlist_content.cpp.

References fawkes::DynamicBuffer::reset_iterator().

void firevision::FuseLutListContent::serialize (  )  [virtual]

Serialize message content.

Generate a single contiguous buffer. Make _payload point to this buffer and _payload_size contain the size of the buffer.

Implements firevision::FuseMessageContent.

Definition at line 147 of file fuse_lutlist_content.cpp.

References firevision::FuseMessageContent::_payload, firevision::FuseMessageContent::_payload_size, fawkes::DynamicBuffer::buffer(), fawkes::DynamicBuffer::buffer_size(), and firevision::FuseMessageContent::copy_payload().


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:31:44 2011 for Fawkes API by  doxygen 1.4.7