provides an API to the Transitional Dynamic CCL Codec (looks like DCCLv1, but calls DCCLv2). Warning: this class is for legacy support only, new applications should use DCCLCodec directly. More...

#include <goby/acomms/dccl.h>

Public Member Functions
template<typename Key >
const google::protobuf::Descriptor *	descriptor (const Key &k)

unsigned	message_count ()

template<typename Key >
unsigned	get_repeat (const Key &k)

std::set< unsigned >	all_message_ids ()

std::set< std::string >	all_message_names ()

template<typename Key >
std::map< std::string, std::string >	message_var_names (const Key &k) const

std::string	id2name (unsigned id)

unsigned	name2id (const std::string &name)

std::vector< DCCLMessage > &	messages ()

Constructors/Destructor
	DCCLTransitionalCodec ()
	Instantiate optionally with a ostream logger (for human readable output) More...

	~DCCLTransitionalCodec ()
	destructor

Initialization Methods.
These methods are intended to be called before doing any work with the class. However, they may be called at any time as desired.
void	convert_to_v2_representation (pAcommsHandlerConfig *cfg)

Detailed Description

provides an API to the Transitional Dynamic CCL Codec (looks like DCCLv1, but calls DCCLv2). Warning: this class is for legacy support only, new applications should use DCCLCodec directly.

See also: transitional.proto and acomms_modem_message.proto for definition of Google Protocol Buffers messages (namespace goby::transitional::protobuf).

Definition at line 100 of file dccl_transitional.h.

Constructor & Destructor Documentation

goby::transitional::DCCLTransitionalCodec::DCCLTransitionalCodec ( )

Instantiate optionally with a ostream logger (for human readable output)

Parameters

log	std::ostream object or FlexOstream to capture all humanly readable runtime and debug information (optional).

Definition at line 43 of file dccl_transitional.cpp.

Member Function Documentation

std::set<unsigned> goby::transitional::DCCLTransitionalCodec::all_message_ids ( )

Returns: set of all message ids loaded

std::set<std::string> goby::transitional::DCCLTransitionalCodec::all_message_names ( )

Returns: set of all message names loaded

template<typename Key >

unsigned goby::transitional::DCCLTransitionalCodec::get_repeat ( const Key & k )

inline

Returns: repeat value (number of copies of the message per encode)

Definition at line 133 of file dccl_transitional.h.

std::string goby::transitional::DCCLTransitionalCodec::id2name ( unsigned id )

inline

Parameters

id	message id

Returns: name of message

Definition at line 147 of file dccl_transitional.h.

unsigned goby::transitional::DCCLTransitionalCodec::message_count ( )

inline

how many message are loaded?

Returns: number of messages loaded

Definition at line 130 of file dccl_transitional.h.

template<typename Key >

std::map<std::string, std::string> goby::transitional::DCCLTransitionalCodec::message_var_names ( const Key & k ) const

inline

Returns: map of names to DCCL types needed to encode a given message

Definition at line 140 of file dccl_transitional.h.

unsigned goby::transitional::DCCLTransitionalCodec::name2id ( const std::string & name )

inline

Parameters

name	message name

Returns: id of message

Definition at line 150 of file dccl_transitional.h.

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

goby/moos/transitional/dccl_transitional.h
src/moos/transitional/dccl_transitional.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation