Sensors::Klein3500::CommandLink Class Reference

Public Member Functions
	CommandLink (Tasks::Task *parent, const Address &addr, unsigned port)
	~CommandLink (void)
bool	setStandBy (uint32_t value)
void	setRange (uint32_t value)
void	setFramingMode (uint32_t value)
void	setTime (void)
void	setPulseLength (void)
void	setReceiverGain (void)
void	sendNavigationData (const IMC::EstimatedState &estate)
void	getDataPage (PingType ping_type, uint32_t ping_number)
void	setFileFormat (uint32_t format)
void	setPingsPerFile (uint32_t ping_count)
bool	setRecordingMode (bool mode)
bool	setRecordingFilePath (const std::string &path)
void	setFilePrefix (const std::string &prefix)
bool	unmountNFS (const std::string &mount_point)
bool	setRecordingNewFile (void)
bool	readDataPage (Packet *packet, double timeout=1.0)

Constructor & Destructor Documentation

Sensors::Klein3500::CommandLink::CommandLink ( Tasks::Task *  parent, const Address &  addr, unsigned  port  )

inline

Create a command link to the sidescan.

Parameters

[in]	parent	parent task.
[in]	addr	sidescan IPv4 address.
[in]	port	sidescan TCP port.

References setTime().

Sensors::Klein3500::CommandLink::~CommandLink ( void  )

inline

Destroy command link to the sidescan.

Member Function Documentation

void Sensors::Klein3500::CommandLink::getDataPage ( PingType  ping_type, uint32_t  ping_number  )

inline

References Sensors::Klein3500::CMD_GET_DATA_PAGE2.

bool Sensors::Klein3500::CommandLink::readDataPage ( Packet *  packet, double  timeout = 1.0  )

inline

FIXME: keep backlog.

References Sensors::Klein3500::Parser::parse().

void Sensors::Klein3500::CommandLink::sendNavigationData ( const IMC::EstimatedState &  estate )

inline

References DUNE::Coordinates::latitudeToNMEA(), and DUNE::Coordinates::longitudeToNMEA().

Referenced by Sensors::Klein3500::Task::consume().

void Sensors::Klein3500::CommandLink::setFileFormat ( uint32_t  format )

inline

References Sensors::Klein3500::CMD_SET_FILE_FORMAT.

Referenced by Sensors::Klein3500::Task::initConfig().

void Sensors::Klein3500::CommandLink::setFilePrefix ( const std::string &  prefix )

inline

References Sensors::Klein3500::CMD_SET_FILE_PREFIX, and Sensors::Klein3500::Packet::getData().

Referenced by Sensors::Klein3500::Task::initConfig(), and Sensors::Klein3500::Task::onUpdateParameters().

void Sensors::Klein3500::CommandLink::setFramingMode ( uint32_t  value )

inline

Set framing mode.

References Sensors::Klein3500::CMD_SET_FRAME_MODE.

Referenced by Sensors::Klein3500::Task::setFramingMode().

void Sensors::Klein3500::CommandLink::setPingsPerFile ( uint32_t  ping_count )

inline

References Sensors::Klein3500::CMD_SET_PINGS_PER_FILE.

Referenced by Sensors::Klein3500::Task::initConfig(), and Sensors::Klein3500::Task::onUpdateParameters().

void Sensors::Klein3500::CommandLink::setPulseLength ( void  )

inline

void Sensors::Klein3500::CommandLink::setRange ( uint32_t  value )

inline

Set range.

Parameters

[in]

range

range in meter.

References Sensors::Klein3500::CMD_SET_RANGE.

Referenced by Sensors::Klein3500::Task::initConfig(), and Sensors::Klein3500::Task::onUpdateParameters().

void Sensors::Klein3500::CommandLink::setReceiverGain ( void  )

inline

bool Sensors::Klein3500::CommandLink::setRecordingFilePath ( const std::string &  path )

inline

References Sensors::Klein3500::CMD_SET_FILE_PATH, and Sensors::Klein3500::Packet::getData().

Referenced by Sensors::Klein3500::Task::disconnect(), and Sensors::Klein3500::Task::openLog().

bool Sensors::Klein3500::CommandLink::setRecordingMode ( bool  mode )

inline

References Sensors::Klein3500::CMD_SET_RECORDING_MODE, and Sensors::Klein3500::Packet::getData().

Referenced by Sensors::Klein3500::Task::closeLog(), Sensors::Klein3500::Task::disconnect(), Sensors::Klein3500::Task::initConfig(), and Sensors::Klein3500::Task::openLog().

bool Sensors::Klein3500::CommandLink::setRecordingNewFile ( void  )

inline

References Sensors::Klein3500::CMD_SET_NEW_FILE, and Sensors::Klein3500::Packet::getData().

Referenced by Sensors::Klein3500::Task::disconnect(), and Sensors::Klein3500::Task::openLog().

bool Sensors::Klein3500::CommandLink::setStandBy ( uint32_t  value )

inline

Set standby state of the device.

Parameters

[in]

value

0 to enter run mode, any other value to enter paused mode.

References Sensors::Klein3500::CMD_SET_STAND_BY, and Sensors::Klein3500::Packet::getData().

Referenced by Sensors::Klein3500::Task::disconnect(), Sensors::Klein3500::Task::initConfig(), and Sensors::Klein3500::Task::onActivation().

void Sensors::Klein3500::CommandLink::setTime ( void  )

inline

Set sonar time.

References Sensors::Klein3500::CMD_SET_TIME, and Sensors::Klein3500::Packet::getData().

Referenced by CommandLink().

bool Sensors::Klein3500::CommandLink::unmountNFS ( const std::string &  mount_point )

inline

References Sensors::Klein3500::CMD_UNMOUNT_NFS, and Sensors::Klein3500::Packet::getData().

Referenced by Sensors::Klein3500::Task::disconnect().

Collaboration diagram for Sensors::Klein3500::CommandLink: