Ignition Msgs

API Reference

5.8.1

#include <physics.pb.h>

Public Types

enum  : int {
  kSolverTypeFieldNumber = 3 , kProfileNameFieldNumber = 17 , kHeaderFieldNumber = 1 , kGravityFieldNumber = 12 ,
  kMagneticFieldFieldNumber = 18 , kTypeFieldNumber = 2 , kPreconItersFieldNumber = 5 , kMinStepSizeFieldNumber = 4 ,
  kSorFieldNumber = 7 , kCfmFieldNumber = 8 , kErpFieldNumber = 9 , kItersFieldNumber = 6 ,
  kEnablePhysicsFieldNumber = 13 , kContactMaxCorrectingVelFieldNumber = 10 , kContactSurfaceLayerFieldNumber = 11 , kRealTimeFactorFieldNumber = 14 ,
  kRealTimeUpdateRateFieldNumber = 15 , kMaxStepSizeFieldNumber = 16
}
 
typedef Physics_Type Type
 

Public Member Functions

 Physics ()
 
constexpr Physics (::PROTOBUF_NAMESPACE_ID::internal::ConstantInitialized)
 
 Physics (const Physics &from)
 
 Physics (Physics &&from) noexcept
 
 ~Physics () 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 cfm () const
 
PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear () final
 
void clear_cfm ()
 
void clear_contact_max_correcting_vel ()
 
void clear_contact_surface_layer ()
 
void clear_enable_physics ()
 
void clear_erp ()
 
void clear_gravity ()
 
void clear_header ()
 
void clear_iters ()
 
void clear_magnetic_field ()
 
void clear_max_step_size ()
 
void clear_min_step_size ()
 
void clear_precon_iters ()
 
void clear_profile_name ()
 
void clear_real_time_factor ()
 
void clear_real_time_update_rate ()
 
void clear_solver_type ()
 
void clear_sor ()
 
void clear_type ()
 
double contact_max_correcting_vel () const
 
double contact_surface_layer () const
 
void CopyFrom (const Physics &from)
 
bool enable_physics () const
 
double erp () const
 
int GetCachedSize () const final
 
const ::PROTOBUF_NAMESPACE_ID::Message::ClassData * GetClassData () const final
 
::PROTOBUF_NAMESPACE_ID::Metadata GetMetadata () const final
 
const ::ignition::msgs::Vector3dgravity () const
 
bool has_gravity () const
 
bool has_header () const
 
bool has_magnetic_field () const
 
const ::ignition::msgs::Headerheader () const
 
bool IsInitialized () const final
 
int32_t iters () const
 
const ::ignition::msgs::Vector3dmagnetic_field () const
 
double max_step_size () const
 
void MergeFrom (const Physics &from)
 
double min_step_size () const
 
::ignition::msgs::Vector3dmutable_gravity ()
 
::ignition::msgs::Headermutable_header ()
 
::ignition::msgs::Vector3dmutable_magnetic_field ()
 
std::stringmutable_profile_name ()
 
std::stringmutable_solver_type ()
 
PhysicsNew (::PROTOBUF_NAMESPACE_ID::Arena *arena=nullptr) const final
 
Physicsoperator= (const Physics &from)
 
Physicsoperator= (Physics &&from) noexcept
 
int32_t precon_iters () const
 
const std::stringprofile_name () const
 
double real_time_factor () const
 
double real_time_update_rate () const
 
PROTOBUF_NODISCARD ::ignition::msgs::Vector3drelease_gravity ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Headerrelease_header ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Vector3drelease_magnetic_field ()
 
PROTOBUF_NODISCARD std::stringrelease_profile_name ()
 
PROTOBUF_NODISCARD std::stringrelease_solver_type ()
 
void set_allocated_gravity (::ignition::msgs::Vector3d *gravity)
 
void set_allocated_header (::ignition::msgs::Header *header)
 
void set_allocated_magnetic_field (::ignition::msgs::Vector3d *magnetic_field)
 
void set_allocated_profile_name (std::string *profile_name)
 
void set_allocated_solver_type (std::string *solver_type)
 
void set_cfm (double value)
 
void set_contact_max_correcting_vel (double value)
 
void set_contact_surface_layer (double value)
 
void set_enable_physics (bool value)
 
void set_erp (double value)
 
void set_iters (int32_t value)
 
void set_max_step_size (double value)
 
void set_min_step_size (double value)
 
void set_precon_iters (int32_t value)
 
template<typename ArgT0 = const std::string&, typename... ArgT>
void set_profile_name (ArgT0 &&arg0, ArgT... args)
 
template<typename ArgT0 , typename... ArgT>
PROTOBUF_ALWAYS_INLINE void set_profile_name (ArgT0 &&arg0, ArgT... args)
 
void set_real_time_factor (double value)
 
void set_real_time_update_rate (double value)
 
template<typename ArgT0 = const std::string&, typename... ArgT>
void set_solver_type (ArgT0 &&arg0, ArgT... args)
 
template<typename ArgT0 , typename... ArgT>
PROTOBUF_ALWAYS_INLINE void set_solver_type (ArgT0 &&arg0, ArgT... args)
 
void set_sor (double value)
 
void set_type (::ignition::msgs::Physics_Type value)
 
const std::stringsolver_type () const
 
double sor () const
 
void Swap (Physics *other)
 
::ignition::msgs::Physics_Type type () const
 
::ignition::msgs::Vector3dunsafe_arena_release_gravity ()
 
::ignition::msgs::Headerunsafe_arena_release_header ()
 
::ignition::msgs::Vector3dunsafe_arena_release_magnetic_field ()
 
void unsafe_arena_set_allocated_gravity (::ignition::msgs::Vector3d *gravity)
 
void unsafe_arena_set_allocated_header (::ignition::msgs::Header *header)
 
void unsafe_arena_set_allocated_magnetic_field (::ignition::msgs::Vector3d *magnetic_field)
 
void UnsafeArenaSwap (Physics *other)
 

Static Public Member Functions

static const Physicsdefault_instance ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * descriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * GetDescriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Reflection * GetReflection ()
 
static const Physicsinternal_default_instance ()
 
static const ::PROTOBUF_NAMESPACE_ID::EnumDescriptor * Type_descriptor ()
 
static bool Type_IsValid (int value)
 
template<typename T >
static const std::stringType_Name (T enum_t_value)
 
static bool Type_Parse (::PROTOBUF_NAMESPACE_ID::ConstStringParam name, Type *value)
 

Static Public Attributes

static const ClassData _class_data_
 
static constexpr Type BULLET
 
static constexpr Type DART
 
static constexpr int kIndexInFileMessages
 
static constexpr Type ODE
 
static constexpr Type SIMBODY
 
static constexpr int Type_ARRAYSIZE
 
static constexpr Type Type_MAX
 
static constexpr Type Type_MIN
 

Protected Member Functions

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

Member Typedef Documentation

◆ Type

typedef Physics_Type Type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : int
Enumerator
kSolverTypeFieldNumber 
kProfileNameFieldNumber 
kHeaderFieldNumber 
kGravityFieldNumber 
kMagneticFieldFieldNumber 
kTypeFieldNumber 
kPreconItersFieldNumber 
kMinStepSizeFieldNumber 
kSorFieldNumber 
kCfmFieldNumber 
kErpFieldNumber 
kItersFieldNumber 
kEnablePhysicsFieldNumber 
kContactMaxCorrectingVelFieldNumber 
kContactSurfaceLayerFieldNumber 
kRealTimeFactorFieldNumber 
kRealTimeUpdateRateFieldNumber 
kMaxStepSizeFieldNumber 

Constructor & Destructor Documentation

◆ Physics() [1/5]

Physics ( )
inline

◆ ~Physics()

~Physics ( )
override

◆ Physics() [2/5]

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

◆ Physics() [3/5]

Physics ( const Physics from)

◆ Physics() [4/5]

Physics ( Physics &&  from)
inlinenoexcept

◆ Physics() [5/5]

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

◆ cfm()

double cfm ( ) const
inline

◆ Clear()

PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear ( )
final

◆ clear_cfm()

void clear_cfm ( )
inline

◆ clear_contact_max_correcting_vel()

void clear_contact_max_correcting_vel ( )
inline

◆ clear_contact_surface_layer()

void clear_contact_surface_layer ( )
inline

◆ clear_enable_physics()

void clear_enable_physics ( )
inline

◆ clear_erp()

void clear_erp ( )
inline

◆ clear_gravity()

void clear_gravity ( )

◆ clear_header()

void clear_header ( )

◆ clear_iters()

void clear_iters ( )
inline

◆ clear_magnetic_field()

void clear_magnetic_field ( )

◆ clear_max_step_size()

void clear_max_step_size ( )
inline

◆ clear_min_step_size()

void clear_min_step_size ( )
inline

◆ clear_precon_iters()

void clear_precon_iters ( )
inline

◆ clear_profile_name()

void clear_profile_name ( )
inline

◆ clear_real_time_factor()

void clear_real_time_factor ( )
inline

◆ clear_real_time_update_rate()

void clear_real_time_update_rate ( )
inline

◆ clear_solver_type()

void clear_solver_type ( )
inline

◆ clear_sor()

void clear_sor ( )
inline

◆ clear_type()

void clear_type ( )
inline

◆ contact_max_correcting_vel()

double contact_max_correcting_vel ( ) const
inline

◆ contact_surface_layer()

double contact_surface_layer ( ) const
inline

◆ CopyFrom()

void CopyFrom ( const Physics from)

◆ default_instance()

static const Physics& default_instance ( )
inlinestatic

◆ descriptor()

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

◆ enable_physics()

bool enable_physics ( ) const
inline

◆ erp()

double erp ( ) const
inline

◆ 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

◆ gravity()

const ::ignition::msgs::Vector3d & gravity ( ) const
inline

◆ has_gravity()

bool has_gravity ( ) const
inline

◆ has_header()

bool has_header ( ) const
inline

◆ has_magnetic_field()

bool has_magnetic_field ( ) const
inline

◆ header()

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

◆ internal_default_instance()

static const Physics* internal_default_instance ( )
inlinestatic

◆ IsInitialized()

bool IsInitialized ( ) const
final

◆ iters()

int32_t iters ( ) const
inline

◆ magnetic_field()

const ::ignition::msgs::Vector3d & magnetic_field ( ) const
inline

◆ max_step_size()

double max_step_size ( ) const
inline

◆ MergeFrom()

void MergeFrom ( const Physics from)

◆ min_step_size()

double min_step_size ( ) const
inline

◆ mutable_gravity()

ignition::msgs::Vector3d * mutable_gravity ( )
inline

◆ mutable_header()

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

◆ mutable_magnetic_field()

ignition::msgs::Vector3d * mutable_magnetic_field ( )
inline

◆ mutable_profile_name()

std::string * mutable_profile_name ( )
inline

◆ mutable_solver_type()

std::string * mutable_solver_type ( )
inline

◆ New()

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

◆ operator=() [1/2]

Physics& operator= ( const Physics from)
inline

◆ operator=() [2/2]

Physics& operator= ( Physics &&  from)
inlinenoexcept

◆ precon_iters()

int32_t precon_iters ( ) const
inline

◆ profile_name()

const std::string & profile_name ( ) const
inline

◆ real_time_factor()

double real_time_factor ( ) const
inline

◆ real_time_update_rate()

double real_time_update_rate ( ) const
inline

◆ release_gravity()

ignition::msgs::Vector3d * release_gravity ( )
inline

◆ release_header()

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

◆ release_magnetic_field()

ignition::msgs::Vector3d * release_magnetic_field ( )
inline

◆ release_profile_name()

std::string * release_profile_name ( )
inline

◆ release_solver_type()

std::string * release_solver_type ( )
inline

◆ set_allocated_gravity()

void set_allocated_gravity ( ::ignition::msgs::Vector3d gravity)
inline

◆ set_allocated_header()

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

◆ set_allocated_magnetic_field()

void set_allocated_magnetic_field ( ::ignition::msgs::Vector3d magnetic_field)
inline

◆ set_allocated_profile_name()

void set_allocated_profile_name ( std::string profile_name)
inline

◆ set_allocated_solver_type()

void set_allocated_solver_type ( std::string solver_type)
inline

◆ set_cfm()

void set_cfm ( double  value)
inline

◆ set_contact_max_correcting_vel()

void set_contact_max_correcting_vel ( double  value)
inline

◆ set_contact_surface_layer()

void set_contact_surface_layer ( double  value)
inline

◆ set_enable_physics()

void set_enable_physics ( bool  value)
inline

◆ set_erp()

void set_erp ( double  value)
inline

◆ set_iters()

void set_iters ( int32_t  value)
inline

◆ set_max_step_size()

void set_max_step_size ( double  value)
inline

◆ set_min_step_size()

void set_min_step_size ( double  value)
inline

◆ set_precon_iters()

void set_precon_iters ( int32_t  value)
inline

◆ set_profile_name() [1/2]

void set_profile_name ( ArgT0 &&  arg0,
ArgT...  args 
)

◆ set_profile_name() [2/2]

PROTOBUF_ALWAYS_INLINE void set_profile_name ( ArgT0 &&  arg0,
ArgT...  args 
)
inline

◆ set_real_time_factor()

void set_real_time_factor ( double  value)
inline

◆ set_real_time_update_rate()

void set_real_time_update_rate ( double  value)
inline

◆ set_solver_type() [1/2]

void set_solver_type ( ArgT0 &&  arg0,
ArgT...  args 
)

◆ set_solver_type() [2/2]

PROTOBUF_ALWAYS_INLINE void set_solver_type ( ArgT0 &&  arg0,
ArgT...  args 
)
inline

◆ set_sor()

void set_sor ( double  value)
inline

◆ set_type()

void set_type ( ::ignition::msgs::Physics_Type  value)
inline

◆ solver_type()

const std::string & solver_type ( ) const
inline

◆ sor()

double sor ( ) const
inline

◆ Swap()

void Swap ( Physics other)
inline

◆ type()

ignition::msgs::Physics_Type type ( ) const
inline

◆ Type_descriptor()

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

◆ Type_IsValid()

static bool Type_IsValid ( int  value)
inlinestatic

◆ Type_Name()

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

◆ Type_Parse()

static bool Type_Parse ( ::PROTOBUF_NAMESPACE_ID::ConstStringParam  name,
Type value 
)
inlinestatic

◆ unsafe_arena_release_gravity()

ignition::msgs::Vector3d * unsafe_arena_release_gravity ( )
inline

◆ unsafe_arena_release_header()

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

◆ unsafe_arena_release_magnetic_field()

ignition::msgs::Vector3d * unsafe_arena_release_magnetic_field ( )
inline

◆ unsafe_arena_set_allocated_gravity()

void unsafe_arena_set_allocated_gravity ( ::ignition::msgs::Vector3d gravity)
inline

◆ unsafe_arena_set_allocated_header()

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

◆ unsafe_arena_set_allocated_magnetic_field()

void unsafe_arena_set_allocated_magnetic_field ( ::ignition::msgs::Vector3d magnetic_field)
inline

◆ UnsafeArenaSwap()

void UnsafeArenaSwap ( Physics other)
inline

Member Data Documentation

◆ _class_data_

const ClassData _class_data_
static

◆ BULLET

constexpr Type BULLET
staticconstexpr
Initial value:
=
@ Physics_Type_BULLET
Definition: physics.pb.h:85

◆ DART

constexpr Type DART
staticconstexpr
Initial value:
=
@ Physics_Type_DART
Definition: physics.pb.h:87

◆ kIndexInFileMessages

constexpr int kIndexInFileMessages
staticconstexpr
Initial value:
=
0

◆ ODE

constexpr Type ODE
staticconstexpr
Initial value:
=
@ Physics_Type_ODE
Definition: physics.pb.h:84

◆ SIMBODY

constexpr Type SIMBODY
staticconstexpr
Initial value:
=
@ Physics_Type_SIMBODY
Definition: physics.pb.h:86

◆ Type_ARRAYSIZE

constexpr int Type_ARRAYSIZE
staticconstexpr
Initial value:
=
constexpr int Physics_Type_Type_ARRAYSIZE
Definition: physics.pb.h:94

◆ Type_MAX

constexpr Type Type_MAX
staticconstexpr
Initial value:
=
constexpr Physics_Type Physics_Type_Type_MAX
Definition: physics.pb.h:93

◆ Type_MIN

constexpr Type Type_MIN
staticconstexpr
Initial value:
=
constexpr Physics_Type Physics_Type_Type_MIN
Definition: physics.pb.h:92

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