WPILibC++ 2027.0.0-alpha-4
Loading...
Searching...
No Matches
wpi::util::DynamicStructObject Class Reference

Dynamic (run-time) mutable access to a serialized raw struct, with internal data storage. More...

#include <wpi/util/struct/DynamicStruct.hpp>

Inheritance diagram for wpi::util::DynamicStructObject:
wpi::util::impl::DSOData wpi::util::MutableDynamicStruct wpi::util::DynamicStruct

Additional Inherited Members

Public Member Functions inherited from wpi::util::MutableDynamicStruct
 MutableDynamicStruct (const StructDescriptor *desc, std::span< uint8_t > data)
 Constructs a new dynamic struct.
std::span< uint8_t > GetData ()
 Gets the serialized data.
void SetData (std::span< const uint8_t > data)
 Overwrites the entire serialized struct by copying data from a span.
void SetBoolField (const StructFieldDescriptor *field, bool value, size_t arrIndex=0)
 Sets the value of a boolean field.
void SetIntField (const StructFieldDescriptor *field, int64_t value, size_t arrIndex=0)
 Sets the value of a signed integer field.
void SetUintField (const StructFieldDescriptor *field, uint64_t value, size_t arrIndex=0)
 Sets the value of an unsigned integer field.
void SetFloatField (const StructFieldDescriptor *field, float value, size_t arrIndex=0)
 Sets the value of a float field.
void SetDoubleField (const StructFieldDescriptor *field, double value, size_t arrIndex=0)
 Sets the value of a double field.
bool SetStringField (const StructFieldDescriptor *field, std::string_view value)
 Sets the value of a char or char array field.
void SetStructField (const StructFieldDescriptor *field, const DynamicStruct &value, size_t arrIndex=0)
 Sets the value of a struct field.
MutableDynamicStruct GetStructField (const StructFieldDescriptor *field, size_t arrIndex=0)
 Gets the value of a struct field.
std::span< const uint8_t > GetData () const
 Gets the serialized data.
DynamicStruct GetStructField (const StructFieldDescriptor *field, size_t arrIndex=0) const
 Gets the value of a struct field.
Public Member Functions inherited from wpi::util::DynamicStruct
 DynamicStruct (const StructDescriptor *desc, std::span< const uint8_t > data)
 Constructs a new dynamic struct.
const StructDescriptorGetDescriptor () const
 Gets the struct descriptor.
std::span< const uint8_t > GetData () const
 Gets the serialized data.
const StructFieldDescriptorFindField (std::string_view name) const
 Gets a struct field descriptor by name.
bool GetBoolField (const StructFieldDescriptor *field, size_t arrIndex=0) const
 Gets the value of a boolean field.
int64_t GetIntField (const StructFieldDescriptor *field, size_t arrIndex=0) const
 Gets the value of a signed integer field.
uint64_t GetUintField (const StructFieldDescriptor *field, size_t arrIndex=0) const
 Gets the value of an unsigned integer field.
float GetFloatField (const StructFieldDescriptor *field, size_t arrIndex=0) const
 Gets the value of a float field.
double GetDoubleField (const StructFieldDescriptor *field, size_t arrIndex=0) const
 Gets the value of a double field.
std::string_view GetStringField (const StructFieldDescriptor *field) const
 Gets the value of a char or char array field.
DynamicStruct GetStructField (const StructFieldDescriptor *field, size_t arrIndex=0) const
 Gets the value of a struct field.
Protected Attributes inherited from wpi::util::DynamicStruct
const StructDescriptorm_desc

Detailed Description

Dynamic (run-time) mutable access to a serialized raw struct, with internal data storage.


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