Class nebula::drivers::NebulaHwInterfaceBase

ClassList > nebula > drivers > NebulaHwInterfaceBase

Base class for hardware interface of each LiDAR.

#include <nebula_hw_interface_base.hpp>

Public Functions

Type	Name
virtual Status	GetCalibrationConfiguration (] CalibrationConfigurationBase & calibration_configuration) Virtual function for printing calibration configuration.
virtual Status	GetSensorConfiguration (SensorConfigurationBase & sensor_configuration) = 0 Virtual function for printing sensor configuration.
	NebulaHwInterfaceBase (NebulaHwInterfaceBase && c) = delete
	NebulaHwInterfaceBase (const NebulaHwInterfaceBase & c) = delete
	NebulaHwInterfaceBase () = default
virtual Status	SensorInterfaceStart () = 0 Virtual function for starting the interface that handles UDP streams.
virtual Status	SensorInterfaceStop () = 0 Virtual function for stopping the interface that handles UDP streams.
virtual Status	SetSensorConfiguration (std::shared_ptr< SensorConfigurationBase > sensor_configuration) = 0 Virtual function for setting sensor configuration.
NebulaHwInterfaceBase &	operator= (NebulaHwInterfaceBase && c) = delete
NebulaHwInterfaceBase &	operator= (const NebulaHwInterfaceBase & c) = delete

Protected Functions

Type	Name
virtual void	ReceiveSensorPacketCallback (] std::vector< uint8_t > & buffer)

Public Functions Documentation

function GetCalibrationConfiguration

Virtual function for printing calibration configuration.

inline virtual Status nebula::drivers::NebulaHwInterfaceBase::GetCalibrationConfiguration (
    ] CalibrationConfigurationBase & calibration_configuration
)

Parameters:

calibration_configuration CalibrationConfiguration for the checking

Returns:

Resulting status

function GetSensorConfiguration

Virtual function for printing sensor configuration.

virtual Status nebula::drivers::NebulaHwInterfaceBase::GetSensorConfiguration (
    SensorConfigurationBase & sensor_configuration
) = 0

Parameters:

sensor_configuration SensorConfiguration for the checking

Returns:

Resulting status

function NebulaHwInterfaceBase [1/3]

nebula::drivers::NebulaHwInterfaceBase::NebulaHwInterfaceBase (
    NebulaHwInterfaceBase && c
) = delete

function NebulaHwInterfaceBase [2/3]

nebula::drivers::NebulaHwInterfaceBase::NebulaHwInterfaceBase (
    const NebulaHwInterfaceBase & c
) = delete

function NebulaHwInterfaceBase [3/3]

nebula::drivers::NebulaHwInterfaceBase::NebulaHwInterfaceBase () = default

function SensorInterfaceStart

Virtual function for starting the interface that handles UDP streams.

virtual Status nebula::drivers::NebulaHwInterfaceBase::SensorInterfaceStart () = 0

Returns:

Resulting status

function SensorInterfaceStop

Virtual function for stopping the interface that handles UDP streams.

virtual Status nebula::drivers::NebulaHwInterfaceBase::SensorInterfaceStop () = 0

Returns:

Resulting status

function SetSensorConfiguration

Virtual function for setting sensor configuration.

virtual Status nebula::drivers::NebulaHwInterfaceBase::SetSensorConfiguration (
    std::shared_ptr< SensorConfigurationBase > sensor_configuration
) = 0

Parameters:

sensor_configuration SensorConfiguration for this interface

Returns:

Resulting status

function operator=

NebulaHwInterfaceBase & nebula::drivers::NebulaHwInterfaceBase::operator= (
    NebulaHwInterfaceBase && c
) = delete

function operator=

NebulaHwInterfaceBase & nebula::drivers::NebulaHwInterfaceBase::operator= (
    const NebulaHwInterfaceBase & c
) = delete

Protected Functions Documentation

function ReceiveSensorPacketCallback

inline virtual void nebula::drivers::NebulaHwInterfaceBase::ReceiveSensorPacketCallback (
    ] std::vector< uint8_t > & buffer
)

Callback function to receive the Cloud Packet data from the UDP Driver

Parameters:

buffer Buffer containing the data received from the UDP socket

Returns:

Status::OK if no error occurred.

The documentation for this class was generated from the following file nebula_hw_interfaces/include/nebula_hw_interfaces/nebula_hw_interfaces_common/nebula_hw_interface_base.hpp