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

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

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

Public Types

typedef boost::units::plane_angle_dimension target_dimension
 
typedef boost::units::unit< target_dimension, boost::units::degree::system > target_unit
 

Public Member Functions

 PIDControl_PIDSettings ()
 
virtual ~PIDControl_PIDSettings ()
 
 PIDControl_PIDSettings (const PIDControl_PIDSettings &from)
 
PIDControl_PIDSettings & operator= (const PIDControl_PIDSettings &from)
 
const ::google::protobuf::UnknownFieldSet & unknown_fields () const
 
inline ::google::protobuf::UnknownFieldSet * mutable_unknown_fields ()
 
void Swap (PIDControl_PIDSettings *other)
 
PIDControl_PIDSettings * New () const final
 
PIDControl_PIDSettings * 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 PIDControl_PIDSettings &from)
 
void MergeFrom (const PIDControl_PIDSettings &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_target () const
 
void clear_target ()
 
double target () const
 
void set_target (double value)
 
bool has_kp () const
 
void clear_kp ()
 
double kp () const
 
void set_kp (double value)
 
bool has_ki () const
 
void clear_ki ()
 
double ki () const
 
void set_ki (double value)
 
bool has_kd () const
 
void clear_kd ()
 
double kd () const
 
void set_kd (double value)
 
template<typename Quantity >
void set_target_with_units (Quantity value_w_units)
 
template<typename Quantity >
Quantity target_with_units () const
 
boost::units::quantity< target_unit, double > target_with_units () const
 

Static Public Member Functions

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

Static Public Attributes

static constexpr int kIndexInFileMessages
 
static const int kTargetFieldNumber = 1
 
static const int kKpFieldNumber = 2
 
static const int kKiFieldNumber = 3
 
static const int kKdFieldNumber = 4
 

Friends

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

Detailed Description

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

Member Typedef Documentation

◆ target_dimension

typedef boost::units::plane_angle_dimension jaiabot::protobuf::PIDControl_PIDSettings::target_dimension

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

◆ target_unit

typedef boost::units::unit<target_dimension,boost::units::degree::system> jaiabot::protobuf::PIDControl_PIDSettings::target_unit

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

Constructor & Destructor Documentation

◆ PIDControl_PIDSettings() [1/2]

jaiabot::protobuf::PIDControl_PIDSettings::PIDControl_PIDSettings ( )

◆ ~PIDControl_PIDSettings()

virtual jaiabot::protobuf::PIDControl_PIDSettings::~PIDControl_PIDSettings ( )
virtual

◆ PIDControl_PIDSettings() [2/2]

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

Member Function Documentation

◆ ByteSizeLong()

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

◆ Clear()

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

◆ clear_kd()

void jaiabot::protobuf::PIDControl_PIDSettings::clear_kd ( )
inline

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

◆ clear_ki()

void jaiabot::protobuf::PIDControl_PIDSettings::clear_ki ( )
inline

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

◆ clear_kp()

void jaiabot::protobuf::PIDControl_PIDSettings::clear_kp ( )
inline

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

◆ clear_target()

void jaiabot::protobuf::PIDControl_PIDSettings::clear_target ( )
inline

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

◆ CopyFrom() [1/2]

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

◆ CopyFrom() [2/2]

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

◆ default_instance()

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

◆ descriptor()

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

◆ GetCachedSize()

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

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

◆ GetMetadata()

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

◆ has_kd()

bool jaiabot::protobuf::PIDControl_PIDSettings::has_kd ( ) const
inline

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

◆ has_ki()

bool jaiabot::protobuf::PIDControl_PIDSettings::has_ki ( ) const
inline

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

◆ has_kp()

bool jaiabot::protobuf::PIDControl_PIDSettings::has_kp ( ) const
inline

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

◆ has_target()

bool jaiabot::protobuf::PIDControl_PIDSettings::has_target ( ) const
inline

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

◆ InitAsDefaultInstance()

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

◆ internal_default_instance()

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

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

◆ InternalSerializeWithCachedSizesToArray()

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

◆ IsInitialized()

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

◆ kd()

double jaiabot::protobuf::PIDControl_PIDSettings::kd ( ) const
inline

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

◆ ki()

double jaiabot::protobuf::PIDControl_PIDSettings::ki ( ) const
inline

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

◆ kp()

double jaiabot::protobuf::PIDControl_PIDSettings::kp ( ) const
inline

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

◆ MergeFrom() [1/2]

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

◆ MergeFrom() [2/2]

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

◆ MergePartialFromCodedStream()

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

◆ mutable_unknown_fields()

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

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

◆ New() [1/2]

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

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

◆ New() [2/2]

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

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

◆ operator=()

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

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

◆ SerializeWithCachedSizes()

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

◆ set_kd()

void jaiabot::protobuf::PIDControl_PIDSettings::set_kd ( double  value)
inline

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

◆ set_ki()

void jaiabot::protobuf::PIDControl_PIDSettings::set_ki ( double  value)
inline

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

◆ set_kp()

void jaiabot::protobuf::PIDControl_PIDSettings::set_kp ( double  value)
inline

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

◆ set_target()

void jaiabot::protobuf::PIDControl_PIDSettings::set_target ( double  value)
inline

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

◆ set_target_with_units()

template<typename Quantity >
void jaiabot::protobuf::PIDControl_PIDSettings::set_target_with_units ( Quantity  value_w_units)
inline

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

◆ Swap()

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

◆ target()

double jaiabot::protobuf::PIDControl_PIDSettings::target ( ) const
inline

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

◆ target_with_units() [1/2]

template<typename Quantity >
Quantity jaiabot::protobuf::PIDControl_PIDSettings::target_with_units ( ) const
inline

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

◆ target_with_units() [2/2]

boost::units::quantity< target_unit,double > jaiabot::protobuf::PIDControl_PIDSettings::target_with_units ( ) const
inline

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

◆ unknown_fields()

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

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

Friends And Related Function Documentation

◆ ::protobuf_jaiabot_2fmessages_2fengineering_2eproto::TableStruct

friend struct ::protobuf_jaiabot_2fmessages_2fengineering_2eproto::TableStruct
friend

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

◆ swap

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

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

Member Data Documentation

◆ kIndexInFileMessages

constexpr int jaiabot::protobuf::PIDControl_PIDSettings::kIndexInFileMessages
staticconstexpr
Initial value:
=
0

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

◆ kKdFieldNumber

const int jaiabot::protobuf::PIDControl_PIDSettings::kKdFieldNumber = 4
static

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

◆ kKiFieldNumber

const int jaiabot::protobuf::PIDControl_PIDSettings::kKiFieldNumber = 3
static

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

◆ kKpFieldNumber

const int jaiabot::protobuf::PIDControl_PIDSettings::kKpFieldNumber = 2
static

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

◆ kTargetFieldNumber

const int jaiabot::protobuf::PIDControl_PIDSettings::kTargetFieldNumber = 1
static

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

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