Ignition Msgs

API Reference

5.6.0

#include <pid.pb.h>

Public Member Functions

 PID ()
 
 PID (const PID &from)
 
virtual ~PID ()
 
int ByteSize () const
 
void Clear ()
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void clear_d_gain ()
 
void clear_d_gain_optional ()
 
void clear_header ()
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void clear_i_gain ()
 
void clear_i_gain_optional ()
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void clear_i_max ()
 
void clear_i_max_optional ()
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void clear_i_min ()
 
void clear_i_min_optional ()
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void clear_limit ()
 
void clear_limit_optional ()
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void clear_p_gain ()
 
void clear_p_gain_optional ()
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void clear_target ()
 
void clear_target_optional ()
 
void CopyFrom (const ::google::protobuf::Message &from)
 
void CopyFrom (const PID &from)
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR double d_gain () const
 
const ::ignition::msgs::Doubled_gain_optional () const
 
int GetCachedSize () const
 
::google::protobuf::Metadata GetMetadata () const
 
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
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR double i_gain () const
 
const ::ignition::msgs::Doublei_gain_optional () const
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR double i_max () const
 
const ::ignition::msgs::Doublei_max_optional () const
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR double i_min () const
 
const ::ignition::msgs::Doublei_min_optional () const
 
::google::protobuf::uint8 * InternalSerializeWithCachedSizesToArray (bool deterministic, ::google::protobuf::uint8 *output) const
 
bool IsInitialized () const
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR double limit () const
 
const ::ignition::msgs::Doublelimit_optional () const
 
void MergeFrom (const ::google::protobuf::Message &from)
 
void MergeFrom (const PID &from)
 
bool MergePartialFromCodedStream (::google::protobuf::io::CodedInputStream *input)
 
::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 () const
 
PIDNew (::google::protobuf::Arena *arena) const
 
PIDoperator= (const PID &from)
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR double p_gain () const
 
const ::ignition::msgs::Doublep_gain_optional () const
 
::ignition::msgs::Doublerelease_d_gain_optional ()
 
::ignition::msgs::Headerrelease_header ()
 
::ignition::msgs::Doublerelease_i_gain_optional ()
 
::ignition::msgs::Doublerelease_i_max_optional ()
 
::ignition::msgs::Doublerelease_i_min_optional ()
 
::ignition::msgs::Doublerelease_limit_optional ()
 
::ignition::msgs::Doublerelease_p_gain_optional ()
 
::ignition::msgs::Doublerelease_target_optional ()
 
void SerializeWithCachedSizes (::google::protobuf::io::CodedOutputStream *output) const
 
::google::protobuf::uint8 * SerializeWithCachedSizesToArray (::google::protobuf::uint8 *output) const
 
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)
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void set_d_gain (double value)
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void set_i_gain (double value)
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void set_i_max (double value)
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void set_i_min (double value)
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void set_limit (double value)
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void set_p_gain (double value)
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR void set_target (double value)
 
void Swap (PID *other)
 
GOOGLE_PROTOBUF_DEPRECATED_ATTR double target () const
 
const ::ignition::msgs::Doubletarget_optional () const
 

Static Public Member Functions

static const PIDdefault_instance ()
 
static const ::google::protobuf::Descriptor * descriptor ()
 

Static Public Attributes

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

Friends

void IGNITION_MSGS_VISIBLE protobuf_AddDesc_ignition_2fmsgs_2fpid_2eproto ()
 
void protobuf_AssignDesc_ignition_2fmsgs_2fpid_2eproto ()
 
void protobuf_ShutdownFile_ignition_2fmsgs_2fpid_2eproto ()
 

Constructor & Destructor Documentation

◆ PID() [1/2]

PID ( )

◆ ~PID()

virtual ~PID ( )
virtual

◆ PID() [2/2]

PID ( const PID from)

Member Function Documentation

◆ ByteSize()

int ByteSize ( ) const

◆ Clear()

void Clear ( )

◆ clear_d_gain()

void clear_d_gain ( )
inline

◆ clear_d_gain_optional()

void clear_d_gain_optional ( )
inline

◆ clear_header()

void clear_header ( )
inline

◆ clear_i_gain()

void clear_i_gain ( )
inline

◆ clear_i_gain_optional()

void clear_i_gain_optional ( )
inline

◆ clear_i_max()

void clear_i_max ( )
inline

◆ clear_i_max_optional()

void clear_i_max_optional ( )
inline

◆ clear_i_min()

void clear_i_min ( )
inline

◆ clear_i_min_optional()

void clear_i_min_optional ( )
inline

◆ clear_limit()

void clear_limit ( )
inline

◆ clear_limit_optional()

void clear_limit_optional ( )
inline

◆ clear_p_gain()

void clear_p_gain ( )
inline

◆ clear_p_gain_optional()

void clear_p_gain_optional ( )
inline

◆ clear_target()

void clear_target ( )
inline

◆ clear_target_optional()

void clear_target_optional ( )
inline

◆ CopyFrom() [1/2]

void CopyFrom ( const ::google::protobuf::Message &  from)

◆ CopyFrom() [2/2]

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 ( )
static

◆ descriptor()

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

◆ GetCachedSize()

int GetCachedSize ( ) const
inline

◆ GetMetadata()

::google::protobuf::Metadata GetMetadata ( ) const

◆ 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

◆ InternalSerializeWithCachedSizesToArray()

::google::protobuf::uint8* InternalSerializeWithCachedSizesToArray ( bool  deterministic,
::google::protobuf::uint8 *  output 
) const

◆ IsInitialized()

bool IsInitialized ( ) const

◆ limit()

double limit ( ) const
inline

◆ limit_optional()

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

◆ MergeFrom() [1/2]

void MergeFrom ( const ::google::protobuf::Message &  from)

◆ MergeFrom() [2/2]

void MergeFrom ( const PID from)

◆ MergePartialFromCodedStream()

bool MergePartialFromCodedStream ( ::google::protobuf::io::CodedInputStream *  input)

◆ 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() [1/2]

PID* New ( ) const
inline

References PID::New().

Referenced by PID::New().

◆ New() [2/2]

PID* New ( ::google::protobuf::Arena *  arena) const

◆ operator=()

PID& operator= ( const PID from)
inline

◆ 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

◆ SerializeWithCachedSizes()

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

◆ SerializeWithCachedSizesToArray()

::google::protobuf::uint8* SerializeWithCachedSizesToArray ( ::google::protobuf::uint8 *  output) const
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)

◆ target()

double target ( ) const
inline

◆ target_optional()

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

Friends And Related Function Documentation

◆ protobuf_AddDesc_ignition_2fmsgs_2fpid_2eproto

void IGNITION_MSGS_VISIBLE protobuf_AddDesc_ignition_2fmsgs_2fpid_2eproto ( )
friend

◆ protobuf_AssignDesc_ignition_2fmsgs_2fpid_2eproto

void protobuf_AssignDesc_ignition_2fmsgs_2fpid_2eproto ( )
friend

◆ protobuf_ShutdownFile_ignition_2fmsgs_2fpid_2eproto

void protobuf_ShutdownFile_ignition_2fmsgs_2fpid_2eproto ( )
friend

Member Data Documentation

◆ kDGainFieldNumber

GOOGLE_PROTOBUF_DEPRECATED_ATTR const int kDGainFieldNumber = 5
static

◆ kDGainOptionalFieldNumber

const int kDGainOptionalFieldNumber = 12
static

◆ kHeaderFieldNumber

const int kHeaderFieldNumber = 1
static

◆ kIGainFieldNumber

GOOGLE_PROTOBUF_DEPRECATED_ATTR const int kIGainFieldNumber = 4
static

◆ kIGainOptionalFieldNumber

const int kIGainOptionalFieldNumber = 11
static

◆ kIMaxFieldNumber

GOOGLE_PROTOBUF_DEPRECATED_ATTR const int kIMaxFieldNumber = 6
static

◆ kIMaxOptionalFieldNumber

const int kIMaxOptionalFieldNumber = 13
static

◆ kIMinFieldNumber

GOOGLE_PROTOBUF_DEPRECATED_ATTR const int kIMinFieldNumber = 7
static

◆ kIMinOptionalFieldNumber

const int kIMinOptionalFieldNumber = 14
static

◆ kLimitFieldNumber

GOOGLE_PROTOBUF_DEPRECATED_ATTR const int kLimitFieldNumber = 8
static

◆ kLimitOptionalFieldNumber

const int kLimitOptionalFieldNumber = 15
static

◆ kPGainFieldNumber

GOOGLE_PROTOBUF_DEPRECATED_ATTR const int kPGainFieldNumber = 3
static

◆ kPGainOptionalFieldNumber

const int kPGainOptionalFieldNumber = 10
static

◆ kTargetFieldNumber

GOOGLE_PROTOBUF_DEPRECATED_ATTR const int kTargetFieldNumber = 2
static

◆ kTargetOptionalFieldNumber

const int kTargetOptionalFieldNumber = 9
static

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