yaml.h

Go to the documentation of this file.

/* Author: Zachary Kingston */

#ifndef SE2EZ_CORE_YAML_
#define SE2EZ_CORE_YAML_

#include <se2ez/core/class_forward.h>

namespace se2ez
{
    /** \cond IGNORE */
    SE2EZ_CLASS_FORWARD(Robot)
    /** \endcond */

    namespace io
    {
        /** \brief Loads a robot from a YAML file.
         *  \param[in] filename The filename to load.
         *  \return A robot compiled from filename, and a nullptr on failure.
         */
        RobotPtr loadRobot(const std::string &filename);

        /** \brief Loads named robot states from a YAML file.
         *  \param[in, out] robot Robot to load named states into.
         *  \param[in] filename The filename to load.
         *  \return True on success, false on failure.
         */
        bool loadStates(RobotPtr robot, const std::string &filename);
    }  // namespace io
}  // namespace se2ez

#endif