JaiaBot 2.0.0
JaiaBot micro-AUV software
 
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
jaiabot::protobuf::PIDControl_PIDSettings Class Referencefinal

#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

enum  : int { kTargetFieldNumber = 1 , kKpFieldNumber = 2 , kKiFieldNumber = 3 , kKdFieldNumber = 4 }
 
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 ()
 
 ~PIDControl_PIDSettings () override
 
PROTOBUF_CONSTEXPR PIDControl_PIDSettings (::PROTOBUF_NAMESPACE_ID::internal::ConstantInitialized)
 
 PIDControl_PIDSettings (const PIDControl_PIDSettings &from)
 
 PIDControl_PIDSettings (PIDControl_PIDSettings &&from) noexcept
 
PIDControl_PIDSettings & operator= (const PIDControl_PIDSettings &from)
 
PIDControl_PIDSettings & operator= (PIDControl_PIDSettings &&from) noexcept
 
const ::PROTOBUF_NAMESPACE_ID::UnknownFieldSet & unknown_fields () const
 
inline ::PROTOBUF_NAMESPACE_ID::UnknownFieldSet * mutable_unknown_fields ()
 
void Swap (PIDControl_PIDSettings *other)
 
void UnsafeArenaSwap (PIDControl_PIDSettings *other)
 
PIDControl_PIDSettings * New (::PROTOBUF_NAMESPACE_ID::Arena *arena=nullptr) const final
 
void CopyFrom (const PIDControl_PIDSettings &from)
 
void MergeFrom (const PIDControl_PIDSettings &from)
 
PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear () final
 
bool IsInitialized () const final
 
size_t ByteSizeLong () const final
 
const char * _InternalParse (const char *ptr, ::PROTOBUF_NAMESPACE_ID::internal::ParseContext *ctx) final
 
uint8_t * _InternalSerialize (uint8_t *target, ::PROTOBUF_NAMESPACE_ID::io::EpsCopyOutputStream *stream) const final
 
int GetCachedSize () const final
 
const ::PROTOBUF_NAMESPACE_ID::Message::ClassData * GetClassData () const final
 
::PROTOBUF_NAMESPACE_ID::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 ::PROTOBUF_NAMESPACE_ID::Descriptor * descriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * GetDescriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Reflection * GetReflection ()
 
static const PIDControl_PIDSettings & default_instance ()
 
static const PIDControl_PIDSettings * internal_default_instance ()
 

Static Public Attributes

static constexpr int kIndexInFileMessages
 
static const ClassData _class_data_
 

Protected Member Functions

 PIDControl_PIDSettings (::PROTOBUF_NAMESPACE_ID::Arena *arena, bool is_message_owned=false)
 

Friends

class ::PROTOBUF_NAMESPACE_ID::internal::AnyMetadata
 
template<typename T >
class ::PROTOBUF_NAMESPACE_ID::Arena::InternalHelper
 
struct ::TableStruct_jaiabot_2fmessages_2fengineering_2eproto
 
void swap (PIDControl_PIDSettings &a, PIDControl_PIDSettings &b)
 

Detailed Description

Definition at line 130 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 315 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 317 of file engineering.pb.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : int
Enumerator
kTargetFieldNumber 
kKpFieldNumber 
kKiFieldNumber 
kKdFieldNumber 

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

Constructor & Destructor Documentation

◆ PIDControl_PIDSettings() [1/5]

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

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

◆ ~PIDControl_PIDSettings()

jaiabot::protobuf::PIDControl_PIDSettings::~PIDControl_PIDSettings ( )
override

◆ PIDControl_PIDSettings() [2/5]

PROTOBUF_CONSTEXPR jaiabot::protobuf::PIDControl_PIDSettings::PIDControl_PIDSettings ( ::PROTOBUF_NAMESPACE_ID::internal::ConstantInitialized  )
explicit

◆ PIDControl_PIDSettings() [3/5]

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

◆ PIDControl_PIDSettings() [4/5]

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

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

◆ PIDControl_PIDSettings() [5/5]

jaiabot::protobuf::PIDControl_PIDSettings::PIDControl_PIDSettings ( ::PROTOBUF_NAMESPACE_ID::Arena *  arena,
bool  is_message_owned = false 
)
explicitprotected

Member Function Documentation

◆ _InternalParse()

const char * jaiabot::protobuf::PIDControl_PIDSettings::_InternalParse ( const char *  ptr,
::PROTOBUF_NAMESPACE_ID::internal::ParseContext *  ctx 
)
final

◆ _InternalSerialize()

uint8_t * jaiabot::protobuf::PIDControl_PIDSettings::_InternalSerialize ( uint8_t *  target,
::PROTOBUF_NAMESPACE_ID::io::EpsCopyOutputStream *  stream 
) const
final

◆ ByteSizeLong()

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

◆ Clear()

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

◆ clear_kd()

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

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

◆ clear_ki()

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

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

◆ clear_kp()

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

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

◆ clear_target()

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

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

◆ CopyFrom()

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

◆ default_instance()

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

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

◆ descriptor()

static const ::PROTOBUF_NAMESPACE_ID::Descriptor * jaiabot::protobuf::PIDControl_PIDSettings::descriptor ( )
inlinestatic

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

◆ GetCachedSize()

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

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

◆ GetClassData()

const ::PROTOBUF_NAMESPACE_ID::Message::ClassData * jaiabot::protobuf::PIDControl_PIDSettings::GetClassData ( ) const
final

◆ GetDescriptor()

static const ::PROTOBUF_NAMESPACE_ID::Descriptor * jaiabot::protobuf::PIDControl_PIDSettings::GetDescriptor ( )
inlinestatic

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

◆ GetMetadata()

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

◆ GetReflection()

static const ::PROTOBUF_NAMESPACE_ID::Reflection * jaiabot::protobuf::PIDControl_PIDSettings::GetReflection ( )
inlinestatic

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

◆ has_kd()

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

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

◆ has_ki()

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

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

◆ has_kp()

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

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

◆ has_target()

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

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

◆ internal_default_instance()

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

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

◆ IsInitialized()

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

◆ kd()

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

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

◆ ki()

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

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

◆ kp()

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

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

◆ MergeFrom()

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

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

◆ mutable_unknown_fields()

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

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

◆ New()

PIDControl_PIDSettings * jaiabot::protobuf::PIDControl_PIDSettings::New ( ::PROTOBUF_NAMESPACE_ID::Arena *  arena = nullptr) const
inlinefinal

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

◆ operator=() [1/2]

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

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

◆ operator=() [2/2]

PIDControl_PIDSettings & jaiabot::protobuf::PIDControl_PIDSettings::operator= ( PIDControl_PIDSettings &&  from)
inlinenoexcept

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

◆ set_kd()

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

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

◆ set_ki()

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

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

◆ set_kp()

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

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

◆ set_target()

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

Definition at line 1950 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 320 of file engineering.pb.h.

◆ Swap()

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

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

◆ target()

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

Definition at line 1942 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 324 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 327 of file engineering.pb.h.

◆ unknown_fields()

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

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

◆ UnsafeArenaSwap()

void jaiabot::protobuf::PIDControl_PIDSettings::UnsafeArenaSwap ( PIDControl_PIDSettings *  other)
inline

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

Friends And Related Symbol Documentation

◆ ::PROTOBUF_NAMESPACE_ID::Arena::InternalHelper

template<typename T >
friend class ::PROTOBUF_NAMESPACE_ID::Arena::InternalHelper
friend

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

◆ ::PROTOBUF_NAMESPACE_ID::internal::AnyMetadata

friend class ::PROTOBUF_NAMESPACE_ID::internal::AnyMetadata
friend

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

◆ ::TableStruct_jaiabot_2fmessages_2fengineering_2eproto

friend struct ::TableStruct_jaiabot_2fmessages_2fengineering_2eproto
friend

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

◆ swap

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

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

Member Data Documentation

◆ _class_data_

const ClassData jaiabot::protobuf::PIDControl_PIDSettings::_class_data_
static

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

◆ _impl_

Impl_ jaiabot::protobuf::PIDControl_PIDSettings::_impl_

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

◆ kIndexInFileMessages

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

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

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