Goby3  3.1.5a
2024.05.23
Public Member Functions | List of all members
goby::moos::transitional::DCCLMessage Class Reference

#include <goby/moos/transitional/message.h>

Public Member Functions

void write_schema_to_dccl2 (std::ofstream *proto_file)
 
 DCCLMessage ()
 
void set_name (const std::string &name)
 
void set_id (unsigned id)
 
template<typename T >
void set_id (const T &t)
 
void set_trigger (const std::string &trigger_type)
 
void set_trigger_var (const std::string &trigger_var)
 
void set_trigger_time (double trigger_time)
 
template<typename T >
void set_trigger_time (const T &t)
 
void set_trigger_mandatory (const std::string &trigger_mandatory)
 
void set_in_var (const std::string &in_var)
 
void set_out_var (const std::string &out_var)
 
void set_size (unsigned size)
 
template<typename T >
void set_size (const T &t)
 
void set_repeat_enabled (unsigned repeat_enabled)
 
template<typename T >
void set_repeat_enabled (const T &t)
 
void add_message_var (const std::string &type)
 
void add_publish ()
 
void set_descriptor (const google::protobuf::Descriptor *descriptor)
 
std::string name () const
 
unsigned id () const
 
unsigned size () const
 
std::string trigger_var () const
 
std::string trigger_mandatory () const
 
double trigger_time () const
 
unsigned trigger_number () const
 
std::string trigger_type () const
 
std::string in_var () const
 
std::string out_var () const
 
bool repeat_enabled () const
 
unsigned repeat () const
 
DCCLMessageVar & last_message_var ()
 
DCCLMessageVar & header_var (moos::transitional::DCCLHeaderPart p)
 
DCCLPublish & last_publish ()
 
std::vector< std::shared_ptr< DCCLMessageVar > > & layout ()
 
std::vector< std::shared_ptr< DCCLMessageVar > > & header ()
 
const std::vector< std::shared_ptr< DCCLMessageVar > > & layout_const () const
 
const std::vector< std::shared_ptr< DCCLMessageVar > > & header_const () const
 
std::vector< DCCLPublish > & publishes ()
 
const std::vector< DCCLPublish > & publishes_const () const
 
std::shared_ptr< DCCLMessageVar > name2message_var (const std::string &name) const
 
const google::protobuf::Descriptor * descriptor ()
 
std::map< std::string, std::string > message_var_names () const
 
void preprocess ()
 
void set_repeat_array_length ()
 
unsigned calc_total_size ()
 
void set_head_defaults (std::map< std::string, std::vector< DCCLMessageVal > > &in, unsigned modem_id)
 
DCCLMessage & operator++ ()
 
const DCCLMessage operator++ (int)
 

Detailed Description

Definition at line 61 of file message.h.

Constructor & Destructor Documentation

◆ DCCLMessage()

goby::moos::transitional::DCCLMessage::DCCLMessage ( )

Member Function Documentation

◆ add_message_var()

void goby::moos::transitional::DCCLMessage::add_message_var ( const std::string &  type)

◆ add_publish()

void goby::moos::transitional::DCCLMessage::add_publish ( )

◆ calc_total_size()

unsigned goby::moos::transitional::DCCLMessage::calc_total_size ( )

◆ descriptor()

const google::protobuf::Descriptor* goby::moos::transitional::DCCLMessage::descriptor ( )
inline

Definition at line 141 of file message.h.

◆ header()

std::vector<std::shared_ptr<DCCLMessageVar> >& goby::moos::transitional::DCCLMessage::header ( )
inline

Definition at line 131 of file message.h.

◆ header_const()

const std::vector<std::shared_ptr<DCCLMessageVar> >& goby::moos::transitional::DCCLMessage::header_const ( ) const
inline

Definition at line 134 of file message.h.

◆ header_var()

DCCLMessageVar& goby::moos::transitional::DCCLMessage::header_var ( moos::transitional::DCCLHeaderPart  p)
inline

Definition at line 127 of file message.h.

◆ id()

unsigned goby::moos::transitional::DCCLMessage::id ( ) const
inline

Definition at line 114 of file message.h.

◆ in_var()

std::string goby::moos::transitional::DCCLMessage::in_var ( ) const
inline

Definition at line 121 of file message.h.

◆ last_message_var()

DCCLMessageVar& goby::moos::transitional::DCCLMessage::last_message_var ( )
inline

Definition at line 126 of file message.h.

◆ last_publish()

DCCLPublish& goby::moos::transitional::DCCLMessage::last_publish ( )
inline

Definition at line 128 of file message.h.

◆ layout()

std::vector<std::shared_ptr<DCCLMessageVar> >& goby::moos::transitional::DCCLMessage::layout ( )
inline

Definition at line 130 of file message.h.

◆ layout_const()

const std::vector<std::shared_ptr<DCCLMessageVar> >& goby::moos::transitional::DCCLMessage::layout_const ( ) const
inline

Definition at line 133 of file message.h.

◆ message_var_names()

std::map<std::string, std::string> goby::moos::transitional::DCCLMessage::message_var_names ( ) const

◆ name()

std::string goby::moos::transitional::DCCLMessage::name ( ) const
inline

Definition at line 113 of file message.h.

◆ name2message_var()

std::shared_ptr<DCCLMessageVar> goby::moos::transitional::DCCLMessage::name2message_var ( const std::string &  name) const

◆ operator++() [1/2]

DCCLMessage& goby::moos::transitional::DCCLMessage::operator++ ( )
inline

Definition at line 156 of file message.h.

◆ operator++() [2/2]

const DCCLMessage goby::moos::transitional::DCCLMessage::operator++ ( int  )
inline

Definition at line 162 of file message.h.

◆ out_var()

std::string goby::moos::transitional::DCCLMessage::out_var ( ) const
inline

Definition at line 122 of file message.h.

◆ preprocess()

void goby::moos::transitional::DCCLMessage::preprocess ( )

◆ publishes()

std::vector<DCCLPublish>& goby::moos::transitional::DCCLMessage::publishes ( )
inline

Definition at line 136 of file message.h.

◆ publishes_const()

const std::vector<DCCLPublish>& goby::moos::transitional::DCCLMessage::publishes_const ( ) const
inline

Definition at line 137 of file message.h.

◆ repeat()

unsigned goby::moos::transitional::DCCLMessage::repeat ( ) const
inline

Definition at line 124 of file message.h.

◆ repeat_enabled()

bool goby::moos::transitional::DCCLMessage::repeat_enabled ( ) const
inline

Definition at line 123 of file message.h.

◆ set_descriptor()

void goby::moos::transitional::DCCLMessage::set_descriptor ( const google::protobuf::Descriptor *  descriptor)
inline

Definition at line 107 of file message.h.

◆ set_head_defaults()

void goby::moos::transitional::DCCLMessage::set_head_defaults ( std::map< std::string, std::vector< DCCLMessageVal > > &  in,
unsigned  modem_id 
)

◆ set_id() [1/2]

template<typename T >
void goby::moos::transitional::DCCLMessage::set_id ( const T &  t)
inline

Definition at line 73 of file message.h.

◆ set_id() [2/2]

void goby::moos::transitional::DCCLMessage::set_id ( unsigned  id)
inline

Definition at line 72 of file message.h.

◆ set_in_var()

void goby::moos::transitional::DCCLMessage::set_in_var ( const std::string &  in_var)
inline

Definition at line 90 of file message.h.

◆ set_name()

void goby::moos::transitional::DCCLMessage::set_name ( const std::string &  name)
inline

Definition at line 70 of file message.h.

◆ set_out_var()

void goby::moos::transitional::DCCLMessage::set_out_var ( const std::string &  out_var)
inline

Definition at line 92 of file message.h.

◆ set_repeat_array_length()

void goby::moos::transitional::DCCLMessage::set_repeat_array_length ( )

◆ set_repeat_enabled() [1/2]

template<typename T >
void goby::moos::transitional::DCCLMessage::set_repeat_enabled ( const T &  t)
inline

Definition at line 99 of file message.h.

◆ set_repeat_enabled() [2/2]

void goby::moos::transitional::DCCLMessage::set_repeat_enabled ( unsigned  repeat_enabled)
inline

Definition at line 98 of file message.h.

◆ set_size() [1/2]

template<typename T >
void goby::moos::transitional::DCCLMessage::set_size ( const T &  t)
inline

Definition at line 96 of file message.h.

◆ set_size() [2/2]

void goby::moos::transitional::DCCLMessage::set_size ( unsigned  size)
inline

Definition at line 94 of file message.h.

◆ set_trigger()

void goby::moos::transitional::DCCLMessage::set_trigger ( const std::string &  trigger_type)
inline

Definition at line 75 of file message.h.

◆ set_trigger_mandatory()

void goby::moos::transitional::DCCLMessage::set_trigger_mandatory ( const std::string &  trigger_mandatory)
inline

Definition at line 85 of file message.h.

◆ set_trigger_time() [1/2]

template<typename T >
void goby::moos::transitional::DCCLMessage::set_trigger_time ( const T &  t)
inline

Definition at line 80 of file message.h.

◆ set_trigger_time() [2/2]

void goby::moos::transitional::DCCLMessage::set_trigger_time ( double  trigger_time)
inline

Definition at line 79 of file message.h.

◆ set_trigger_var()

void goby::moos::transitional::DCCLMessage::set_trigger_var ( const std::string &  trigger_var)
inline

Definition at line 77 of file message.h.

◆ size()

unsigned goby::moos::transitional::DCCLMessage::size ( ) const
inline

Definition at line 115 of file message.h.

◆ trigger_mandatory()

std::string goby::moos::transitional::DCCLMessage::trigger_mandatory ( ) const
inline

Definition at line 117 of file message.h.

◆ trigger_number()

unsigned goby::moos::transitional::DCCLMessage::trigger_number ( ) const
inline

Definition at line 119 of file message.h.

◆ trigger_time()

double goby::moos::transitional::DCCLMessage::trigger_time ( ) const
inline

Definition at line 118 of file message.h.

◆ trigger_type()

std::string goby::moos::transitional::DCCLMessage::trigger_type ( ) const
inline

Definition at line 120 of file message.h.

◆ trigger_var()

std::string goby::moos::transitional::DCCLMessage::trigger_var ( ) const
inline

Definition at line 116 of file message.h.

◆ write_schema_to_dccl2()

void goby::moos::transitional::DCCLMessage::write_schema_to_dccl2 ( std::ofstream *  proto_file)
The documentation for this class was generated from the following file: