robometry/BufferConfig.h file

Namespaces

namespace robometry

Classes

struct robometry::ChannelInfo
Struct representing a channel(variable) in terms of name and dimensions and names of the each element of a variable.
struct robometry::BufferConfig
Struct containing the parameters for configuring a robometry::BufferManager.

Typedefs

using dimensions_t = std::vector<size_t>
using elements_names_t = std::vector<std::string>

Functions

auto bufferConfigFromJson(robometry::BufferConfig& bufferConfig, const std::string& config_filename) -> bool
Populate the robometry::BufferConfig struct reading from a json file.
auto bufferConfigToJson(const robometry::BufferConfig& bufferConfig, const std::string& config_filename) -> bool
Save on a json file the content of a robometry::BufferConfig struct.

Function documentation

bool bufferConfigFromJson(robometry::BufferConfig& bufferConfig, const std::string& config_filename)

Populate the robometry::BufferConfig struct reading from a json file.

Parameters
bufferConfig out The struct to be filled in.
config_filename in The name of the json file.
Returns true on success, false otherwise.

bool bufferConfigToJson(const robometry::BufferConfig& bufferConfig, const std::string& config_filename)

Save on a json file the content of a robometry::BufferConfig struct.

Parameters
bufferConfig in The struct to be saved to file.
config_filename in The name of the json file to be saved.
Returns true on success, false otherwise.