File reference_frame.hpp

Types used across the API - reference frame.

Functions

static inline std::ostream &operator<<(std::ostream &os, const ReferenceFrame &obj)

namespace slamcore

Helper conversion methods

slamcore::ImageFormat \(\leftrightarrow\) BytesPerChannel

Client-library related getter methods

Get information about the client library

Functions

static inline std::ostream &operator<<(std::ostream &os, const ReferenceFrame &obj)

class ReferenceFrame

#include <reference_frame.hpp>

Represent a coordinate system frame of reference

Public Functions

inline constexpr ReferenceFrame()

inline constexpr ReferenceFrame(ReferenceFrameCategory cat, SensorIndexT index)

inline bool operator==(const ReferenceFrame &other) const

inline bool operator!=(const ReferenceFrame &other) const

inline bool operator<(const ReferenceFrame &other) const

inline bool isUnknown() const

Check if the reference frame is of an unknown type.

inline std::string name() const

Get a string representation of the reference frame.

inline ReferenceFrameCategory category() const

Get the reference frame category

inline SensorIndexT index() const

Get the reference frame index

inline void set(ReferenceFrameCategory category)

Set the reference frame category.

Parameters

category – The new category

inline void set(SensorIndexT index)

Set the reference frame index.

Parameters

index – The new index

Private Members

ReferenceFrameCategory m_category

SensorIndexT m_index

namespace std

Includes items that closely relate to std types