JaiaBot  1.19.0
JaiaBot micro-AUV software
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
jaiabot::protobuf::DesiredSetpoints Class Reference

#include <jaiabot/messages/high_control.pb.h>

Inheritance diagram for jaiabot::protobuf::DesiredSetpoints:
Inheritance graph
[legend]
Collaboration diagram for jaiabot::protobuf::DesiredSetpoints:
Collaboration graph
[legend]

Public Types

enum  SetpointDataCase {
  kHelmCourse = 10, kRemoteControl = 11, kDiveDepth = 12, kThrottle = 13,
  SETPOINT_DATA_NOT_SET = 0
}
 
typedef boost::units::length_dimension dive_depth_dimension
 
typedef boost::units::unit< dive_depth_dimension, boost::units::si::system > dive_depth_unit
 

Public Member Functions

 DesiredSetpoints ()
 
virtual ~DesiredSetpoints ()
 
 DesiredSetpoints (const DesiredSetpoints &from)
 
DesiredSetpoints & operator= (const DesiredSetpoints &from)
 
const ::google::protobuf::UnknownFieldSet & unknown_fields () const
 
inline ::google::protobuf::UnknownFieldSet * mutable_unknown_fields ()
 
void Swap (DesiredSetpoints *other)
 
DesiredSetpoints * New () const final
 
DesiredSetpoints * New (::google::protobuf::Arena *arena) const final
 
void CopyFrom (const ::google::protobuf::Message &from) final
 
void MergeFrom (const ::google::protobuf::Message &from) final
 
void CopyFrom (const DesiredSetpoints &from)
 
void MergeFrom (const DesiredSetpoints &from)
 
void Clear () final
 
bool IsInitialized () const final
 
size_t ByteSizeLong () const final
 
bool MergePartialFromCodedStream (::google::protobuf::io::CodedInputStream *input) final
 
void SerializeWithCachedSizes (::google::protobuf::io::CodedOutputStream *output) const final
 
::google::protobuf::uint8 * InternalSerializeWithCachedSizesToArray (bool deterministic, ::google::protobuf::uint8 *target) const final
 
int GetCachedSize () const final
 
::google::protobuf::Metadata GetMetadata () const final
 
bool has_type () const
 
void clear_type ()
 
::jaiabot::protobuf::SetpointType type () const
 
void set_type (::jaiabot::protobuf::SetpointType value)
 
bool has_is_helm_constant_course () const
 
void clear_is_helm_constant_course ()
 
bool is_helm_constant_course () const
 
void set_is_helm_constant_course (bool value)
 
bool has_helm_course () const
 
void clear_helm_course ()
 
const ::goby::middleware::frontseat::protobuf::DesiredCourse & helm_course () const
 
::goby::middleware::frontseat::protobuf::DesiredCourse * release_helm_course ()
 
::goby::middleware::frontseat::protobuf::DesiredCourse * mutable_helm_course ()
 
void set_allocated_helm_course (::goby::middleware::frontseat::protobuf::DesiredCourse *helm_course)
 
bool has_remote_control () const
 
void clear_remote_control ()
 
const ::jaiabot::protobuf::RemoteControl & remote_control () const
 
::jaiabot::protobuf::RemoteControl * release_remote_control ()
 
::jaiabot::protobuf::RemoteControl * mutable_remote_control ()
 
void set_allocated_remote_control (::jaiabot::protobuf::RemoteControl *remote_control)
 
bool has_dive_depth () const
 
void clear_dive_depth ()
 
double dive_depth () const
 
void set_dive_depth (double value)
 
bool has_throttle () const
 
void clear_throttle ()
 
double throttle () const
 
void set_throttle (double value)
 
void clear_setpoint_data ()
 
SetpointDataCase setpoint_data_case () const
 
template<typename Quantity >
void set_dive_depth_with_units (Quantity value_w_units)
 
template<typename Quantity >
Quantity dive_depth_with_units () const
 
boost::units::quantity< dive_depth_unit, double > dive_depth_with_units () const
 

Static Public Member Functions

static const ::google::protobuf::Descriptor * descriptor ()
 
static const DesiredSetpoints & default_instance ()
 
static void InitAsDefaultInstance ()
 
static const DesiredSetpoints * internal_default_instance ()
 

Static Public Attributes

static constexpr int kIndexInFileMessages
 
static const int kTypeFieldNumber = 1
 
static const int kIsHelmConstantCourseFieldNumber = 2
 
static const int kHelmCourseFieldNumber = 10
 
static const int kRemoteControlFieldNumber = 11
 
static const int kDiveDepthFieldNumber = 12
 
static const int kThrottleFieldNumber = 13
 

Friends

struct ::protobuf_jaiabot_2fmessages_2fhigh_5fcontrol_2eproto::TableStruct
 
void swap (DesiredSetpoints &a, DesiredSetpoints &b)
 

Detailed Description

Definition at line 283 of file high_control.pb.h.

Member Typedef Documentation

◆ dive_depth_dimension

typedef boost::units::length_dimension jaiabot::protobuf::DesiredSetpoints::dive_depth_dimension

Definition at line 439 of file high_control.pb.h.

◆ dive_depth_unit

typedef boost::units::unit<dive_depth_dimension,boost::units::si::system> jaiabot::protobuf::DesiredSetpoints::dive_depth_unit

Definition at line 441 of file high_control.pb.h.

Member Enumeration Documentation

◆ SetpointDataCase

enum jaiabot::protobuf::DesiredSetpoints::SetpointDataCase
Enumerator
kHelmCourse 
kRemoteControl 
kDiveDepth 
kThrottle 
SETPOINT_DATA_NOT_SET 

Definition at line 319 of file high_control.pb.h.

Constructor & Destructor Documentation

◆ DesiredSetpoints() [1/2]

jaiabot::protobuf::DesiredSetpoints::DesiredSetpoints ( )

◆ ~DesiredSetpoints()

virtual jaiabot::protobuf::DesiredSetpoints::~DesiredSetpoints ( )
virtual

◆ DesiredSetpoints() [2/2]

jaiabot::protobuf::DesiredSetpoints::DesiredSetpoints ( const DesiredSetpoints &  from)

Member Function Documentation

◆ ByteSizeLong()

size_t jaiabot::protobuf::DesiredSetpoints::ByteSizeLong ( ) const
final

◆ Clear()

void jaiabot::protobuf::DesiredSetpoints::Clear ( )
final

◆ clear_dive_depth()

void jaiabot::protobuf::DesiredSetpoints::clear_dive_depth ( )
inline

Definition at line 685 of file high_control.pb.h.

◆ clear_helm_course()

void jaiabot::protobuf::DesiredSetpoints::clear_helm_course ( )

◆ clear_is_helm_constant_course()

void jaiabot::protobuf::DesiredSetpoints::clear_is_helm_constant_course ( )
inline

Definition at line 746 of file high_control.pb.h.

◆ clear_remote_control()

void jaiabot::protobuf::DesiredSetpoints::clear_remote_control ( )
inline

Definition at line 641 of file high_control.pb.h.

◆ clear_setpoint_data()

void jaiabot::protobuf::DesiredSetpoints::clear_setpoint_data ( )

◆ clear_throttle()

void jaiabot::protobuf::DesiredSetpoints::clear_throttle ( )
inline

Definition at line 714 of file high_control.pb.h.

◆ clear_type()

void jaiabot::protobuf::DesiredSetpoints::clear_type ( )
inline

Definition at line 581 of file high_control.pb.h.

◆ CopyFrom() [1/2]

void jaiabot::protobuf::DesiredSetpoints::CopyFrom ( const ::google::protobuf::Message &  from)
final

◆ CopyFrom() [2/2]

void jaiabot::protobuf::DesiredSetpoints::CopyFrom ( const DesiredSetpoints &  from)

◆ default_instance()

static const DesiredSetpoints& jaiabot::protobuf::DesiredSetpoints::default_instance ( )
static

◆ descriptor()

static const ::google::protobuf::Descriptor* jaiabot::protobuf::DesiredSetpoints::descriptor ( )
static

◆ dive_depth()

double jaiabot::protobuf::DesiredSetpoints::dive_depth ( ) const
inline

Definition at line 691 of file high_control.pb.h.

◆ dive_depth_with_units() [1/2]

template<typename Quantity >
Quantity jaiabot::protobuf::DesiredSetpoints::dive_depth_with_units ( ) const
inline

Definition at line 448 of file high_control.pb.h.

◆ dive_depth_with_units() [2/2]

boost::units::quantity< dive_depth_unit,double > jaiabot::protobuf::DesiredSetpoints::dive_depth_with_units ( ) const
inline

Definition at line 451 of file high_control.pb.h.

◆ GetCachedSize()

int jaiabot::protobuf::DesiredSetpoints::GetCachedSize ( ) const
inlinefinal

Definition at line 363 of file high_control.pb.h.

◆ GetMetadata()

::google::protobuf::Metadata jaiabot::protobuf::DesiredSetpoints::GetMetadata ( ) const
final

◆ has_dive_depth()

bool jaiabot::protobuf::DesiredSetpoints::has_dive_depth ( ) const
inline

Definition at line 679 of file high_control.pb.h.

◆ has_helm_course()

bool jaiabot::protobuf::DesiredSetpoints::has_helm_course ( ) const
inline

Definition at line 597 of file high_control.pb.h.

◆ has_is_helm_constant_course()

bool jaiabot::protobuf::DesiredSetpoints::has_is_helm_constant_course ( ) const
inline

Definition at line 737 of file high_control.pb.h.

◆ has_remote_control()

bool jaiabot::protobuf::DesiredSetpoints::has_remote_control ( ) const
inline

Definition at line 635 of file high_control.pb.h.

◆ has_throttle()

bool jaiabot::protobuf::DesiredSetpoints::has_throttle ( ) const
inline

Definition at line 708 of file high_control.pb.h.

◆ has_type()

bool jaiabot::protobuf::DesiredSetpoints::has_type ( ) const
inline

Definition at line 572 of file high_control.pb.h.

◆ helm_course()

const ::goby::middleware::frontseat::protobuf::DesiredCourse & jaiabot::protobuf::DesiredSetpoints::helm_course ( ) const
inline

Definition at line 617 of file high_control.pb.h.

◆ InitAsDefaultInstance()

static void jaiabot::protobuf::DesiredSetpoints::InitAsDefaultInstance ( )
static

◆ internal_default_instance()

static const DesiredSetpoints* jaiabot::protobuf::DesiredSetpoints::internal_default_instance ( )
inlinestatic

Definition at line 328 of file high_control.pb.h.

◆ InternalSerializeWithCachedSizesToArray()

::google::protobuf::uint8* jaiabot::protobuf::DesiredSetpoints::InternalSerializeWithCachedSizesToArray ( bool  deterministic,
::google::protobuf::uint8 *  target 
) const
final

◆ is_helm_constant_course()

bool jaiabot::protobuf::DesiredSetpoints::is_helm_constant_course ( ) const
inline

Definition at line 750 of file high_control.pb.h.

◆ IsInitialized()

bool jaiabot::protobuf::DesiredSetpoints::IsInitialized ( ) const
final

◆ MergeFrom() [1/2]

void jaiabot::protobuf::DesiredSetpoints::MergeFrom ( const ::google::protobuf::Message &  from)
final

◆ MergeFrom() [2/2]

void jaiabot::protobuf::DesiredSetpoints::MergeFrom ( const DesiredSetpoints &  from)

◆ MergePartialFromCodedStream()

bool jaiabot::protobuf::DesiredSetpoints::MergePartialFromCodedStream ( ::google::protobuf::io::CodedInputStream *  input)
final

◆ mutable_helm_course()

goby::middleware::frontseat::protobuf::DesiredCourse * jaiabot::protobuf::DesiredSetpoints::mutable_helm_course ( )
inline

Definition at line 623 of file high_control.pb.h.

◆ mutable_remote_control()

jaiabot::protobuf::RemoteControl * jaiabot::protobuf::DesiredSetpoints::mutable_remote_control ( )
inline

Definition at line 667 of file high_control.pb.h.

◆ mutable_unknown_fields()

inline ::google::protobuf::UnknownFieldSet* jaiabot::protobuf::DesiredSetpoints::mutable_unknown_fields ( )
inline

Definition at line 312 of file high_control.pb.h.

◆ New() [1/2]

DesiredSetpoints* jaiabot::protobuf::DesiredSetpoints::New ( ) const
inlinefinal

Definition at line 342 of file high_control.pb.h.

◆ New() [2/2]

DesiredSetpoints* jaiabot::protobuf::DesiredSetpoints::New ( ::google::protobuf::Arena *  arena) const
inlinefinal

Definition at line 346 of file high_control.pb.h.

◆ operator=()

DesiredSetpoints& jaiabot::protobuf::DesiredSetpoints::operator= ( const DesiredSetpoints &  from)
inline

Definition at line 290 of file high_control.pb.h.

◆ release_helm_course()

goby::middleware::frontseat::protobuf::DesiredCourse * jaiabot::protobuf::DesiredSetpoints::release_helm_course ( )
inline

Definition at line 606 of file high_control.pb.h.

◆ release_remote_control()

jaiabot::protobuf::RemoteControl * jaiabot::protobuf::DesiredSetpoints::release_remote_control ( )
inline

Definition at line 650 of file high_control.pb.h.

◆ remote_control()

const ::jaiabot::protobuf::RemoteControl & jaiabot::protobuf::DesiredSetpoints::remote_control ( ) const
inline

Definition at line 661 of file high_control.pb.h.

◆ SerializeWithCachedSizes()

void jaiabot::protobuf::DesiredSetpoints::SerializeWithCachedSizes ( ::google::protobuf::io::CodedOutputStream *  output) const
final

◆ set_allocated_helm_course()

void jaiabot::protobuf::DesiredSetpoints::set_allocated_helm_course ( ::goby::middleware::frontseat::protobuf::DesiredCourse *  helm_course)

◆ set_allocated_remote_control()

void jaiabot::protobuf::DesiredSetpoints::set_allocated_remote_control ( ::jaiabot::protobuf::RemoteControl *  remote_control)

◆ set_dive_depth()

void jaiabot::protobuf::DesiredSetpoints::set_dive_depth ( double  value)
inline

Definition at line 698 of file high_control.pb.h.

◆ set_dive_depth_with_units()

template<typename Quantity >
void jaiabot::protobuf::DesiredSetpoints::set_dive_depth_with_units ( Quantity  value_w_units)
inline

Definition at line 444 of file high_control.pb.h.

◆ set_is_helm_constant_course()

void jaiabot::protobuf::DesiredSetpoints::set_is_helm_constant_course ( bool  value)
inline

Definition at line 754 of file high_control.pb.h.

◆ set_throttle()

void jaiabot::protobuf::DesiredSetpoints::set_throttle ( double  value)
inline

Definition at line 727 of file high_control.pb.h.

◆ set_type()

void jaiabot::protobuf::DesiredSetpoints::set_type ( ::jaiabot::protobuf::SetpointType  value)
inline

Definition at line 589 of file high_control.pb.h.

◆ setpoint_data_case()

DesiredSetpoints::SetpointDataCase jaiabot::protobuf::DesiredSetpoints::setpoint_data_case ( ) const
inline

Definition at line 766 of file high_control.pb.h.

◆ Swap()

void jaiabot::protobuf::DesiredSetpoints::Swap ( DesiredSetpoints *  other)

◆ throttle()

double jaiabot::protobuf::DesiredSetpoints::throttle ( ) const
inline

Definition at line 720 of file high_control.pb.h.

◆ type()

jaiabot::protobuf::SetpointType jaiabot::protobuf::DesiredSetpoints::type ( ) const
inline

Definition at line 585 of file high_control.pb.h.

◆ unknown_fields()

const ::google::protobuf::UnknownFieldSet& jaiabot::protobuf::DesiredSetpoints::unknown_fields ( ) const
inline

Definition at line 309 of file high_control.pb.h.

Friends And Related Function Documentation

◆ ::protobuf_jaiabot_2fmessages_2fhigh_5fcontrol_2eproto::TableStruct

friend struct ::protobuf_jaiabot_2fmessages_2fhigh_5fcontrol_2eproto::TableStruct
friend

Definition at line 482 of file high_control.pb.h.

◆ swap

void swap ( DesiredSetpoints &  a,
DesiredSetpoints &  b 
)
friend

Definition at line 336 of file high_control.pb.h.

Member Data Documentation

◆ kDiveDepthFieldNumber

const int jaiabot::protobuf::DesiredSetpoints::kDiveDepthFieldNumber = 12
static

Definition at line 426 of file high_control.pb.h.

◆ kHelmCourseFieldNumber

const int jaiabot::protobuf::DesiredSetpoints::kHelmCourseFieldNumber = 10
static

Definition at line 402 of file high_control.pb.h.

◆ kIndexInFileMessages

constexpr int jaiabot::protobuf::DesiredSetpoints::kIndexInFileMessages
staticconstexpr
Initial value:
=
1

Definition at line 332 of file high_control.pb.h.

◆ kIsHelmConstantCourseFieldNumber

const int jaiabot::protobuf::DesiredSetpoints::kIsHelmConstantCourseFieldNumber = 2
static

Definition at line 395 of file high_control.pb.h.

◆ kRemoteControlFieldNumber

const int jaiabot::protobuf::DesiredSetpoints::kRemoteControlFieldNumber = 11
static

Definition at line 414 of file high_control.pb.h.

◆ kThrottleFieldNumber

const int jaiabot::protobuf::DesiredSetpoints::kThrottleFieldNumber = 13
static

Definition at line 433 of file high_control.pb.h.

◆ kTypeFieldNumber

const int jaiabot::protobuf::DesiredSetpoints::kTypeFieldNumber = 1
static

Definition at line 388 of file high_control.pb.h.

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