Fawkes API  Fawkes Development Version

FUSE lookup table list content. More...

#include <>>

Inheritance diagram for firevision::FuseLutListContent:

Public Member Functions

 FuseLutListContent ()
 Constructor. More...
 
 FuseLutListContent (uint32_t type, void *payload, size_t payload_size)
 Parsing constructor. More...
 
 ~FuseLutListContent ()
 Destructor. More...
 
void add_lutinfo (const char *lut_id, unsigned int width, unsigned int height, unsigned int depth, unsigned int bytes_per_cell)
 Add LUT info. More...
 
void reset_iterator ()
 Reset iterator. More...
 
bool has_next ()
 Check if another LUT info is available. More...
 
FUSE_lutinfo_tnext ()
 Get next LUT info. More...
 
virtual void serialize ()
 Serialize message content. More...
 
- Public Member Functions inherited from firevision::FuseMessageContent
 FuseMessageContent ()
 Constructor. More...
 
virtual ~FuseMessageContent ()
 Virtual empty destructor. More...
 
virtual void * payload () const
 Return pointer to payload. More...
 
virtual size_t payload_size () const
 Return payload size. More...
 
void free_payload ()
 Free message payload. More...
 

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. More...
 
- Protected Attributes inherited from firevision::FuseMessageContent
void * _payload
 Pointer to payload. More...
 
size_t _payload_size
 Payloda size. More...
 

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

◆ FuseLutListContent() [1/2]

firevision::FuseLutListContent::FuseLutListContent ( )

Constructor.

Creates an empty list.

Definition at line 52 of file fuse_lutlist_content.cpp.

◆ FuseLutListContent() [2/2]

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.

◆ ~FuseLutListContent()

firevision::FuseLutListContent::~FuseLutListContent ( )

Destructor.

Definition at line 78 of file fuse_lutlist_content.cpp.

Member Function Documentation

◆ add_lutinfo()

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().

◆ has_next()

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().

◆ next()

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().

◆ reset_iterator()

void firevision::FuseLutListContent::reset_iterator ( )

Reset iterator.

Definition at line 111 of file fuse_lutlist_content.cpp.

◆ serialize()

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: