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

Public Member Functions
virtual void	write_schema_to_dccl2 (std::ofstream *proto_file, int sequence_number)

	DCCLMessageVar ()=default

void	set_name (std::string name)

void	set_source_var (std::string source_var)

void	set_source_key (std::string source_key)

void	set_source_set (bool source_set)

void	set_algorithms (const std::vector< std::string > &algorithm)

virtual void	set_max (const std::string &)

virtual void	set_min (const std::string &)

virtual void	set_precision (const std::string &)

virtual void	set_max_length (const std::string &)

virtual void	set_num_bytes (const std::string &)

virtual void	set_static_val (const std::string &)

virtual void	add_enum (std::string)

virtual void	set_max_delta (const std::string &)

void	set_array_length (unsigned u)

void	set_array_length (const std::string &s)

virtual double	max () const

virtual double	min () const

virtual int	precision () const

virtual unsigned	max_length () const

virtual unsigned	num_bytes () const

virtual std::string	static_val () const

virtual std::vector< std::string > *	enums ()

unsigned	array_length () const

virtual DCCLType	type () const =0

std::string	name () const

std::string	source_var () const

int	sequence_number () const

const std::vector< std::string > &	algorithms () const

void	initialize (const DCCLMessage &msg)

void	set_defaults (std::map< std::string, std::vector< DCCLMessageVal > > &vals, unsigned modem_id, unsigned id)

Protected Member Functions
virtual void	initialize_specific ()=0

virtual std::string	additional_option_extensions ()

virtual void	set_defaults_specific (DCCLMessageVal &, unsigned, unsigned)

Protected Attributes
unsigned	array_length_

DCCLMessageVal	key_val_

bool	is_key_frame_

std::string	source_var_

std::string	name_

int	sequence_number_

Detailed Description

Definition at line 55 of file message_var.h.

Constructor & Destructor Documentation

◆ DCCLMessageVar()

goby::moos::transitional::DCCLMessageVar::DCCLMessageVar ( )

default

Member Function Documentation

◆ add_enum()

virtual void goby::moos::transitional::DCCLMessageVar::add_enum ( std::string )

inlinevirtual

Definition at line 84 of file message_var.h.

◆ additional_option_extensions()

virtual std::string goby::moos::transitional::DCCLMessageVar::additional_option_extensions ( )

inlineprotectedvirtual

Definition at line 153 of file message_var.h.

◆ algorithms()

const std::vector<std::string>& goby::moos::transitional::DCCLMessageVar::algorithms ( ) const

inline

Definition at line 138 of file message_var.h.

◆ array_length()

unsigned goby::moos::transitional::DCCLMessageVar::array_length ( ) const

inline

Definition at line 129 of file message_var.h.

◆ enums()

virtual std::vector<std::string>* goby::moos::transitional::DCCLMessageVar::enums ( )

inlinevirtual

Definition at line 123 of file message_var.h.

◆ initialize()

void goby::moos::transitional::DCCLMessageVar::initialize ( const DCCLMessage & msg )

inline

Definition at line 141 of file message_var.h.

◆ initialize_specific()

virtual void goby::moos::transitional::DCCLMessageVar::initialize_specific ( )

protectedpure virtual

◆ max()

virtual double goby::moos::transitional::DCCLMessageVar::max ( ) const

inlinevirtual

Definition at line 93 of file message_var.h.

◆ max_length()

virtual unsigned goby::moos::transitional::DCCLMessageVar::max_length ( ) const

inlinevirtual

Definition at line 108 of file message_var.h.

◆ min()

virtual double goby::moos::transitional::DCCLMessageVar::min ( ) const

inlinevirtual

Definition at line 98 of file message_var.h.

◆ name()

std::string goby::moos::transitional::DCCLMessageVar::name ( ) const

inline

Definition at line 134 of file message_var.h.

◆ num_bytes()

virtual unsigned goby::moos::transitional::DCCLMessageVar::num_bytes ( ) const

inlinevirtual

Definition at line 113 of file message_var.h.

◆ precision()

virtual int goby::moos::transitional::DCCLMessageVar::precision ( ) const

inlinevirtual

Definition at line 103 of file message_var.h.

◆ sequence_number()

int goby::moos::transitional::DCCLMessageVar::sequence_number ( ) const

inline

Definition at line 137 of file message_var.h.

◆ set_algorithms()

void goby::moos::transitional::DCCLMessageVar::set_algorithms ( const std::vector< std::string > & algorithm )

inline

Definition at line 72 of file message_var.h.

◆ set_array_length() [1/2]

void goby::moos::transitional::DCCLMessageVar::set_array_length ( const std::string & s )

inline

Definition at line 88 of file message_var.h.

◆ set_array_length() [2/2]

void goby::moos::transitional::DCCLMessageVar::set_array_length ( unsigned u )

inline

Definition at line 87 of file message_var.h.

◆ set_defaults()

void goby::moos::transitional::DCCLMessageVar::set_defaults	(	std::map< std::string, std::vector< DCCLMessageVal > > &	vals,
		unsigned	modem_id,
		unsigned	id
	)

inline

Definition at line 145 of file message_var.h.

◆ set_defaults_specific()

virtual void goby::moos::transitional::DCCLMessageVar::set_defaults_specific	(	DCCLMessageVal &	,
		unsigned	,
		unsigned
	)

inlineprotectedvirtual

Definition at line 155 of file message_var.h.

◆ set_max()

virtual void goby::moos::transitional::DCCLMessageVar::set_max ( const std::string & )

inlinevirtual

Definition at line 75 of file message_var.h.

◆ set_max_delta()

virtual void goby::moos::transitional::DCCLMessageVar::set_max_delta ( const std::string & )

inlinevirtual

Definition at line 85 of file message_var.h.

◆ set_max_length()

virtual void goby::moos::transitional::DCCLMessageVar::set_max_length ( const std::string & )

inlinevirtual

Definition at line 78 of file message_var.h.

◆ set_min()

virtual void goby::moos::transitional::DCCLMessageVar::set_min ( const std::string & )

inlinevirtual

Definition at line 76 of file message_var.h.

◆ set_name()

void goby::moos::transitional::DCCLMessageVar::set_name ( std::string name )

inline

Definition at line 64 of file message_var.h.

◆ set_num_bytes()

virtual void goby::moos::transitional::DCCLMessageVar::set_num_bytes ( const std::string & )

inlinevirtual

Definition at line 79 of file message_var.h.

◆ set_precision()

virtual void goby::moos::transitional::DCCLMessageVar::set_precision ( const std::string & )

inlinevirtual

Definition at line 77 of file message_var.h.

◆ set_source_key()

void goby::moos::transitional::DCCLMessageVar::set_source_key ( std::string source_key )

inline

Definition at line 70 of file message_var.h.

◆ set_source_set()

void goby::moos::transitional::DCCLMessageVar::set_source_set ( bool source_set )

inline

Definition at line 71 of file message_var.h.

◆ set_source_var()

void goby::moos::transitional::DCCLMessageVar::set_source_var ( std::string source_var )

inline

Definition at line 65 of file message_var.h.

◆ set_static_val()

virtual void goby::moos::transitional::DCCLMessageVar::set_static_val ( const std::string & )

inlinevirtual

Definition at line 80 of file message_var.h.

◆ source_var()

std::string goby::moos::transitional::DCCLMessageVar::source_var ( ) const

inline

Definition at line 135 of file message_var.h.

◆ static_val()

virtual std::string goby::moos::transitional::DCCLMessageVar::static_val ( ) const

inlinevirtual

Definition at line 118 of file message_var.h.

◆ type()

virtual DCCLType goby::moos::transitional::DCCLMessageVar::type ( ) const

pure virtual

◆ write_schema_to_dccl2()

virtual void goby::moos::transitional::DCCLMessageVar::write_schema_to_dccl2	(	std::ofstream *	proto_file,
		int	sequence_number
	)

inlinevirtual

Definition at line 59 of file message_var.h.

Member Data Documentation

◆ array_length_

unsigned goby::moos::transitional::DCCLMessageVar::array_length_

protected

Definition at line 170 of file message_var.h.

◆ is_key_frame_

bool goby::moos::transitional::DCCLMessageVar::is_key_frame_

protected

Definition at line 172 of file message_var.h.

◆ key_val_

DCCLMessageVal goby::moos::transitional::DCCLMessageVar::key_val_

protected

Definition at line 171 of file message_var.h.

◆ name_

std::string goby::moos::transitional::DCCLMessageVar::name_

protected

Definition at line 174 of file message_var.h.

◆ sequence_number_

int goby::moos::transitional::DCCLMessageVar::sequence_number_

protected

Definition at line 175 of file message_var.h.

◆ source_var_

std::string goby::moos::transitional::DCCLMessageVar::source_var_

protected

Definition at line 173 of file message_var.h.

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

goby/moos/transitional/message_var.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DCCLMessageVar()

Member Function Documentation

◆ add_enum()

◆ additional_option_extensions()

◆ algorithms()

◆ array_length()

◆ enums()

◆ initialize()

◆ initialize_specific()

◆ max()

◆ max_length()

◆ min()

◆ name()

◆ num_bytes()

◆ precision()

◆ sequence_number()

◆ set_algorithms()

◆ set_array_length() [1/2]

◆ set_array_length() [2/2]

◆ set_defaults()

◆ set_defaults_specific()

◆ set_max()

◆ set_max_delta()

◆ set_max_length()

◆ set_min()

◆ set_name()

◆ set_num_bytes()

◆ set_precision()

◆ set_source_key()

◆ set_source_set()

◆ set_source_var()

◆ set_static_val()

◆ source_var()

◆ static_val()

◆ type()

◆ write_schema_to_dccl2()

Member Data Documentation

◆ array_length_

◆ is_key_frame_

◆ key_val_

◆ name_

◆ sequence_number_

◆ source_var_