JaiaBot  1.12.0+18+g85da5f82
JaiaBot micro-AUV software
jaiabot::protobuf::PIDControl Class Reference

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

Inheritance diagram for jaiabot::protobuf::PIDControl:
Collaboration diagram for jaiabot::protobuf::PIDControl:

Public Types

typedef PIDControl_PIDSettings PIDSettings
 
typedef boost::units::time_dimension timeout_dimension
 
typedef boost::units::unit< timeout_dimension, boost::units::si::system > timeout_unit
 

Public Member Functions

 PIDControl ()
 
virtual ~PIDControl ()
 
 PIDControl (const PIDControl &from)
 
PIDControloperator= (const PIDControl &from)
 
const ::google::protobuf::UnknownFieldSet & unknown_fields () const
 
inline ::google::protobuf::UnknownFieldSet * mutable_unknown_fields ()
 
void Swap (PIDControl *other)
 
PIDControlNew () const final
 
PIDControlNew (::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 PIDControl &from)
 
void MergeFrom (const PIDControl &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_speed () const
 
void clear_speed ()
 
const ::jaiabot::protobuf::PIDControl_PIDSettingsspeed () const
 
::jaiabot::protobuf::PIDControl_PIDSettingsrelease_speed ()
 
::jaiabot::protobuf::PIDControl_PIDSettingsmutable_speed ()
 
void set_allocated_speed (::jaiabot::protobuf::PIDControl_PIDSettings *speed)
 
bool has_heading () const
 
void clear_heading ()
 
const ::jaiabot::protobuf::PIDControl_PIDSettingsheading () const
 
::jaiabot::protobuf::PIDControl_PIDSettingsrelease_heading ()
 
::jaiabot::protobuf::PIDControl_PIDSettingsmutable_heading ()
 
void set_allocated_heading (::jaiabot::protobuf::PIDControl_PIDSettings *heading)
 
bool has_roll () const
 
void clear_roll ()
 
const ::jaiabot::protobuf::PIDControl_PIDSettingsroll () const
 
::jaiabot::protobuf::PIDControl_PIDSettingsrelease_roll ()
 
::jaiabot::protobuf::PIDControl_PIDSettingsmutable_roll ()
 
void set_allocated_roll (::jaiabot::protobuf::PIDControl_PIDSettings *roll)
 
bool has_pitch () const
 
void clear_pitch ()
 
const ::jaiabot::protobuf::PIDControl_PIDSettingspitch () const
 
::jaiabot::protobuf::PIDControl_PIDSettingsrelease_pitch ()
 
::jaiabot::protobuf::PIDControl_PIDSettingsmutable_pitch ()
 
void set_allocated_pitch (::jaiabot::protobuf::PIDControl_PIDSettings *pitch)
 
bool has_depth () const
 
void clear_depth ()
 
const ::jaiabot::protobuf::PIDControl_PIDSettingsdepth () const
 
::jaiabot::protobuf::PIDControl_PIDSettingsrelease_depth ()
 
::jaiabot::protobuf::PIDControl_PIDSettingsmutable_depth ()
 
void set_allocated_depth (::jaiabot::protobuf::PIDControl_PIDSettings *depth)
 
bool has_heading_constant () const
 
void clear_heading_constant ()
 
const ::jaiabot::protobuf::PIDControl_PIDSettingsheading_constant () const
 
::jaiabot::protobuf::PIDControl_PIDSettingsrelease_heading_constant ()
 
::jaiabot::protobuf::PIDControl_PIDSettingsmutable_heading_constant ()
 
void set_allocated_heading_constant (::jaiabot::protobuf::PIDControl_PIDSettings *heading_constant)
 
bool has_throttle () const
 
void clear_throttle ()
 
double throttle () const
 
void set_throttle (double value)
 
bool has_rudder () const
 
void clear_rudder ()
 
double rudder () const
 
void set_rudder (double value)
 
bool has_port_elevator () const
 
void clear_port_elevator ()
 
double port_elevator () const
 
void set_port_elevator (double value)
 
bool has_timeout () const
 
void clear_timeout ()
 
::google::protobuf::uint32 timeout () const
 
void set_timeout (::google::protobuf::uint32 value)
 
bool has_led_switch_on () const
 
void clear_led_switch_on ()
 
bool led_switch_on () const
 
void set_led_switch_on (bool value)
 
bool has_stbd_elevator () const
 
void clear_stbd_elevator ()
 
double stbd_elevator () const
 
void set_stbd_elevator (double value)
 
template<typename Quantity >
void set_timeout_with_units (Quantity value_w_units)
 
template<typename Quantity >
Quantity timeout_with_units () const
 
boost::units::quantity< timeout_unit, google::protobuf::uint32 > timeout_with_units () const
 

Static Public Member Functions

static const ::google::protobuf::Descriptor * descriptor ()
 
static const PIDControldefault_instance ()
 
static void InitAsDefaultInstance ()
 
static const PIDControlinternal_default_instance ()
 

Static Public Attributes

static constexpr int kIndexInFileMessages
 
static const int kSpeedFieldNumber = 5
 
static const int kHeadingFieldNumber = 7
 
static const int kRollFieldNumber = 10
 
static const int kPitchFieldNumber = 11
 
static const int kDepthFieldNumber = 12
 
static const int kHeadingConstantFieldNumber = 14
 
static const int kThrottleFieldNumber = 4
 
static const int kRudderFieldNumber = 6
 
static const int kPortElevatorFieldNumber = 8
 
static const int kTimeoutFieldNumber = 3
 
static const int kLedSwitchOnFieldNumber = 13
 
static const int kStbdElevatorFieldNumber = 9
 

Friends

struct ::protobuf_jaiabot_2fmessages_2fengineering_2eproto::TableStruct
 
void swap (PIDControl &a, PIDControl &b)
 

Detailed Description

Definition at line 287 of file engineering.pb.h.

Member Typedef Documentation

◆ PIDSettings

◆ timeout_dimension

typedef boost::units::time_dimension jaiabot::protobuf::PIDControl::timeout_dimension

Definition at line 497 of file engineering.pb.h.

◆ timeout_unit

typedef boost::units::unit<timeout_dimension,boost::units::si::system> jaiabot::protobuf::PIDControl::timeout_unit

Definition at line 499 of file engineering.pb.h.

Constructor & Destructor Documentation

◆ PIDControl() [1/2]

jaiabot::protobuf::PIDControl::PIDControl ( )

◆ ~PIDControl()

virtual jaiabot::protobuf::PIDControl::~PIDControl ( )
virtual

◆ PIDControl() [2/2]

jaiabot::protobuf::PIDControl::PIDControl ( const PIDControl from)

Member Function Documentation

◆ ByteSizeLong()

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

◆ Clear()

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

◆ clear_depth()

void jaiabot::protobuf::PIDControl::clear_depth ( )
inline

Definition at line 1870 of file engineering.pb.h.

◆ clear_heading()

void jaiabot::protobuf::PIDControl::clear_heading ( )
inline

Definition at line 1648 of file engineering.pb.h.

◆ clear_heading_constant()

void jaiabot::protobuf::PIDControl::clear_heading_constant ( )
inline

Definition at line 1952 of file engineering.pb.h.

◆ clear_led_switch_on()

void jaiabot::protobuf::PIDControl::clear_led_switch_on ( )
inline

Definition at line 1928 of file engineering.pb.h.

◆ clear_pitch()

void jaiabot::protobuf::PIDControl::clear_pitch ( )
inline

Definition at line 1812 of file engineering.pb.h.

◆ clear_port_elevator()

void jaiabot::protobuf::PIDControl::clear_port_elevator ( )
inline

Definition at line 1706 of file engineering.pb.h.

◆ clear_roll()

void jaiabot::protobuf::PIDControl::clear_roll ( )
inline

Definition at line 1754 of file engineering.pb.h.

◆ clear_rudder()

void jaiabot::protobuf::PIDControl::clear_rudder ( )
inline

Definition at line 1624 of file engineering.pb.h.

◆ clear_speed()

void jaiabot::protobuf::PIDControl::clear_speed ( )
inline

Definition at line 1566 of file engineering.pb.h.

◆ clear_stbd_elevator()

void jaiabot::protobuf::PIDControl::clear_stbd_elevator ( )
inline

Definition at line 1730 of file engineering.pb.h.

◆ clear_throttle()

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

Definition at line 1542 of file engineering.pb.h.

◆ clear_timeout()

void jaiabot::protobuf::PIDControl::clear_timeout ( )
inline

Definition at line 1518 of file engineering.pb.h.

◆ CopyFrom() [1/2]

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

◆ CopyFrom() [2/2]

void jaiabot::protobuf::PIDControl::CopyFrom ( const PIDControl from)

◆ default_instance()

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

◆ depth()

const ::jaiabot::protobuf::PIDControl_PIDSettings & jaiabot::protobuf::PIDControl::depth ( ) const
inline

Definition at line 1877 of file engineering.pb.h.

◆ descriptor()

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

◆ GetCachedSize()

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

Definition at line 359 of file engineering.pb.h.

◆ GetMetadata()

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

◆ has_depth()

bool jaiabot::protobuf::PIDControl::has_depth ( ) const
inline

Definition at line 1861 of file engineering.pb.h.

◆ has_heading()

bool jaiabot::protobuf::PIDControl::has_heading ( ) const
inline

Definition at line 1639 of file engineering.pb.h.

◆ has_heading_constant()

bool jaiabot::protobuf::PIDControl::has_heading_constant ( ) const
inline

Definition at line 1943 of file engineering.pb.h.

◆ has_led_switch_on()

bool jaiabot::protobuf::PIDControl::has_led_switch_on ( ) const
inline

Definition at line 1919 of file engineering.pb.h.

◆ has_pitch()

bool jaiabot::protobuf::PIDControl::has_pitch ( ) const
inline

Definition at line 1803 of file engineering.pb.h.

◆ has_port_elevator()

bool jaiabot::protobuf::PIDControl::has_port_elevator ( ) const
inline

Definition at line 1697 of file engineering.pb.h.

◆ has_roll()

bool jaiabot::protobuf::PIDControl::has_roll ( ) const
inline

Definition at line 1745 of file engineering.pb.h.

◆ has_rudder()

bool jaiabot::protobuf::PIDControl::has_rudder ( ) const
inline

Definition at line 1615 of file engineering.pb.h.

◆ has_speed()

bool jaiabot::protobuf::PIDControl::has_speed ( ) const
inline

Definition at line 1557 of file engineering.pb.h.

◆ has_stbd_elevator()

bool jaiabot::protobuf::PIDControl::has_stbd_elevator ( ) const
inline

Definition at line 1721 of file engineering.pb.h.

◆ has_throttle()

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

Definition at line 1533 of file engineering.pb.h.

◆ has_timeout()

bool jaiabot::protobuf::PIDControl::has_timeout ( ) const
inline

Definition at line 1509 of file engineering.pb.h.

◆ heading()

const ::jaiabot::protobuf::PIDControl_PIDSettings & jaiabot::protobuf::PIDControl::heading ( ) const
inline

Definition at line 1655 of file engineering.pb.h.

◆ heading_constant()

const ::jaiabot::protobuf::PIDControl_PIDSettings & jaiabot::protobuf::PIDControl::heading_constant ( ) const
inline

Definition at line 1959 of file engineering.pb.h.

◆ InitAsDefaultInstance()

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

◆ internal_default_instance()

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

Definition at line 324 of file engineering.pb.h.

◆ InternalSerializeWithCachedSizesToArray()

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

◆ IsInitialized()

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

◆ led_switch_on()

bool jaiabot::protobuf::PIDControl::led_switch_on ( ) const
inline

Definition at line 1932 of file engineering.pb.h.

◆ MergeFrom() [1/2]

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

◆ MergeFrom() [2/2]

void jaiabot::protobuf::PIDControl::MergeFrom ( const PIDControl from)

◆ MergePartialFromCodedStream()

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

◆ mutable_depth()

jaiabot::protobuf::PIDControl_PIDSettings * jaiabot::protobuf::PIDControl::mutable_depth ( )
inline

Definition at line 1890 of file engineering.pb.h.

◆ mutable_heading()

jaiabot::protobuf::PIDControl_PIDSettings * jaiabot::protobuf::PIDControl::mutable_heading ( )
inline

Definition at line 1668 of file engineering.pb.h.

◆ mutable_heading_constant()

jaiabot::protobuf::PIDControl_PIDSettings * jaiabot::protobuf::PIDControl::mutable_heading_constant ( )
inline

Definition at line 1972 of file engineering.pb.h.

◆ mutable_pitch()

jaiabot::protobuf::PIDControl_PIDSettings * jaiabot::protobuf::PIDControl::mutable_pitch ( )
inline

Definition at line 1832 of file engineering.pb.h.

◆ mutable_roll()

jaiabot::protobuf::PIDControl_PIDSettings * jaiabot::protobuf::PIDControl::mutable_roll ( )
inline

Definition at line 1774 of file engineering.pb.h.

◆ mutable_speed()

jaiabot::protobuf::PIDControl_PIDSettings * jaiabot::protobuf::PIDControl::mutable_speed ( )
inline

Definition at line 1586 of file engineering.pb.h.

◆ mutable_unknown_fields()

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

Definition at line 316 of file engineering.pb.h.

◆ New() [1/2]

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

Definition at line 338 of file engineering.pb.h.

◆ New() [2/2]

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

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

◆ operator=()

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

Definition at line 294 of file engineering.pb.h.

◆ pitch()

const ::jaiabot::protobuf::PIDControl_PIDSettings & jaiabot::protobuf::PIDControl::pitch ( ) const
inline

Definition at line 1819 of file engineering.pb.h.

◆ port_elevator()

double jaiabot::protobuf::PIDControl::port_elevator ( ) const
inline

Definition at line 1710 of file engineering.pb.h.

◆ release_depth()

jaiabot::protobuf::PIDControl_PIDSettings * jaiabot::protobuf::PIDControl::release_depth ( )
inline

Definition at line 1883 of file engineering.pb.h.

◆ release_heading()

jaiabot::protobuf::PIDControl_PIDSettings * jaiabot::protobuf::PIDControl::release_heading ( )
inline

Definition at line 1661 of file engineering.pb.h.

◆ release_heading_constant()

jaiabot::protobuf::PIDControl_PIDSettings * jaiabot::protobuf::PIDControl::release_heading_constant ( )
inline

Definition at line 1965 of file engineering.pb.h.

◆ release_pitch()

jaiabot::protobuf::PIDControl_PIDSettings * jaiabot::protobuf::PIDControl::release_pitch ( )
inline

Definition at line 1825 of file engineering.pb.h.

◆ release_roll()

jaiabot::protobuf::PIDControl_PIDSettings * jaiabot::protobuf::PIDControl::release_roll ( )
inline

Definition at line 1767 of file engineering.pb.h.

◆ release_speed()

jaiabot::protobuf::PIDControl_PIDSettings * jaiabot::protobuf::PIDControl::release_speed ( )
inline

Definition at line 1579 of file engineering.pb.h.

◆ roll()

const ::jaiabot::protobuf::PIDControl_PIDSettings & jaiabot::protobuf::PIDControl::roll ( ) const
inline

Definition at line 1761 of file engineering.pb.h.

◆ rudder()

double jaiabot::protobuf::PIDControl::rudder ( ) const
inline

Definition at line 1628 of file engineering.pb.h.

◆ SerializeWithCachedSizes()

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

◆ set_allocated_depth()

void jaiabot::protobuf::PIDControl::set_allocated_depth ( ::jaiabot::protobuf::PIDControl_PIDSettings depth)
inline

Definition at line 1899 of file engineering.pb.h.

◆ set_allocated_heading()

void jaiabot::protobuf::PIDControl::set_allocated_heading ( ::jaiabot::protobuf::PIDControl_PIDSettings heading)
inline

Definition at line 1677 of file engineering.pb.h.

◆ set_allocated_heading_constant()

void jaiabot::protobuf::PIDControl::set_allocated_heading_constant ( ::jaiabot::protobuf::PIDControl_PIDSettings heading_constant)
inline

Definition at line 1981 of file engineering.pb.h.

◆ set_allocated_pitch()

void jaiabot::protobuf::PIDControl::set_allocated_pitch ( ::jaiabot::protobuf::PIDControl_PIDSettings pitch)
inline

Definition at line 1841 of file engineering.pb.h.

◆ set_allocated_roll()

void jaiabot::protobuf::PIDControl::set_allocated_roll ( ::jaiabot::protobuf::PIDControl_PIDSettings roll)
inline

Definition at line 1783 of file engineering.pb.h.

◆ set_allocated_speed()

void jaiabot::protobuf::PIDControl::set_allocated_speed ( ::jaiabot::protobuf::PIDControl_PIDSettings speed)
inline

Definition at line 1595 of file engineering.pb.h.

◆ set_led_switch_on()

void jaiabot::protobuf::PIDControl::set_led_switch_on ( bool  value)
inline

Definition at line 1936 of file engineering.pb.h.

◆ set_port_elevator()

void jaiabot::protobuf::PIDControl::set_port_elevator ( double  value)
inline

Definition at line 1714 of file engineering.pb.h.

◆ set_rudder()

void jaiabot::protobuf::PIDControl::set_rudder ( double  value)
inline

Definition at line 1632 of file engineering.pb.h.

◆ set_stbd_elevator()

void jaiabot::protobuf::PIDControl::set_stbd_elevator ( double  value)
inline

Definition at line 1738 of file engineering.pb.h.

◆ set_throttle()

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

Definition at line 1550 of file engineering.pb.h.

◆ set_timeout()

void jaiabot::protobuf::PIDControl::set_timeout ( ::google::protobuf::uint32  value)
inline

Definition at line 1526 of file engineering.pb.h.

◆ set_timeout_with_units()

template<typename Quantity >
void jaiabot::protobuf::PIDControl::set_timeout_with_units ( Quantity  value_w_units)
inline

Definition at line 502 of file engineering.pb.h.

◆ speed()

const ::jaiabot::protobuf::PIDControl_PIDSettings & jaiabot::protobuf::PIDControl::speed ( ) const
inline

Definition at line 1573 of file engineering.pb.h.

◆ stbd_elevator()

double jaiabot::protobuf::PIDControl::stbd_elevator ( ) const
inline

Definition at line 1734 of file engineering.pb.h.

◆ Swap()

void jaiabot::protobuf::PIDControl::Swap ( PIDControl other)

◆ throttle()

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

Definition at line 1546 of file engineering.pb.h.

◆ timeout()

google::protobuf::uint32 jaiabot::protobuf::PIDControl::timeout ( ) const
inline

Definition at line 1522 of file engineering.pb.h.

◆ timeout_with_units() [1/2]

template<typename Quantity >
Quantity jaiabot::protobuf::PIDControl::timeout_with_units ( ) const
inline

Definition at line 506 of file engineering.pb.h.

◆ timeout_with_units() [2/2]

boost::units::quantity< timeout_unit,google::protobuf::uint32 > jaiabot::protobuf::PIDControl::timeout_with_units ( ) const
inline

Definition at line 509 of file engineering.pb.h.

◆ unknown_fields()

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

Definition at line 313 of file engineering.pb.h.

Friends And Related Function Documentation

◆ ::protobuf_jaiabot_2fmessages_2fengineering_2eproto::TableStruct

Definition at line 554 of file engineering.pb.h.

◆ swap

void swap ( PIDControl a,
PIDControl b 
)
friend

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

Member Data Documentation

◆ kDepthFieldNumber

const int jaiabot::protobuf::PIDControl::kDepthFieldNumber = 12
static

Definition at line 434 of file engineering.pb.h.

◆ kHeadingConstantFieldNumber

const int jaiabot::protobuf::PIDControl::kHeadingConstantFieldNumber = 14
static

Definition at line 446 of file engineering.pb.h.

◆ kHeadingFieldNumber

const int jaiabot::protobuf::PIDControl::kHeadingFieldNumber = 7
static

Definition at line 398 of file engineering.pb.h.

◆ kIndexInFileMessages

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

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

◆ kLedSwitchOnFieldNumber

const int jaiabot::protobuf::PIDControl::kLedSwitchOnFieldNumber = 13
static

Definition at line 486 of file engineering.pb.h.

◆ kPitchFieldNumber

const int jaiabot::protobuf::PIDControl::kPitchFieldNumber = 11
static

Definition at line 422 of file engineering.pb.h.

◆ kPortElevatorFieldNumber

const int jaiabot::protobuf::PIDControl::kPortElevatorFieldNumber = 8
static

Definition at line 472 of file engineering.pb.h.

◆ kRollFieldNumber

const int jaiabot::protobuf::PIDControl::kRollFieldNumber = 10
static

Definition at line 410 of file engineering.pb.h.

◆ kRudderFieldNumber

const int jaiabot::protobuf::PIDControl::kRudderFieldNumber = 6
static

Definition at line 465 of file engineering.pb.h.

◆ kSpeedFieldNumber

const int jaiabot::protobuf::PIDControl::kSpeedFieldNumber = 5
static

Definition at line 386 of file engineering.pb.h.

◆ kStbdElevatorFieldNumber

const int jaiabot::protobuf::PIDControl::kStbdElevatorFieldNumber = 9
static

Definition at line 493 of file engineering.pb.h.

◆ kThrottleFieldNumber

const int jaiabot::protobuf::PIDControl::kThrottleFieldNumber = 4
static

Definition at line 458 of file engineering.pb.h.

◆ kTimeoutFieldNumber

const int jaiabot::protobuf::PIDControl::kTimeoutFieldNumber = 3
static

Definition at line 479 of file engineering.pb.h.


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