Base class for all of the HFL cameras. More...

#include <hfl_interface.h>

Inheritance diagram for hfl::HflInterface:

Public Member Functions
std::string	getModel () const

std::string	getVersion () const

virtual bool	setFrameRate (double rate)=0

virtual double	getFrameRate (bool reg_format=false) const =0

virtual bool	setGlobalRangeOffset (double offset)=0

virtual bool	setChannelRangeOffset (uint8_t ch, double offset)=0

virtual bool	setIntensityRangeOffset (uint8_t band, double offset)=0

virtual bool	parseFrame (int start_byte, const std::vector< uint8_t > &packet)=0

virtual bool	processFrameData (const std::vector< uint8_t > &data)=0

virtual bool	parseObjects (int start_byte, const std::vector< uint8_t > &packet)=0

virtual bool	processObjectData (const std::vector< uint8_t > &data)=0

std::shared_ptr< Frame >	frame ()

Protected Attributes
std::string	model_
	Current camera model. More...

std::string	version_
	Current camera model. More...

std::string	ip_address_
	Camera's IP address. More...

uint16_t	frame_data_port_
	Camera's UDP frame data port. More...

bool	publish_tf_
	Current publish tf state. More...

std::string	parent_frame_
	current static tf values More...

double	x_

double	y_

double	z_

double	roll_

double	pitch_

double	yaw_

double	time_offset_
	time offset More...

double	global_offset_
	global range offset More...

double	ch1_offset_
	channel range offset More...

double	ch2_offset_

double	ch3_offset_

double	ch4_offset_

double	int500_offset_
	intensity range offset More...

double	int1000_offset_

double	int1500_offset_

double	int2000_offset_

double	int2500_offset_

double	int3000_offset_

double	int3500_offset_

double	int4096_offset_

std::shared_ptr< hfl::Frame >	frame_
	Camera's frame configurations. More...

Detailed Description

Base class for all of the HFL cameras.

Member Function Documentation

◆ frame()

std::shared_ptr< Frame > hfl::HflInterface::frame ( )

Reference to the frame_ member variable

Returns: frame shared_ptr

◆ getFrameRate()

virtual double hfl::HflInterface::getFrameRate ( bool reg_format = false ) const

pure virtual

Returns the current frame rate.

Parameters

[in] reg_format Indicates register format output

Returns: current frame rate

Implemented in hfl::BaseHFL110DCU.

◆ getModel()

std::string hfl::HflInterface::getModel ( ) const

Gets the Model of the camera.

Returns: string camera model

◆ getVersion()

std::string hfl::HflInterface::getVersion ( ) const

Gets the camera version.

Returns: string camera model version

◆ parseFrame()

virtual bool hfl::HflInterface::parseFrame	(	int	start_byte,
		const std::vector< uint8_t > &	packet
	)

pure virtual

Parse packet into depth and intensity image

Parameters

[in] start_byte starting byte, packet packet data to parse

Returns: bool true if successfully parsed frame data

Implemented in hfl::HFL110DCU.

◆ parseObjects()

virtual bool hfl::HflInterface::parseObjects	(	int	start_byte,
		const std::vector< uint8_t > &	packet
	)

pure virtual

Parse packet into objects

Parameters

[in] start_byte starting byte, packet packet data to parse

Returns: bool true if successfully parsed object data

Implemented in hfl::BaseHFL110DCU, and hfl::HFL110DCU.

◆ processFrameData()

virtual bool hfl::HflInterface::processFrameData ( const std::vector< uint8_t > & data )

pure virtual

Process the frame data from udp packets

Parameters

[in] data frame data

Returns: bool

Implemented in hfl::HFL110DCU.

◆ processObjectData()

virtual bool hfl::HflInterface::processObjectData ( const std::vector< uint8_t > & data )

pure virtual

Process the object data from udp packets

Parameters

[in] data object data

Returns: bool

Implemented in hfl::BaseHFL110DCU, and hfl::HFL110DCU.

◆ setChannelRangeOffset()

virtual bool hfl::HflInterface::setChannelRangeOffset	(	uint8_t	ch,
		double	offset
	)

pure virtual

Sets channel range offset

Parameters

[in]	ch	channel number
[in]	offset	channel range offset to set

Returns: bool true if given channel range offset is set

Implemented in hfl::BaseHFL110DCU.

◆ setFrameRate()

virtual bool hfl::HflInterface::setFrameRate ( double rate )

pure virtual

Set the frame rate.

Parameters

[in] rate Camera frame rate

Returns: bool true if given frame rate set

Implemented in hfl::BaseHFL110DCU.

◆ setGlobalRangeOffset()

virtual bool hfl::HflInterface::setGlobalRangeOffset ( double offset )

pure virtual

Sets global range offset

Parameters

[in] offset global range offset to set

Returns: bool true if given global range offset is set

Implemented in hfl::BaseHFL110DCU.

◆ setIntensityRangeOffset()

virtual bool hfl::HflInterface::setIntensityRangeOffset	(	uint8_t	band,
		double	offset
	)

pure virtual

Sets intensity range offset

Parameters

[in]	band	intensity range number
[in]	offset	channel range offset to set

Returns: bool true if given intensity band range offset is set

Implemented in hfl::BaseHFL110DCU.

Member Data Documentation

◆ ch1_offset_

double hfl::HflInterface::ch1_offset_

protected

channel range offset

◆ ch2_offset_

double hfl::HflInterface::ch2_offset_

protected

◆ ch3_offset_

double hfl::HflInterface::ch3_offset_

protected

◆ ch4_offset_

double hfl::HflInterface::ch4_offset_

protected

◆ frame_

std::shared_ptr<hfl::Frame> hfl::HflInterface::frame_

protected

Camera's frame configurations.

◆ frame_data_port_

uint16_t hfl::HflInterface::frame_data_port_

protected

Camera's UDP frame data port.

◆ global_offset_

double hfl::HflInterface::global_offset_

protected

global range offset

◆ int1000_offset_

double hfl::HflInterface::int1000_offset_

protected

◆ int1500_offset_

double hfl::HflInterface::int1500_offset_

protected

◆ int2000_offset_

double hfl::HflInterface::int2000_offset_

protected

◆ int2500_offset_

double hfl::HflInterface::int2500_offset_

protected

◆ int3000_offset_

double hfl::HflInterface::int3000_offset_

protected

◆ int3500_offset_

double hfl::HflInterface::int3500_offset_

protected

◆ int4096_offset_

double hfl::HflInterface::int4096_offset_

protected

◆ int500_offset_

double hfl::HflInterface::int500_offset_

protected

intensity range offset

◆ ip_address_

std::string hfl::HflInterface::ip_address_

protected

Camera's IP address.

◆ model_

std::string hfl::HflInterface::model_

protected

Current camera model.

◆ parent_frame_

std::string hfl::HflInterface::parent_frame_

protected

current static tf values

◆ pitch_

double hfl::HflInterface::pitch_

protected

◆ publish_tf_

bool hfl::HflInterface::publish_tf_

protected

Current publish tf state.

◆ roll_

double hfl::HflInterface::roll_

protected

◆ time_offset_

double hfl::HflInterface::time_offset_

protected

time offset

◆ version_

std::string hfl::HflInterface::version_

protected

Current camera model.

◆ x_

double hfl::HflInterface::x_

protected

◆ y_

double hfl::HflInterface::y_

protected

◆ yaw_

double hfl::HflInterface::yaw_

protected

◆ z_

double hfl::HflInterface::z_

protected

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

hfl_utilities/include/hfl_interface.h
hfl_utilities/src/hfl_interface.cpp

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ frame()

◆ getFrameRate()

◆ getModel()

◆ getVersion()

◆ parseFrame()

◆ parseObjects()

◆ processFrameData()

◆ processObjectData()

◆ setChannelRangeOffset()

◆ setFrameRate()

◆ setGlobalRangeOffset()

◆ setIntensityRangeOffset()

Member Data Documentation

◆ ch1_offset_

◆ ch2_offset_

◆ ch3_offset_

◆ ch4_offset_

◆ frame_

◆ frame_data_port_

◆ global_offset_

◆ int1000_offset_

◆ int1500_offset_

◆ int2000_offset_

◆ int2500_offset_

◆ int3000_offset_

◆ int3500_offset_

◆ int4096_offset_

◆ int500_offset_

◆ ip_address_

◆ model_

◆ parent_frame_

◆ pitch_

◆ publish_tf_

◆ roll_

◆ time_offset_

◆ version_

◆ x_

◆ y_

◆ yaw_

◆ z_