LocalGuidance
A library that generates velocity references to follow a path.
yaml_tools::YamlNode Class Reference

#include <YamlNode.hpp>

Public Types

using Impl = YAML::Node
 

Public Member Functions

 YamlNode ()=default
 
virtual ~YamlNode ()=default
 
ImplgetImpl ()
 
const ImplgetImpl () const
 
std::string toString () const
 
bool toFile (const std::string &path) const
 
bool IsDefined () const
 
bool IsNull () const
 
bool IsScalar () const
 
bool IsSequence () const
 
bool IsMap () const
 
template<typename T >
YamlNodeoperator= (const T &rhs)
 
bool hasKey (const std::string &key) const
 
bool hasKey (const size_t i) const
 
YamlNode operator[] (const std::string &key)
 
YamlNode operator[] (const std::string &key) const
 
YamlNode operator[] (const size_t i) const
 
size_t size () const
 
template<typename T >
void push_back (const T &rhs)
 
void push_back (const YamlNode &rhs)
 
template<typename T >
const T as () const
 

Static Public Member Functions

static YamlNode FromString (const std::string &string)
 
static YamlNode FromFile (const std::string &path)
 

Protected Member Functions

 YamlNode (const Impl &impl, const std::string &nestedKey)
 

Protected Attributes

Impl impl_
 
std::string nestedKey_
 

Member Typedef Documentation

using yaml_tools::YamlNode::Impl = YAML::Node

Constructor & Destructor Documentation

yaml_tools::YamlNode::YamlNode ( const Impl impl,
const std::string &  nestedKey 
)
protected
yaml_tools::YamlNode::YamlNode ( )
default
virtual yaml_tools::YamlNode::~YamlNode ( )
virtualdefault

Member Function Documentation

template<typename T >
const T yaml_tools::YamlNode::as ( ) const
inline
static YamlNode yaml_tools::YamlNode::FromFile ( const std::string &  path)
static
static YamlNode yaml_tools::YamlNode::FromString ( const std::string &  string)
static
Impl& yaml_tools::YamlNode::getImpl ( )
const Impl& yaml_tools::YamlNode::getImpl ( ) const
bool yaml_tools::YamlNode::hasKey ( const std::string &  key) const
bool yaml_tools::YamlNode::hasKey ( const size_t  i) const
bool yaml_tools::YamlNode::IsDefined ( ) const
inline
bool yaml_tools::YamlNode::IsMap ( ) const
inline
bool yaml_tools::YamlNode::IsNull ( ) const
inline
bool yaml_tools::YamlNode::IsScalar ( ) const
inline
bool yaml_tools::YamlNode::IsSequence ( ) const
inline
template<typename T >
YamlNode& yaml_tools::YamlNode::operator= ( const T &  rhs)
inline
YamlNode yaml_tools::YamlNode::operator[] ( const std::string &  key)
YamlNode yaml_tools::YamlNode::operator[] ( const std::string &  key) const
YamlNode yaml_tools::YamlNode::operator[] ( const size_t  i) const
template<typename T >
void yaml_tools::YamlNode::push_back ( const T &  rhs)
inline
void yaml_tools::YamlNode::push_back ( const YamlNode rhs)
size_t yaml_tools::YamlNode::size ( ) const
bool yaml_tools::YamlNode::toFile ( const std::string &  path) const
std::string yaml_tools::YamlNode::toString ( ) const

Member Data Documentation

Impl yaml_tools::YamlNode::impl_
protected
std::string yaml_tools::YamlNode::nestedKey_
protected

The documentation for this class was generated from the following file: