| OrbbecSDK 1.5.7 OrbbecSDK: Software-Development-Kit for Orbbec 3D-Sensor devices

- 首页
- 命名空间
- 类
- 文件

- 类列表
- 类索引
- 类继承关系
- 类成员

Public 成员函数 | Protected 属性 | 友元 | 所有成员列表
ob::Frame类 参考

`#include <Frame.hpp>`

类 ob::Frame 继承关系图:

## Public 成员函数
| Frame (std::unique_ptr< FrameImpl > impl)
| Frame (Frame &frame)
virtual | ~Frame () noexcept
virtual OBFrameType | type ()
| 获取帧的类型 更多...
virtual OBFormat | format ()
| 获取帧的格式 更多...
virtual uint64_t | index ()
| 获取帧的序号 更多...
virtual void * | data ()
| 获取帧数据 更多...
virtual uint32_t | dataSize ()
| 获取帧数据大小 更多...
uint64_t | timeStamp ()
| 获取帧的硬件时间戳 更多...
uint64_t | timeStampUs ()
| 获取帧的硬件时间戳 更多...
uint64_t | systemTimeStamp ()
| 获取帧的系统时间戳 更多...
template<typename T >
bool | is ()
| 检查帧对象的运行时类型是否与给定类型兼容 更多...
template<typename T >
std::shared_ptr< T > | as ()
| 帧对象类型转换 更多...

## Protected 属性
std::unique_ptr< FrameImpl > | impl_

## 友元
class | Filter
class | Recorder
class | FrameHelper

## 详细描述

在文件 Frame.hpp 第 45 行定义.

## 构造及析构函数说明

ob::Frame::Frame | ( | std::unique_ptr< FrameImpl > | impl | ) |

ob::Frame::Frame | ( | Frame & | frame | ) |

virtual ob::Frame::~Frame | ( |  | ) |
| virtual noexcept

## 成员函数说明

virtual OBFrameType ob::Frame::type | ( |  | ) |
| virtual

获取帧的类型

返回
  OBFrameType 返回帧的类型

virtual OBFormat ob::Frame::format | ( |  | ) |
| virtual

获取帧的格式

返回
  OBFormat 返回帧的格式

virtual uint64_t ob::Frame::index | ( |  | ) |
| virtual

获取帧的序号

返回
  uint64_t 返回帧的序号

virtual void* ob::Frame::data | ( |  | ) |
| virtual

获取帧数据

返回
  void* 返回帧数据

virtual uint32_t ob::Frame::dataSize | ( |  | ) |
| virtual

获取帧数据大小

返回
  uint32_t 返回帧数据的大小 如果是点云数据返回的是所有点集合占的字节数，若需要求出点的个数需要将dataSize除以对应的点类型的结构体大小

uint64_t ob::Frame::timeStamp | ( |  | ) |

获取帧的硬件时间戳

返回
  uint64_t 返回帧硬件的时间戳

uint64_t ob::Frame::timeStampUs | ( |  | ) |

获取帧的硬件时间戳

返回
  uint64_t 返回帧硬件的时间戳

uint64_t ob::Frame::systemTimeStamp | ( |  | ) |

获取帧的系统时间戳

返回
  uint64_t 返回帧的系统时间戳

template<typename T >

bool ob::Frame::is | ( |  | ) |

检查帧对象的运行时类型是否与给定类型兼容

模板参数

  T | 给定的类型

返回
  bool 返回结果

在文件 Frame.hpp 第 547 行定义.

template<typename T >

std::shared_ptr<T> ob::Frame::as | ( |  | ) |
| inline

帧对象类型转换

模板参数

  T | 目标类型

返回
  std::shared_ptr<T> 返回结果, 如果不能够转换，将抛异常

在文件 Frame.hpp 第 188 行定义.

## 友元及相关函数文档

friend class Filter
| friend

在文件 Frame.hpp 第 196 行定义.

friend class Recorder
| friend

在文件 Frame.hpp 第 197 行定义.

friend class FrameHelper
| friend

在文件 Frame.hpp 第 198 行定义.

## 类成员变量说明

std::unique_ptr<FrameImpl> ob::Frame::impl_
| protected

在文件 Frame.hpp 第 47 行定义.

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

- /root/libobsensor/include/libobsensor/hpp/Frame.hpp