Transports::SUNSET Namespace Reference

Classes
class	Link
struct	ScheduleKey
class	Schedule
class	Scheduler
class	Sensors
class	AbstractCommand
class	CommandOk
class	CommandError
class	CommandFailure
class	PacketTx
class	PacketTxStatus
class	PacketRx
class	Param
class	ParamGet
class	ParamSet
class	Abort
class	Aborted
class	PlanListGet
class	PlanList
class	PlanGet
class	Plan
class	PlanStart
class	PlanStarted
class	PlanStop
class	PlanStopped
class	PlanDelete
class	PlanDeleted
class	PlanAdd
class	PlanAdded
class	SensorListGet
class	SensorList
class	SensorInfoGet
class	SensorInfo
class	SensorSampleGet
class	SensorSample
class	PositionGet
class	Position
class	RangeGet
class	Range
class	InvalidChecksum
class	InvalidFormat
class	InvalidVersion
class	InvalidRequest
class	InvalidValue
class	Factory
struct	PositionType
struct	ZReference
struct	SpeedReference
struct	SensorInfoTuple
class	Maneuver
class	Goto
class	StationKeeping
struct	Arguments
struct	Task

Typedefs
typedef std::map< unsigned, unsigned >	AddressMap
typedef std::map< std::string, unsigned >	MapName
typedef std::map< unsigned, std::string >	MapAddr

Enumerations
enum	ParamName { NODE_ID, BROADCAST_ID, TX_POWER }
enum	ErrorType {   ERR_INVALID_CRC, ERR_INVALID_FORMAT, ERR_INVALID_VERSION, ERR_INVALID_REQUEST,   ERR_INVALID_VALUE, ERR_BUSY }
enum	FailureType {   FAIL_INVALID_VERSION, FAIL_INVALID_REQUEST, FAIL_EXPIRED, FAIL_INTERNAL_ERROR,   FAIL_BUSY }
enum	TxErrorType { TX_ERR_SUCCESS, TX_ERR_TX_RETRY_LIMIT }
enum	TxStatusType {   TX_STA_RECEIVED, TX_STA_ERROR, TX_STA_QUEUED, TX_STA_TX_START,   TX_STA_TX_END, TX_STA_TRANSMITTED, TX_STA_DELIVERED, TX_STA_EXPIRED,   TX_STA_CANCELED }
enum	ZUnits { DEPTH, ALTITUDE }
enum	SpeedUnits { METER_PS, RPM, PERCENTAGE }

Functions
size_t	encodeType (std::vector< std::string > &args__, const int &value__, const char *format__="%d")
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, int &value__, const char *format__="%d")
size_t	encodeType (std::vector< std::string > &args__, const unsigned &value__, const char *format__="%u")
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, unsigned &value__, const char *format__="%u")
size_t	encodeType (std::vector< std::string > &args__, const double &value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, double &value__)
size_t	encodeType (std::vector< std::string > &args__, const std::string &value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, std::string &value__)
void	reset (ParamName &value__)
size_t	encodeType (std::vector< std::string > &args__, const ParamName &value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, ParamName &value__)
void	toText (std::ostream &os__, const ParamName &value__)
void	reset (ErrorType &value__)
size_t	encodeType (std::vector< std::string > &args__, const ErrorType &value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, ErrorType &value__)
void	toText (std::ostream &os__, const ErrorType &value__)
void	reset (FailureType &value__)
size_t	encodeType (std::vector< std::string > &args__, const FailureType &value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, FailureType &value__)
void	toText (std::ostream &os__, const FailureType &value__)
void	reset (TxErrorType &value__)
size_t	encodeType (std::vector< std::string > &args__, const TxErrorType &value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, TxErrorType &value__)
void	toText (std::ostream &os__, const TxErrorType &value__)
void	reset (TxStatusType &value__)
size_t	encodeType (std::vector< std::string > &args__, const TxStatusType &value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, TxStatusType &value__)
void	toText (std::ostream &os__, const TxStatusType &value__)
void	reset (ZUnits &value__)
size_t	encodeType (std::vector< std::string > &args__, const ZUnits &value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, ZUnits &value__)
void	toText (std::ostream &os__, const ZUnits &value__)
void	reset (SpeedUnits &value__)
size_t	encodeType (std::vector< std::string > &args__, const SpeedUnits &value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, SpeedUnits &value__)
void	toText (std::ostream &os__, const SpeedUnits &value__)
void	reset (PositionType &value__)
size_t	encodeType (std::vector< std::string > &args__, const PositionType &value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, PositionType &value__)
void	reset (ZReference &value__)
size_t	encodeType (std::vector< std::string > &args__, const ZReference &value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, ZReference &value__)
void	reset (SpeedReference &value__)
size_t	encodeType (std::vector< std::string > &args__, const SpeedReference &value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, SpeedReference &value__)
void	reset (SensorInfoTuple &value__)
size_t	encodeType (std::vector< std::string > &args__, const SensorInfoTuple &value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, SensorInfoTuple &value__)
size_t	encodeType (std::vector< std::string > &args__, const Maneuver *value__)
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, Maneuver *&value__)
template<typename Type >
size_t	encodeType (std::vector< std::string > &args__, const std::vector< Type > &value__)
template<typename Type >
size_t	decodeType (const std::vector< std::string > &args__, size_t index__, std::vector< Type > &value__)

Typedef Documentation

typedef std::map<unsigned, unsigned> Transports::SUNSET::AddressMap

typedef std::map<unsigned, std::string> Transports::SUNSET::MapAddr

typedef std::map<std::string, unsigned> Transports::SUNSET::MapName

Enumeration Type Documentation

enum Transports::SUNSET::ErrorType

Enumerator
ERR_INVALID_CRC
ERR_INVALID_FORMAT
ERR_INVALID_VERSION
ERR_INVALID_REQUEST
ERR_INVALID_VALUE
ERR_BUSY

enum Transports::SUNSET::FailureType

Enumerator
FAIL_INVALID_VERSION
FAIL_INVALID_REQUEST
FAIL_EXPIRED
FAIL_INTERNAL_ERROR
FAIL_BUSY

enum Transports::SUNSET::ParamName

Enumerator
NODE_ID
BROADCAST_ID
TX_POWER

enum Transports::SUNSET::SpeedUnits

Enumerator
METER_PS
RPM
PERCENTAGE

enum Transports::SUNSET::TxErrorType

Enumerator
TX_ERR_SUCCESS
TX_ERR_TX_RETRY_LIMIT

enum Transports::SUNSET::TxStatusType

Enumerator
TX_STA_RECEIVED
TX_STA_ERROR
TX_STA_QUEUED
TX_STA_TX_START
TX_STA_TX_END
TX_STA_TRANSMITTED
TX_STA_DELIVERED
TX_STA_EXPIRED
TX_STA_CANCELED

enum Transports::SUNSET::ZUnits

Enumerator
DEPTH
ALTITUDE

Function Documentation

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		int &	value__,
		const char *	format__ = "%d"
	)

Referenced by Transports::SUNSET::CommandOk::decodeArgs(), Transports::SUNSET::CommandError::decodeArgs(), Transports::SUNSET::CommandFailure::decodeArgs(), Transports::SUNSET::PacketTx::decodeArgs(), Transports::SUNSET::PacketTxStatus::decodeArgs(), Transports::SUNSET::PacketRx::decodeArgs(), Transports::SUNSET::Param::decodeArgs(), Transports::SUNSET::ParamGet::decodeArgs(), Transports::SUNSET::ParamSet::decodeArgs(), Transports::SUNSET::PlanList::decodeArgs(), Transports::SUNSET::PlanGet::decodeArgs(), Transports::SUNSET::Plan::decodeArgs(), Transports::SUNSET::PlanStart::decodeArgs(), Transports::SUNSET::Goto::decodeArgs(), Transports::SUNSET::PlanStarted::decodeArgs(), Transports::SUNSET::StationKeeping::decodeArgs(), Transports::SUNSET::PlanStopped::decodeArgs(), Transports::SUNSET::PlanDelete::decodeArgs(), Transports::SUNSET::PlanDeleted::decodeArgs(), Transports::SUNSET::PlanAdd::decodeArgs(), Transports::SUNSET::PlanAdded::decodeArgs(), Transports::SUNSET::SensorList::decodeArgs(), Transports::SUNSET::SensorInfoGet::decodeArgs(), Transports::SUNSET::SensorInfo::decodeArgs(), Transports::SUNSET::SensorSampleGet::decodeArgs(), Transports::SUNSET::SensorSample::decodeArgs(), Transports::SUNSET::PositionGet::decodeArgs(), Transports::SUNSET::Position::decodeArgs(), Transports::SUNSET::RangeGet::decodeArgs(), Transports::SUNSET::Range::decodeArgs(), and decodeType().

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		unsigned &	value__,
		const char *	format__ = "%u"
	)

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		double &	value__
	)

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		std::string &	value__
	)

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		ParamName &	value__
	)

References BROADCAST_ID, NODE_ID, and TX_POWER.

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		ErrorType &	value__
	)

References ERR_BUSY, ERR_INVALID_CRC, ERR_INVALID_FORMAT, ERR_INVALID_REQUEST, ERR_INVALID_VALUE, and ERR_INVALID_VERSION.

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		FailureType &	value__
	)

References FAIL_BUSY, FAIL_EXPIRED, FAIL_INTERNAL_ERROR, FAIL_INVALID_REQUEST, and FAIL_INVALID_VERSION.

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		TxErrorType &	value__
	)

References TX_ERR_SUCCESS, and TX_ERR_TX_RETRY_LIMIT.

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		TxStatusType &	value__
	)

References TX_STA_CANCELED, TX_STA_DELIVERED, TX_STA_ERROR, TX_STA_EXPIRED, TX_STA_QUEUED, TX_STA_RECEIVED, TX_STA_TRANSMITTED, TX_STA_TX_END, and TX_STA_TX_START.

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		ZUnits &	value__
	)

References ALTITUDE, and DEPTH.

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		SpeedUnits &	value__
	)

References METER_PS, PERCENTAGE, and RPM.

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		PositionType &	value__
	)

References Transports::SUNSET::PositionType::altitude, decodeType(), Transports::SUNSET::PositionType::depth, Transports::SUNSET::PositionType::latitude, and Transports::SUNSET::PositionType::longitude.

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		ZReference &	value__
	)

References decodeType(), Transports::SUNSET::ZReference::z_reference, and Transports::SUNSET::ZReference::z_units.

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		SpeedReference &	value__
	)

References decodeType(), Transports::SUNSET::SpeedReference::speed_reference, and Transports::SUNSET::SpeedReference::speed_units.

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		SensorInfoTuple &	value__
	)

References decodeType(), Transports::SUNSET::SensorInfoTuple::sensor_id, Transports::SUNSET::SensorInfoTuple::sensor_model, and Transports::SUNSET::SensorInfoTuple::sensor_vendor.

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		Maneuver *&	value__
	)

References Transports::SUNSET::Maneuver::decodeArgs(), and decodeType().

template<typename Type >

size_t Transports::SUNSET::decodeType	(	const std::vector< std::string > &	args__,
		size_t	index__,
		std::vector< Type > &	value__
	)

References decodeType().

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const int &	value__,
		const char *	format__ = "%d"
	)

References DUNE::Utils::String::str().

Referenced by Transports::SUNSET::CommandOk::encodeArgs(), Transports::SUNSET::CommandError::encodeArgs(), Transports::SUNSET::CommandFailure::encodeArgs(), Transports::SUNSET::PacketTx::encodeArgs(), Transports::SUNSET::PacketTxStatus::encodeArgs(), Transports::SUNSET::PacketRx::encodeArgs(), Transports::SUNSET::Param::encodeArgs(), Transports::SUNSET::ParamGet::encodeArgs(), Transports::SUNSET::ParamSet::encodeArgs(), Transports::SUNSET::PlanList::encodeArgs(), Transports::SUNSET::PlanGet::encodeArgs(), Transports::SUNSET::Plan::encodeArgs(), Transports::SUNSET::PlanStart::encodeArgs(), Transports::SUNSET::Goto::encodeArgs(), Transports::SUNSET::PlanStarted::encodeArgs(), Transports::SUNSET::StationKeeping::encodeArgs(), Transports::SUNSET::PlanStopped::encodeArgs(), Transports::SUNSET::PlanDelete::encodeArgs(), Transports::SUNSET::PlanDeleted::encodeArgs(), Transports::SUNSET::PlanAdd::encodeArgs(), Transports::SUNSET::PlanAdded::encodeArgs(), Transports::SUNSET::SensorList::encodeArgs(), Transports::SUNSET::SensorInfoGet::encodeArgs(), Transports::SUNSET::SensorInfo::encodeArgs(), Transports::SUNSET::SensorSampleGet::encodeArgs(), Transports::SUNSET::SensorSample::encodeArgs(), Transports::SUNSET::PositionGet::encodeArgs(), Transports::SUNSET::Position::encodeArgs(), Transports::SUNSET::RangeGet::encodeArgs(), Transports::SUNSET::Range::encodeArgs(), and encodeType().

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const unsigned &	value__,
		const char *	format__ = "%u"
	)

References DUNE::Utils::String::str().

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const double &	value__
	)

References DUNE::Utils::String::str().

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const std::string &	value__
	)

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const ParamName &	value__
	)

References BROADCAST_ID, NODE_ID, and TX_POWER.

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const ErrorType &	value__
	)

References ERR_BUSY, ERR_INVALID_CRC, ERR_INVALID_FORMAT, ERR_INVALID_REQUEST, ERR_INVALID_VALUE, and ERR_INVALID_VERSION.

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const FailureType &	value__
	)

References FAIL_BUSY, FAIL_EXPIRED, FAIL_INTERNAL_ERROR, FAIL_INVALID_REQUEST, and FAIL_INVALID_VERSION.

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const TxErrorType &	value__
	)

References TX_ERR_SUCCESS, and TX_ERR_TX_RETRY_LIMIT.

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const TxStatusType &	value__
	)

References TX_STA_CANCELED, TX_STA_DELIVERED, TX_STA_ERROR, TX_STA_EXPIRED, TX_STA_QUEUED, TX_STA_RECEIVED, TX_STA_TRANSMITTED, TX_STA_TX_END, and TX_STA_TX_START.

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const ZUnits &	value__
	)

References ALTITUDE, and DEPTH.

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const SpeedUnits &	value__
	)

References METER_PS, PERCENTAGE, and RPM.

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const PositionType &	value__
	)

References Transports::SUNSET::PositionType::altitude, Transports::SUNSET::PositionType::depth, encodeType(), Transports::SUNSET::PositionType::latitude, and Transports::SUNSET::PositionType::longitude.

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const ZReference &	value__
	)

References encodeType(), Transports::SUNSET::ZReference::z_reference, and Transports::SUNSET::ZReference::z_units.

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const SpeedReference &	value__
	)

References encodeType(), Transports::SUNSET::SpeedReference::speed_reference, and Transports::SUNSET::SpeedReference::speed_units.

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const SensorInfoTuple &	value__
	)

References encodeType(), Transports::SUNSET::SensorInfoTuple::sensor_id, Transports::SUNSET::SensorInfoTuple::sensor_model, and Transports::SUNSET::SensorInfoTuple::sensor_vendor.

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const Maneuver *	value__
	)

References Transports::SUNSET::Maneuver::encodeArgs().

template<typename Type >

size_t Transports::SUNSET::encodeType	(	std::vector< std::string > &	args__,
		const std::vector< Type > &	value__
	)

References encodeType().

void Transports::SUNSET::reset

(

ParamName &

value__

)

References NODE_ID.

Referenced by Transports::SUNSET::CommandError::CommandError(), Transports::SUNSET::CommandFailure::CommandFailure(), Transports::SUNSET::Goto::Goto(), Transports::SUNSET::PacketTxStatus::PacketTxStatus(), Transports::SUNSET::Param::Param(), Transports::SUNSET::ParamGet::ParamGet(), Transports::SUNSET::ParamSet::ParamSet(), Transports::SUNSET::Position::Position(), reset(), Transports::SUNSET::SensorSample::SensorSample(), and Transports::SUNSET::StationKeeping::StationKeeping().

void Transports::SUNSET::reset

(

ErrorType &

value__

)

References ERR_INVALID_CRC.

void Transports::SUNSET::reset

(

FailureType &

value__

)

References FAIL_INVALID_VERSION.

void Transports::SUNSET::reset

(

TxErrorType &

value__

)

References TX_ERR_SUCCESS.

void Transports::SUNSET::reset

(

TxStatusType &

value__

)

References TX_STA_RECEIVED.

void Transports::SUNSET::reset

(

ZUnits &

value__

)

References DEPTH.

void Transports::SUNSET::reset

(

SpeedUnits &

value__

)

References METER_PS.

void Transports::SUNSET::reset

(

PositionType &

value__

)

References Transports::SUNSET::PositionType::altitude, Transports::SUNSET::PositionType::depth, Transports::SUNSET::PositionType::latitude, and Transports::SUNSET::PositionType::longitude.

void Transports::SUNSET::reset

(

ZReference &

value__

)

References reset(), Transports::SUNSET::ZReference::z_reference, and Transports::SUNSET::ZReference::z_units.

void Transports::SUNSET::reset

(

SpeedReference &

value__

)

References reset(), Transports::SUNSET::SpeedReference::speed_reference, and Transports::SUNSET::SpeedReference::speed_units.

void Transports::SUNSET::reset

(

SensorInfoTuple &

value__

)

References Transports::SUNSET::SensorInfoTuple::sensor_id, Transports::SUNSET::SensorInfoTuple::sensor_model, and Transports::SUNSET::SensorInfoTuple::sensor_vendor.

void Transports::SUNSET::toText	(	std::ostream &	os__,
		const ParamName &	value__
	)

References BROADCAST_ID, NODE_ID, and TX_POWER.

void Transports::SUNSET::toText	(	std::ostream &	os__,
		const ErrorType &	value__
	)

References ERR_BUSY, ERR_INVALID_CRC, ERR_INVALID_FORMAT, ERR_INVALID_REQUEST, ERR_INVALID_VALUE, and ERR_INVALID_VERSION.

void Transports::SUNSET::toText	(	std::ostream &	os__,
		const FailureType &	value__
	)

References FAIL_BUSY, FAIL_EXPIRED, FAIL_INTERNAL_ERROR, FAIL_INVALID_REQUEST, and FAIL_INVALID_VERSION.

void Transports::SUNSET::toText	(	std::ostream &	os__,
		const TxErrorType &	value__
	)

References TX_ERR_SUCCESS, and TX_ERR_TX_RETRY_LIMIT.

void Transports::SUNSET::toText	(	std::ostream &	os__,
		const TxStatusType &	value__
	)

References TX_STA_CANCELED, TX_STA_DELIVERED, TX_STA_ERROR, TX_STA_EXPIRED, TX_STA_QUEUED, TX_STA_RECEIVED, TX_STA_TRANSMITTED, TX_STA_TX_END, and TX_STA_TX_START.

void Transports::SUNSET::toText	(	std::ostream &	os__,
		const ZUnits &	value__
	)

References ALTITUDE, and DEPTH.

void Transports::SUNSET::toText	(	std::ostream &	os__,
		const SpeedUnits &	value__
	)

References METER_PS, PERCENTAGE, and RPM.