Class yaml_cref

Defined in File yaml.h

Class Documentation

class yaml_cref

Non-owning const reference into a yaml tree node. Returned by const yaml::operator[]. Implicitly converts to yaml (deep copy).

Note

[New in MRPT 3.x]

Public Types

using node_t = yaml::node_t 

using scalar_t = yaml::scalar_t 

using sequence_t = yaml::sequence_t 

using map_t = yaml::map_t 

Public Functions

yaml_cref() = delete

inline explicit yaml_cref(const node_t &n)

inline yaml_cref(const yaml_ref &r)

inline operator yaml() const

inline const node_t &node() const

inline bool isNullNode() const

inline bool isScalar() const

inline bool isMap() const

inline bool isSequence() const

inline std::string typeName() const

template<typename T> inline T as() const

inline size_t size() const

inline bool has(const std::string &key) const

template<typename MATRIX> inline void toMatrix(MATRIX &m) const

template<typename Scalar> inline std::vector<Scalar> toStdVector() const

inline const sequence_t &asSequence() const

inline const map_t &asMap() const

inline map_t asMapRange() const

inline const scalar_t &asScalar() const

inline yaml_cref operator()(int index) const

inline bool hasComment() const

inline bool hasComment(CommentPosition pos) const

inline const std::string &comment() const

inline const std::string &comment(CommentPosition pos) const

inline void printAsYAML(std::ostream &o, const YamlEmitOptions &eo = {}) const

yaml_cref operator[](const std::string &key) const

yaml_cref operator[](const char *key) const

yaml_cref operator[](int index) const

inline const std::type_info &scalarType() const

template<typename T> inline const T &asRef() const

inline operator bool() const

inline operator double() const

inline operator float() const

inline operator int8_t() const

inline operator uint8_t() const

inline operator int16_t() const

inline operator uint16_t() const

inline operator int32_t() const

inline operator uint32_t() const

inline operator int64_t() const

inline operator uint64_t() const

inline operator std::string() const