Fawkes API: firevision::FuseLutContent Class Reference

FUSE lookup table content. More...

#include <>>

Inheritance diagram for firevision::FuseLutContent:

Inheritance graph

List of all members.

Public Member Functions
	FuseLutContent (const char lut_id, void buffer, unsigned int width, unsigned int height, unsigned int depth, unsigned int bpc)
	Constructor.
	FuseLutContent (SharedMemoryLookupTable *l)
	Constructor.
	FuseLutContent (uint32_t type, void *payload, size_t payload_size)
	Constructor.
const char *	lut_id () const
	Get LUT ID.
unsigned char *	buffer () const
	Get buffer.
size_t	buffer_size () const
	Get buffer size.
unsigned int	width () const
	Width of LUT.
unsigned int	height () const
	Height of LUT.
unsigned int	depth () const
	Depth of LUT.
unsigned int	bytes_per_cell () const
	Bytes per cell in LUT.
virtual void	serialize ()
	Serialize message content.

Detailed Description

FUSE lookup table content.

Author:: Tim Niemueller

Definition at line 38 of file fuse_lut_content.h.

Constructor & Destructor Documentation

firevision::FuseLutContent::FuseLutContent	(	const char *	lut_id,
		void *	buffer,
		unsigned int	width,
		unsigned int	height,
		unsigned int	depth,
		unsigned int	bpc
	)

Constructor.

Create a brand new FuseLutContent from a raw buffer.

Parameters:

	lut_id	LUT ID
	buffer	buffer that holds the LUT data
	width	LUT width
	height	LUT height
	depth	LUT depth
	bpc	LUT bytes per cell

Definition at line 114 of file fuse_lut_content.cpp.

References firevision::FuseMessageContent::_payload, firevision::FuseMessageContent::_payload_size, firevision::FUSE_lut_message_header_t::bytes_per_cell, firevision::FUSE_lut_message_header_t::depth, firevision::FUSE_lut_message_header_t::height, firevision::FUSE_lut_message_header_t::lut_id, and firevision::FUSE_lut_message_header_t::width.

firevision::FuseLutContent::FuseLutContent ( SharedMemoryLookupTable * b )

Constructor.

Parameters:

b

lookup table to copy data from

Definition at line 79 of file fuse_lut_content.cpp.

References firevision::FuseMessageContent::_payload, firevision::FuseMessageContent::_payload_size, firevision::SharedMemoryLookupTable::buffer(), firevision::FUSE_lut_message_header_t::bytes_per_cell, firevision::SharedMemoryLookupTable::bytes_per_cell(), firevision::FUSE_lut_message_header_t::depth, firevision::SharedMemoryLookupTable::depth(), firevision::FUSE_lut_message_header_t::height, firevision::SharedMemoryLookupTable::height(), firevision::SharedMemoryLookupTable::lut_id(), firevision::FUSE_lut_message_header_t::lut_id, firevision::FUSE_lut_message_header_t::width, and firevision::SharedMemoryLookupTable::width().

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

Constructor.

Parameters:

	type	content type, must be FUSE_MT_LUT
	payload	payload
	payload_size	size of payload

Exceptions:

TypeMismatchException

thrown if type does not equal FUSE_MT_LUT

Definition at line 52 of file fuse_lut_content.cpp.

References firevision::FuseMessageContent::_payload, firevision::FuseMessageContent::_payload_size, firevision::FUSE_lut_message_header_t::bytes_per_cell, firevision::FUSE_lut_message_header_t::depth, firevision::FUSE_lut_message_header_t::height, firevision::FUSE_lut_message_header_t::lut_id, and firevision::FUSE_lut_message_header_t::width.

Member Function Documentation

unsigned char * firevision::FuseLutContent::buffer ( ) const

Get buffer.

Returns:: buffer

Definition at line 159 of file fuse_lut_content.cpp.

Referenced by FuseTransferWidget::fuse_inbound_received(), and firevision::FuseServerClientThread::process_setlut_message().

size_t firevision::FuseLutContent::buffer_size ( ) const

Get buffer size.

Returns:: size of buffer returned by buffer()

Definition at line 169 of file fuse_lut_content.cpp.

unsigned int firevision::FuseLutContent::bytes_per_cell ( ) const

Bytes per cell in LUT.

Returns:: Bytes per cell in LUT

Definition at line 208 of file fuse_lut_content.cpp.

References firevision::FUSE_lut_message_header_t::bytes_per_cell.

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

unsigned int firevision::FuseLutContent::depth ( ) const

Depth of LUT.

Returns:: depth of LUT

Definition at line 198 of file fuse_lut_content.cpp.

References firevision::FUSE_lut_message_header_t::depth.

Referenced by FuseTransferWidget::fuse_inbound_received(), and firevision::FuseServerClientThread::process_setlut_message().

unsigned int firevision::FuseLutContent::height ( ) const

Height of LUT.

Returns:: height of LUT

Definition at line 189 of file fuse_lut_content.cpp.

References firevision::FUSE_lut_message_header_t::height.

Referenced by FuseTransferWidget::fuse_inbound_received(), and firevision::FuseServerClientThread::process_setlut_message().

const char * firevision::FuseLutContent::lut_id ( ) const

Get LUT ID.

Returns:: LUT ID

Definition at line 150 of file fuse_lut_content.cpp.

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

void firevision::FuseLutContent::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 215 of file fuse_lut_content.cpp.

unsigned int firevision::FuseLutContent::width ( ) const

Width of LUT.

Returns:: width of LUT

Definition at line 179 of file fuse_lut_content.cpp.

References firevision::FUSE_lut_message_header_t::width.

Referenced by FuseTransferWidget::fuse_inbound_received(), and firevision::FuseServerClientThread::process_setlut_message().

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

src/firevision/fvutils/net/fuse_lut_content.h
src/firevision/fvutils/net/fuse_lut_content.cpp