DUNE: Uniform Navigational Environment  2016.03.0
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]parentparent task.
[in]addrsidescan IPv4 address.
[in]portsidescan 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
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
void Sensors::Klein3500::CommandLink::setFileFormat ( uint32_t  format)
inline
void Sensors::Klein3500::CommandLink::setFilePrefix ( const std::string &  prefix)
inline
void Sensors::Klein3500::CommandLink::setFramingMode ( uint32_t  value)
inline
void Sensors::Klein3500::CommandLink::setPingsPerFile ( uint32_t  ping_count)
inline
void Sensors::Klein3500::CommandLink::setPulseLength ( void  )
inline
void Sensors::Klein3500::CommandLink::setRange ( uint32_t  value)
inline

Set range.

Parameters
[in]rangerange 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
bool Sensors::Klein3500::CommandLink::setRecordingNewFile ( void  )
inline
bool Sensors::Klein3500::CommandLink::setStandBy ( uint32_t  value)
inline

Set standby state of the device.

Parameters
[in]value0 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
bool Sensors::Klein3500::CommandLink::unmountNFS ( const std::string &  mount_point)
inline
Collaboration diagram for Sensors::Klein3500::CommandLink:
Collaboration graph