| RMVL 2.3.0 Robotic Manipulation and Vision Library

载入中...
搜索中...
未找到
Public 成员函数 | Public 属性 | 所有成员列表
rm::para::IoParam类 参考
参数模块 » io 的参数模块

IoParam 参数模块 更多...

`#include <rmvlpara/io.hpp>`

rm::para::IoParam 的协作图:

## Public 成员函数
| IoParam ()=default
| 创建 IoParam 参数对象
bool | read (const std::string &path)
| 从指定 `YAML` 文件中加载，并读取至 `IoParam` 中
bool | write (const std::string &path) const
| 将 `IoParam` 的数据写入指定的 `YAML` 文件中

## Public 属性
int | MQ_MAX_MSG = 10
| 队列最大消息数
int | MQ_MSG_SIZE = 4096
| 每条消息最大字节数，不超过 4096

## 详细描述

IoParam 参数模块

## 构造及析构函数说明

## ◆ IoParam()

rm::para::IoParam::IoParam | ( |  | ) |
| default

创建 IoParam 参数对象

警告
  不建议手动创建对象

## 成员函数说明

## ◆ read()

bool rm::para::IoParam::read | ( | const std::string & | path | ) |

从指定 `YAML` 文件中加载，并读取至 `IoParam` 中

注解
  `YAML` 文件的后缀允许是 `*.yml` 和 `*.yaml`

参数

  [in] | path | 参数路径

返回
  是否读取成功

## ◆ write()

bool rm::para::IoParam::write | ( | const std::string & | path | ) | const

将 `IoParam` 的数据写入指定的 `YAML` 文件中

注解
  `YAML` 文件的后缀允许是 `*.yml` 和 `*.yaml`

参数

  [in] | path | 参数路径

返回
  是否写入成功

## 类成员变量说明

## ◆ MQ_MAX_MSG

int rm::para::IoParam::MQ_MAX_MSG = 10

队列最大消息数

默认值：`10`

## ◆ MQ_MSG_SIZE

int rm::para::IoParam::MQ_MSG_SIZE = 4096

每条消息最大字节数，不超过 4096

默认值：`4096`

该类的文档由以下文件生成:

- rmvlpara/io.hpp