FuseLutListContent Class Reference
[FireVision FUSE Network Protocol, FireVision Image Processing Framework and Applications]

FUSE lookup table list content. More...

#include <fvutils/net/fuse_lutlist_content.h>

Inheritance diagram for FuseLutListContent:

Inheritance graph
[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_t * next ()
 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 31 of file fuse_lutlist_content.h.

Constructor & Destructor Documentation

FuseLutListContent::FuseLutListContent (  ) 

Constructor.

Creates an empty list.

Definition at line 47 of file fuse_lutlist_content.cpp.

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

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 63 of file fuse_lutlist_content.cpp.

References FUSE_lutlist_message_t::lut_list.

FuseLutListContent::~FuseLutListContent (  ) 

Destructor.

Definition at line 73 of file fuse_lutlist_content.cpp.

Member Function Documentation

void 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 87 of file fuse_lutlist_content.cpp.

References fawkes::DynamicBuffer::append(), FUSE_lutinfo_t::bytes_per_cell, FUSE_lutinfo_t::depth, FUSE_lutinfo_t::height, FUSE_lutinfo_t::lut_id, and FUSE_lutinfo_t::width.

Referenced by FuseServerClientThread::process_getlutlist_message().

bool FuseLutListContent::has_next (  ) 

Check if another LUT info is available.

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

Definition at line 116 of file fuse_lutlist_content.cpp.

References fawkes::DynamicBuffer::has_next().

Referenced by FuseTransferWidget::fuse_inbound_received(), and FireVisionNetworkTool::fuse_inbound_received().

FUSE_lutinfo_t * 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 128 of file fuse_lutlist_content.cpp.

References fawkes::DynamicBuffer::next().

Referenced by FuseTransferWidget::fuse_inbound_received(), and FireVisionNetworkTool::fuse_inbound_received().

void FuseLutListContent::reset_iterator (  ) 

Reset iterator.

Definition at line 106 of file fuse_lutlist_content.cpp.

References fawkes::DynamicBuffer::reset_iterator().

void 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 FuseMessageContent.

Definition at line 142 of file fuse_lutlist_content.cpp.

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

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