Ignition Msgs

API Reference

5.8.1

#include <pid.pb.h>

Public Types

enum  : int {
  kHeaderFieldNumber = 1 , kTargetOptionalFieldNumber = 9 , kPGainOptionalFieldNumber = 10 , kIGainOptionalFieldNumber = 11 ,
  kDGainOptionalFieldNumber = 12 , kIMaxOptionalFieldNumber = 13 , kIMinOptionalFieldNumber = 14 , kLimitOptionalFieldNumber = 15 ,
  kTargetFieldNumber = 2 , kPGainFieldNumber = 3 , kIGainFieldNumber = 4 , kDGainFieldNumber = 5 ,
  kIMaxFieldNumber = 6 , kIMinFieldNumber = 7 , kLimitFieldNumber = 8
}
 

Public Member Functions

 PID ()
 
constexpr PID (::PROTOBUF_NAMESPACE_ID::internal::ConstantInitialized)
 
 PID (const PID &from)
 
 PID (PID &&from) noexcept
 
 ~PID () override
 
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
 
size_t ByteSizeLong () const final
 
PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear () final
 
PROTOBUF_DEPRECATED void clear_d_gain ()
 
void clear_d_gain_optional ()
 
void clear_header ()
 
PROTOBUF_DEPRECATED void clear_i_gain ()
 
void clear_i_gain_optional ()
 
PROTOBUF_DEPRECATED void clear_i_max ()
 
void clear_i_max_optional ()
 
PROTOBUF_DEPRECATED void clear_i_min ()
 
void clear_i_min_optional ()
 
PROTOBUF_DEPRECATED void clear_limit ()
 
void clear_limit_optional ()
 
PROTOBUF_DEPRECATED void clear_p_gain ()
 
void clear_p_gain_optional ()
 
PROTOBUF_DEPRECATED void clear_target ()
 
void clear_target_optional ()
 
void CopyFrom (const PID &from)
 
PROTOBUF_DEPRECATED double d_gain () const
 
const ::ignition::msgs::Doubled_gain_optional () const
 
int GetCachedSize () const final
 
const ::PROTOBUF_NAMESPACE_ID::Message::ClassData * GetClassData () const final
 
::PROTOBUF_NAMESPACE_ID::Metadata GetMetadata () const final
 
bool has_d_gain_optional () const
 
bool has_header () const
 
bool has_i_gain_optional () const
 
bool has_i_max_optional () const
 
bool has_i_min_optional () const
 
bool has_limit_optional () const
 
bool has_p_gain_optional () const
 
bool has_target_optional () const
 
const ::ignition::msgs::Headerheader () const
 
PROTOBUF_DEPRECATED double i_gain () const
 
const ::ignition::msgs::Doublei_gain_optional () const
 
PROTOBUF_DEPRECATED double i_max () const
 
const ::ignition::msgs::Doublei_max_optional () const
 
PROTOBUF_DEPRECATED double i_min () const
 
const ::ignition::msgs::Doublei_min_optional () const
 
bool IsInitialized () const final
 
PROTOBUF_DEPRECATED double limit () const
 
const ::ignition::msgs::Doublelimit_optional () const
 
void MergeFrom (const PID &from)
 
::ignition::msgs::Doublemutable_d_gain_optional ()
 
::ignition::msgs::Headermutable_header ()
 
::ignition::msgs::Doublemutable_i_gain_optional ()
 
::ignition::msgs::Doublemutable_i_max_optional ()
 
::ignition::msgs::Doublemutable_i_min_optional ()
 
::ignition::msgs::Doublemutable_limit_optional ()
 
::ignition::msgs::Doublemutable_p_gain_optional ()
 
::ignition::msgs::Doublemutable_target_optional ()
 
PIDNew (::PROTOBUF_NAMESPACE_ID::Arena *arena=nullptr) const final
 
PIDoperator= (const PID &from)
 
PIDoperator= (PID &&from) noexcept
 
PROTOBUF_DEPRECATED double p_gain () const
 
const ::ignition::msgs::Doublep_gain_optional () const
 
PROTOBUF_NODISCARD ::ignition::msgs::Doublerelease_d_gain_optional ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Headerrelease_header ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Doublerelease_i_gain_optional ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Doublerelease_i_max_optional ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Doublerelease_i_min_optional ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Doublerelease_limit_optional ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Doublerelease_p_gain_optional ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Doublerelease_target_optional ()
 
void set_allocated_d_gain_optional (::ignition::msgs::Double *d_gain_optional)
 
void set_allocated_header (::ignition::msgs::Header *header)
 
void set_allocated_i_gain_optional (::ignition::msgs::Double *i_gain_optional)
 
void set_allocated_i_max_optional (::ignition::msgs::Double *i_max_optional)
 
void set_allocated_i_min_optional (::ignition::msgs::Double *i_min_optional)
 
void set_allocated_limit_optional (::ignition::msgs::Double *limit_optional)
 
void set_allocated_p_gain_optional (::ignition::msgs::Double *p_gain_optional)
 
void set_allocated_target_optional (::ignition::msgs::Double *target_optional)
 
PROTOBUF_DEPRECATED void set_d_gain (double value)
 
PROTOBUF_DEPRECATED void set_i_gain (double value)
 
PROTOBUF_DEPRECATED void set_i_max (double value)
 
PROTOBUF_DEPRECATED void set_i_min (double value)
 
PROTOBUF_DEPRECATED void set_limit (double value)
 
PROTOBUF_DEPRECATED void set_p_gain (double value)
 
PROTOBUF_DEPRECATED void set_target (double value)
 
void Swap (PID *other)
 
PROTOBUF_DEPRECATED double target () const
 
const ::ignition::msgs::Doubletarget_optional () const
 
::ignition::msgs::Doubleunsafe_arena_release_d_gain_optional ()
 
::ignition::msgs::Headerunsafe_arena_release_header ()
 
::ignition::msgs::Doubleunsafe_arena_release_i_gain_optional ()
 
::ignition::msgs::Doubleunsafe_arena_release_i_max_optional ()
 
::ignition::msgs::Doubleunsafe_arena_release_i_min_optional ()
 
::ignition::msgs::Doubleunsafe_arena_release_limit_optional ()
 
::ignition::msgs::Doubleunsafe_arena_release_p_gain_optional ()
 
::ignition::msgs::Doubleunsafe_arena_release_target_optional ()
 
void unsafe_arena_set_allocated_d_gain_optional (::ignition::msgs::Double *d_gain_optional)
 
void unsafe_arena_set_allocated_header (::ignition::msgs::Header *header)
 
void unsafe_arena_set_allocated_i_gain_optional (::ignition::msgs::Double *i_gain_optional)
 
void unsafe_arena_set_allocated_i_max_optional (::ignition::msgs::Double *i_max_optional)
 
void unsafe_arena_set_allocated_i_min_optional (::ignition::msgs::Double *i_min_optional)
 
void unsafe_arena_set_allocated_limit_optional (::ignition::msgs::Double *limit_optional)
 
void unsafe_arena_set_allocated_p_gain_optional (::ignition::msgs::Double *p_gain_optional)
 
void unsafe_arena_set_allocated_target_optional (::ignition::msgs::Double *target_optional)
 
void UnsafeArenaSwap (PID *other)
 

Static Public Member Functions

static const PIDdefault_instance ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * descriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * GetDescriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Reflection * GetReflection ()
 
static const PIDinternal_default_instance ()
 

Static Public Attributes

static const ClassData _class_data_
 
static constexpr int kIndexInFileMessages
 

Protected Member Functions

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

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : int
Enumerator
kHeaderFieldNumber 
kTargetOptionalFieldNumber 
kPGainOptionalFieldNumber 
kIGainOptionalFieldNumber 
kDGainOptionalFieldNumber 
kIMaxOptionalFieldNumber 
kIMinOptionalFieldNumber 
kLimitOptionalFieldNumber 
kTargetFieldNumber 
kPGainFieldNumber 
kIGainFieldNumber 
kDGainFieldNumber 
kIMaxFieldNumber 
kIMinFieldNumber 
kLimitFieldNumber 

Constructor & Destructor Documentation

◆ PID() [1/5]

PID ( )
inline

◆ ~PID()

~PID ( )
override

◆ PID() [2/5]

constexpr PID ( ::PROTOBUF_NAMESPACE_ID::internal::ConstantInitialized  )
explicitconstexpr

◆ PID() [3/5]

PID ( const PID from)

◆ PID() [4/5]

PID ( PID &&  from)
inlinenoexcept

◆ PID() [5/5]

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

Member Function Documentation

◆ _InternalParse()

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

◆ _InternalSerialize()

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

◆ ByteSizeLong()

size_t ByteSizeLong ( ) const
final

◆ Clear()

PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear ( )
final

◆ clear_d_gain()

void clear_d_gain ( )
inline

◆ clear_d_gain_optional()

void clear_d_gain_optional ( )

◆ clear_header()

void clear_header ( )

◆ clear_i_gain()

void clear_i_gain ( )
inline

◆ clear_i_gain_optional()

void clear_i_gain_optional ( )

◆ clear_i_max()

void clear_i_max ( )
inline

◆ clear_i_max_optional()

void clear_i_max_optional ( )

◆ clear_i_min()

void clear_i_min ( )
inline

◆ clear_i_min_optional()

void clear_i_min_optional ( )

◆ clear_limit()

void clear_limit ( )
inline

◆ clear_limit_optional()

void clear_limit_optional ( )

◆ clear_p_gain()

void clear_p_gain ( )
inline

◆ clear_p_gain_optional()

void clear_p_gain_optional ( )

◆ clear_target()

void clear_target ( )
inline

◆ clear_target_optional()

void clear_target_optional ( )

◆ CopyFrom()

void CopyFrom ( const PID from)

◆ d_gain()

double d_gain ( ) const
inline

◆ d_gain_optional()

const ::ignition::msgs::Double & d_gain_optional ( ) const
inline

◆ default_instance()

static const PID& default_instance ( )
inlinestatic

◆ descriptor()

static const ::PROTOBUF_NAMESPACE_ID::Descriptor* descriptor ( )
inlinestatic

◆ GetCachedSize()

int GetCachedSize ( ) const
inlinefinal

◆ GetClassData()

const ::PROTOBUF_NAMESPACE_ID::Message::ClassData* GetClassData ( ) const
final

◆ GetDescriptor()

static const ::PROTOBUF_NAMESPACE_ID::Descriptor* GetDescriptor ( )
inlinestatic

◆ GetMetadata()

::PROTOBUF_NAMESPACE_ID::Metadata GetMetadata ( ) const
final

◆ GetReflection()

static const ::PROTOBUF_NAMESPACE_ID::Reflection* GetReflection ( )
inlinestatic

◆ has_d_gain_optional()

bool has_d_gain_optional ( ) const
inline

◆ has_header()

bool has_header ( ) const
inline

◆ has_i_gain_optional()

bool has_i_gain_optional ( ) const
inline

◆ has_i_max_optional()

bool has_i_max_optional ( ) const
inline

◆ has_i_min_optional()

bool has_i_min_optional ( ) const
inline

◆ has_limit_optional()

bool has_limit_optional ( ) const
inline

◆ has_p_gain_optional()

bool has_p_gain_optional ( ) const
inline

◆ has_target_optional()

bool has_target_optional ( ) const
inline

◆ header()

const ::ignition::msgs::Header & header ( ) const
inline

◆ i_gain()

double i_gain ( ) const
inline

◆ i_gain_optional()

const ::ignition::msgs::Double & i_gain_optional ( ) const
inline

◆ i_max()

double i_max ( ) const
inline

◆ i_max_optional()

const ::ignition::msgs::Double & i_max_optional ( ) const
inline

◆ i_min()

double i_min ( ) const
inline

◆ i_min_optional()

const ::ignition::msgs::Double & i_min_optional ( ) const
inline

◆ internal_default_instance()

static const PID* internal_default_instance ( )
inlinestatic

◆ IsInitialized()

bool IsInitialized ( ) const
final

◆ limit()

double limit ( ) const
inline

◆ limit_optional()

const ::ignition::msgs::Double & limit_optional ( ) const
inline

◆ MergeFrom()

void MergeFrom ( const PID from)

◆ mutable_d_gain_optional()

ignition::msgs::Double * mutable_d_gain_optional ( )
inline

◆ mutable_header()

ignition::msgs::Header * mutable_header ( )
inline

◆ mutable_i_gain_optional()

ignition::msgs::Double * mutable_i_gain_optional ( )
inline

◆ mutable_i_max_optional()

ignition::msgs::Double * mutable_i_max_optional ( )
inline

◆ mutable_i_min_optional()

ignition::msgs::Double * mutable_i_min_optional ( )
inline

◆ mutable_limit_optional()

ignition::msgs::Double * mutable_limit_optional ( )
inline

◆ mutable_p_gain_optional()

ignition::msgs::Double * mutable_p_gain_optional ( )
inline

◆ mutable_target_optional()

ignition::msgs::Double * mutable_target_optional ( )
inline

◆ New()

PID* New ( ::PROTOBUF_NAMESPACE_ID::Arena *  arena = nullptr) const
inlinefinal

◆ operator=() [1/2]

PID& operator= ( const PID from)
inline

◆ operator=() [2/2]

PID& operator= ( PID &&  from)
inlinenoexcept

◆ p_gain()

double p_gain ( ) const
inline

◆ p_gain_optional()

const ::ignition::msgs::Double & p_gain_optional ( ) const
inline

◆ release_d_gain_optional()

ignition::msgs::Double * release_d_gain_optional ( )
inline

◆ release_header()

ignition::msgs::Header * release_header ( )
inline

◆ release_i_gain_optional()

ignition::msgs::Double * release_i_gain_optional ( )
inline

◆ release_i_max_optional()

ignition::msgs::Double * release_i_max_optional ( )
inline

◆ release_i_min_optional()

ignition::msgs::Double * release_i_min_optional ( )
inline

◆ release_limit_optional()

ignition::msgs::Double * release_limit_optional ( )
inline

◆ release_p_gain_optional()

ignition::msgs::Double * release_p_gain_optional ( )
inline

◆ release_target_optional()

ignition::msgs::Double * release_target_optional ( )
inline

◆ set_allocated_d_gain_optional()

void set_allocated_d_gain_optional ( ::ignition::msgs::Double d_gain_optional)
inline

◆ set_allocated_header()

void set_allocated_header ( ::ignition::msgs::Header header)
inline

◆ set_allocated_i_gain_optional()

void set_allocated_i_gain_optional ( ::ignition::msgs::Double i_gain_optional)
inline

◆ set_allocated_i_max_optional()

void set_allocated_i_max_optional ( ::ignition::msgs::Double i_max_optional)
inline

◆ set_allocated_i_min_optional()

void set_allocated_i_min_optional ( ::ignition::msgs::Double i_min_optional)
inline

◆ set_allocated_limit_optional()

void set_allocated_limit_optional ( ::ignition::msgs::Double limit_optional)
inline

◆ set_allocated_p_gain_optional()

void set_allocated_p_gain_optional ( ::ignition::msgs::Double p_gain_optional)
inline

◆ set_allocated_target_optional()

void set_allocated_target_optional ( ::ignition::msgs::Double target_optional)
inline

◆ set_d_gain()

void set_d_gain ( double  value)
inline

◆ set_i_gain()

void set_i_gain ( double  value)
inline

◆ set_i_max()

void set_i_max ( double  value)
inline

◆ set_i_min()

void set_i_min ( double  value)
inline

◆ set_limit()

void set_limit ( double  value)
inline

◆ set_p_gain()

void set_p_gain ( double  value)
inline

◆ set_target()

void set_target ( double  value)
inline

◆ Swap()

void Swap ( PID other)
inline

◆ target()

double target ( ) const
inline

◆ target_optional()

const ::ignition::msgs::Double & target_optional ( ) const
inline

◆ unsafe_arena_release_d_gain_optional()

ignition::msgs::Double * unsafe_arena_release_d_gain_optional ( )
inline

◆ unsafe_arena_release_header()

ignition::msgs::Header * unsafe_arena_release_header ( )
inline

◆ unsafe_arena_release_i_gain_optional()

ignition::msgs::Double * unsafe_arena_release_i_gain_optional ( )
inline

◆ unsafe_arena_release_i_max_optional()

ignition::msgs::Double * unsafe_arena_release_i_max_optional ( )
inline

◆ unsafe_arena_release_i_min_optional()

ignition::msgs::Double * unsafe_arena_release_i_min_optional ( )
inline

◆ unsafe_arena_release_limit_optional()

ignition::msgs::Double * unsafe_arena_release_limit_optional ( )
inline

◆ unsafe_arena_release_p_gain_optional()

ignition::msgs::Double * unsafe_arena_release_p_gain_optional ( )
inline

◆ unsafe_arena_release_target_optional()

ignition::msgs::Double * unsafe_arena_release_target_optional ( )
inline

◆ unsafe_arena_set_allocated_d_gain_optional()

void unsafe_arena_set_allocated_d_gain_optional ( ::ignition::msgs::Double d_gain_optional)
inline

◆ unsafe_arena_set_allocated_header()

void unsafe_arena_set_allocated_header ( ::ignition::msgs::Header header)
inline

◆ unsafe_arena_set_allocated_i_gain_optional()

void unsafe_arena_set_allocated_i_gain_optional ( ::ignition::msgs::Double i_gain_optional)
inline

◆ unsafe_arena_set_allocated_i_max_optional()

void unsafe_arena_set_allocated_i_max_optional ( ::ignition::msgs::Double i_max_optional)
inline

◆ unsafe_arena_set_allocated_i_min_optional()

void unsafe_arena_set_allocated_i_min_optional ( ::ignition::msgs::Double i_min_optional)
inline

◆ unsafe_arena_set_allocated_limit_optional()

void unsafe_arena_set_allocated_limit_optional ( ::ignition::msgs::Double limit_optional)
inline

◆ unsafe_arena_set_allocated_p_gain_optional()

void unsafe_arena_set_allocated_p_gain_optional ( ::ignition::msgs::Double p_gain_optional)
inline

◆ unsafe_arena_set_allocated_target_optional()

void unsafe_arena_set_allocated_target_optional ( ::ignition::msgs::Double target_optional)
inline

◆ UnsafeArenaSwap()

void UnsafeArenaSwap ( PID other)
inline

Member Data Documentation

◆ _class_data_

const ClassData _class_data_
static

◆ kIndexInFileMessages

constexpr int kIndexInFileMessages
staticconstexpr
Initial value:
=
0

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