ORCA: Optimization-based framework for Robotic Control Applications
Public Types | Public Member Functions | Protected Member Functions | List of all members
orca::common::ParameterBase Class Referenceabstract

ParameterBase is the public interface to any parameter. More...

#include <ParameterBase.h>

+ Inheritance diagram for orca::common::ParameterBase:

Public Types

using Ptr = std::shared_ptr< ParameterBase >
 

Public Member Functions

virtual ~ParameterBase ()
 
bool loadFromString (const std::string &s)
 Load the parameter from a YAML string It calls a callback on success. More...
 
virtual void print () const =0
 
virtual bool isSet () const =0
 
const std::string & getName () const
 
void setName (const std::string &name)
 
void setRequired (bool is_required)
 
bool isRequired () const
 
void onSuccess (std::function< void(void)> f)
 The callback called if loadFromString is successful. More...
 

Protected Member Functions

virtual bool onLoadFromString (const std::string &s)=0
 

Detailed Description

ParameterBase is the public interface to any parameter.

Member Typedef Documentation

Constructor & Destructor Documentation

virtual orca::common::ParameterBase::~ParameterBase ( )
inlinevirtual

Member Function Documentation

const std::string& orca::common::ParameterBase::getName ( ) const
inline
bool orca::common::ParameterBase::isRequired ( ) const
inline
virtual bool orca::common::ParameterBase::isSet ( ) const
pure virtual
bool orca::common::ParameterBase::loadFromString ( const std::string &  s)
inline

Load the parameter from a YAML string It calls a callback on success.

virtual bool orca::common::ParameterBase::onLoadFromString ( const std::string &  s)
protectedpure virtual
void orca::common::ParameterBase::onSuccess ( std::function< void(void)>  f)
inline

The callback called if loadFromString is successful.

virtual void orca::common::ParameterBase::print ( ) const
pure virtual
void orca::common::ParameterBase::setName ( const std::string &  name)
inline
void orca::common::ParameterBase::setRequired ( bool  is_required)
inline

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