WPILibC++ 2024.1.1-beta-4
wpi::DynamicStructObject Class Reference

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

#include <wpi/struct/DynamicStruct.h>

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

Additional Inherited Members

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