Fawkes API  Fawkes Development Version
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages

FUSE lookup table list content. More...

#include <>>

Inheritance diagram for firevision::FuseLutListContent:

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.
- Public Member Functions inherited from firevision::FuseMessageContent
 FuseMessageContent ()
 Constructor.
virtual ~FuseMessageContent ()
 Virtual empty destructor.
virtual void * payload () const
 Return pointer to payload.
virtual size_t payload_size () const
 Return payload size.
void free_payload ()
 Free message payload.

Additional Inherited Members

- Protected Member Functions inherited from firevision::FuseMessageContent
void copy_payload (size_t offset, void *buf, size_t len)
 Copy payload into payload buffer to a specified offset.
- Protected Attributes inherited from firevision::FuseMessageContent
void * _payload
 Pointer to payload.
size_t _payload_size
 Payloda size.

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.

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:
typemessage type, must be FUSE_MT_LUT_LIST
payloadpayload
payload_sizesize of payload
Exceptions:
TypeMismatchExceptionthrown 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_idLUT ID
widthwidth of LUT
heightheight of LUT
depthdepth of LUT
bytes_per_cellbytes per cell

Definition at line 92 of file fuse_lutlist_content.cpp.

References firevision::FUSE_lutinfo_t::bytes_per_cell, firevision::FUSE_lutinfo_t::depth, firevision::FUSE_lutinfo_t::height, firevision::FUSE_lutinfo_t::lut_id, and firevision::FUSE_lutinfo_t::width.

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.

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

FUSE_lutinfo_t * firevision::FuseLutListContent::next ( )

Get next LUT info.

Returns:
next LUT info
Exceptions:
TypeMismatchExceptionthrown if the content contained invalid data
OutOfBoundsExceptionthrown if no more data is available

Definition at line 133 of file fuse_lutlist_content.cpp.

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

void firevision::FuseLutListContent::reset_iterator ( )

Reset iterator.

Definition at line 111 of file fuse_lutlist_content.cpp.

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.


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