Ignition Msgs

API Reference

5.8.1

#include <battery_state.pb.h>

Public Types

enum  : int {
  kHeaderFieldNumber = 1 , kVoltageFieldNumber = 2 , kCurrentFieldNumber = 3 , kChargeFieldNumber = 4 ,
  kCapacityFieldNumber = 5 , kPercentageFieldNumber = 6 , kPowerSupplyStatusFieldNumber = 7
}
 
typedef BatteryState_PowerSupplyStatus PowerSupplyStatus
 

Public Member Functions

 BatteryState ()
 
constexpr BatteryState (::PROTOBUF_NAMESPACE_ID::internal::ConstantInitialized)
 
 BatteryState (BatteryState &&from) noexcept
 
 BatteryState (const BatteryState &from)
 
 ~BatteryState () 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
 
double capacity () const
 
double charge () const
 
PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear () final
 
void clear_capacity ()
 
void clear_charge ()
 
void clear_current ()
 
void clear_header ()
 
void clear_percentage ()
 
void clear_power_supply_status ()
 
void clear_voltage ()
 
void CopyFrom (const BatteryState &from)
 
double current () const
 
int GetCachedSize () const final
 
const ::PROTOBUF_NAMESPACE_ID::Message::ClassData * GetClassData () const final
 
::PROTOBUF_NAMESPACE_ID::Metadata GetMetadata () const final
 
bool has_header () const
 
const ::ignition::msgs::Headerheader () const
 
bool IsInitialized () const final
 
void MergeFrom (const BatteryState &from)
 
::ignition::msgs::Headermutable_header ()
 
BatteryStateNew (::PROTOBUF_NAMESPACE_ID::Arena *arena=nullptr) const final
 
BatteryStateoperator= (BatteryState &&from) noexcept
 
BatteryStateoperator= (const BatteryState &from)
 
double percentage () const
 
::ignition::msgs::BatteryState_PowerSupplyStatus power_supply_status () const
 
PROTOBUF_NODISCARD ::ignition::msgs::Headerrelease_header ()
 
void set_allocated_header (::ignition::msgs::Header *header)
 
void set_capacity (double value)
 
void set_charge (double value)
 
void set_current (double value)
 
void set_percentage (double value)
 
void set_power_supply_status (::ignition::msgs::BatteryState_PowerSupplyStatus value)
 
void set_voltage (double value)
 
void Swap (BatteryState *other)
 
::ignition::msgs::Headerunsafe_arena_release_header ()
 
void unsafe_arena_set_allocated_header (::ignition::msgs::Header *header)
 
void UnsafeArenaSwap (BatteryState *other)
 
double voltage () const
 

Static Public Member Functions

static const BatteryStatedefault_instance ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * descriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * GetDescriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Reflection * GetReflection ()
 
static const BatteryStateinternal_default_instance ()
 
static const ::PROTOBUF_NAMESPACE_ID::EnumDescriptor * PowerSupplyStatus_descriptor ()
 
static bool PowerSupplyStatus_IsValid (int value)
 
template<typename T >
static const std::stringPowerSupplyStatus_Name (T enum_t_value)
 
static bool PowerSupplyStatus_Parse (::PROTOBUF_NAMESPACE_ID::ConstStringParam name, PowerSupplyStatus *value)
 

Static Public Attributes

static const ClassData _class_data_
 
static constexpr PowerSupplyStatus CHARGING
 
static constexpr PowerSupplyStatus DISCHARGING
 
static constexpr PowerSupplyStatus FULL
 
static constexpr int kIndexInFileMessages
 
static constexpr PowerSupplyStatus NOT_CHARGING
 
static constexpr int PowerSupplyStatus_ARRAYSIZE
 
static constexpr PowerSupplyStatus PowerSupplyStatus_MAX
 
static constexpr PowerSupplyStatus PowerSupplyStatus_MIN
 
static constexpr PowerSupplyStatus UNKNOWN
 

Protected Member Functions

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

Member Typedef Documentation

◆ PowerSupplyStatus

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : int
Enumerator
kHeaderFieldNumber 
kVoltageFieldNumber 
kCurrentFieldNumber 
kChargeFieldNumber 
kCapacityFieldNumber 
kPercentageFieldNumber 
kPowerSupplyStatusFieldNumber 

Constructor & Destructor Documentation

◆ BatteryState() [1/5]

BatteryState ( )
inline

◆ ~BatteryState()

~BatteryState ( )
override

◆ BatteryState() [2/5]

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

◆ BatteryState() [3/5]

BatteryState ( const BatteryState from)

◆ BatteryState() [4/5]

BatteryState ( BatteryState &&  from)
inlinenoexcept

◆ BatteryState() [5/5]

BatteryState ( ::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

◆ capacity()

double capacity ( ) const
inline

◆ charge()

double charge ( ) const
inline

◆ Clear()

PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear ( )
final

◆ clear_capacity()

void clear_capacity ( )
inline

◆ clear_charge()

void clear_charge ( )
inline

◆ clear_current()

void clear_current ( )
inline

◆ clear_header()

void clear_header ( )

◆ clear_percentage()

void clear_percentage ( )
inline

◆ clear_power_supply_status()

void clear_power_supply_status ( )
inline

◆ clear_voltage()

void clear_voltage ( )
inline

◆ CopyFrom()

void CopyFrom ( const BatteryState from)

◆ current()

double current ( ) const
inline

◆ default_instance()

static const BatteryState& 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_header()

bool has_header ( ) const
inline

◆ header()

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

◆ internal_default_instance()

static const BatteryState* internal_default_instance ( )
inlinestatic

◆ IsInitialized()

bool IsInitialized ( ) const
final

◆ MergeFrom()

void MergeFrom ( const BatteryState from)

◆ mutable_header()

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

◆ New()

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

◆ operator=() [1/2]

BatteryState& operator= ( BatteryState &&  from)
inlinenoexcept

◆ operator=() [2/2]

BatteryState& operator= ( const BatteryState from)
inline

◆ percentage()

double percentage ( ) const
inline

◆ power_supply_status()

ignition::msgs::BatteryState_PowerSupplyStatus power_supply_status ( ) const
inline

◆ PowerSupplyStatus_descriptor()

static const ::PROTOBUF_NAMESPACE_ID::EnumDescriptor* PowerSupplyStatus_descriptor ( )
inlinestatic

◆ PowerSupplyStatus_IsValid()

static bool PowerSupplyStatus_IsValid ( int  value)
inlinestatic

◆ PowerSupplyStatus_Name()

static const std::string& PowerSupplyStatus_Name ( enum_t_value)
inlinestatic

◆ PowerSupplyStatus_Parse()

static bool PowerSupplyStatus_Parse ( ::PROTOBUF_NAMESPACE_ID::ConstStringParam  name,
PowerSupplyStatus value 
)
inlinestatic

◆ release_header()

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

◆ set_allocated_header()

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

◆ set_capacity()

void set_capacity ( double  value)
inline

◆ set_charge()

void set_charge ( double  value)
inline

◆ set_current()

void set_current ( double  value)
inline

◆ set_percentage()

void set_percentage ( double  value)
inline

◆ set_power_supply_status()

void set_power_supply_status ( ::ignition::msgs::BatteryState_PowerSupplyStatus  value)
inline

◆ set_voltage()

void set_voltage ( double  value)
inline

◆ Swap()

void Swap ( BatteryState other)
inline

◆ unsafe_arena_release_header()

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

◆ unsafe_arena_set_allocated_header()

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

◆ UnsafeArenaSwap()

void UnsafeArenaSwap ( BatteryState other)
inline

◆ voltage()

double voltage ( ) const
inline

Member Data Documentation

◆ _class_data_

const ClassData _class_data_
static

◆ CHARGING

constexpr PowerSupplyStatus CHARGING
staticconstexpr
Initial value:
=
@ BatteryState_PowerSupplyStatus_CHARGING
Definition: battery_state.pb.h:84

◆ DISCHARGING

constexpr PowerSupplyStatus DISCHARGING
staticconstexpr
Initial value:
=
@ BatteryState_PowerSupplyStatus_DISCHARGING
Definition: battery_state.pb.h:85

◆ FULL

constexpr PowerSupplyStatus FULL
staticconstexpr
Initial value:
=
@ BatteryState_PowerSupplyStatus_FULL
Definition: battery_state.pb.h:87

◆ kIndexInFileMessages

constexpr int kIndexInFileMessages
staticconstexpr
Initial value:
=
0

◆ NOT_CHARGING

constexpr PowerSupplyStatus NOT_CHARGING
staticconstexpr
Initial value:
=
@ BatteryState_PowerSupplyStatus_NOT_CHARGING
Definition: battery_state.pb.h:86

◆ PowerSupplyStatus_ARRAYSIZE

constexpr int PowerSupplyStatus_ARRAYSIZE
staticconstexpr
Initial value:
=
constexpr int BatteryState_PowerSupplyStatus_PowerSupplyStatus_ARRAYSIZE
Definition: battery_state.pb.h:94

◆ PowerSupplyStatus_MAX

constexpr PowerSupplyStatus PowerSupplyStatus_MAX
staticconstexpr
Initial value:
=
constexpr BatteryState_PowerSupplyStatus BatteryState_PowerSupplyStatus_PowerSupplyStatus_MAX
Definition: battery_state.pb.h:93

◆ PowerSupplyStatus_MIN

constexpr PowerSupplyStatus PowerSupplyStatus_MIN
staticconstexpr
Initial value:
=
constexpr BatteryState_PowerSupplyStatus BatteryState_PowerSupplyStatus_PowerSupplyStatus_MIN
Definition: battery_state.pb.h:92

◆ UNKNOWN

constexpr PowerSupplyStatus UNKNOWN
staticconstexpr
Initial value:
=
@ BatteryState_PowerSupplyStatus_UNKNOWN
Definition: battery_state.pb.h:83

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