ORCA: Optimization-based framework for Robotic Control Applications
Public Member Functions | List of all members
orca::common::Parameter< std::shared_ptr< T > > Class Template Reference

#include <ParameterSharedPtr.h>

+ Inheritance diagram for orca::common::Parameter< std::shared_ptr< T > >:
+ Collaboration diagram for orca::common::Parameter< std::shared_ptr< T > >:

Public Member Functions

 Parameter ()
 
 Parameter (const std::shared_ptr< T > &t)
 
bool onLoadFromString (const std::string &s)
 
void print () const
 
bool isSet () const
 
std::shared_ptr< T > & get ()
 
const std::shared_ptr< T > & get () const
 
template<class T2 >
Parameter< std::shared_ptr< T > > & operator= (std::shared_ptr< T2 > val)
 
- Public Member Functions inherited from orca::common::ParameterBase
virtual ~ParameterBase ()
 
bool loadFromString (const std::string &s)
 Load the parameter from a YAML string It calls a callback on success. More...
 
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...
 
- Public Member Functions inherited from orca::common::ParameterData< std::shared_ptr< T > >
 ParameterData ()
 
 ParameterData (const std::shared_ptr< T > &val)
 
 ParameterData (const ParameterData< T2 > &v)
 
virtual ~ParameterData ()
 
std::shared_ptr< T > & get ()
 
const std::shared_ptr< T > & get () const
 
void set (const std::shared_ptr< T > &val)
 
bool isSet () const
 

Additional Inherited Members

- Public Types inherited from orca::common::ParameterBase
using Ptr = std::shared_ptr< ParameterBase >
 

Constructor & Destructor Documentation

template<class T >
orca::common::Parameter< std::shared_ptr< T > >::Parameter ( )
inline
template<class T >
orca::common::Parameter< std::shared_ptr< T > >::Parameter ( const std::shared_ptr< T > &  t)
inline

Member Function Documentation

template<class T >
std::shared_ptr<T>& orca::common::Parameter< std::shared_ptr< T > >::get ( )
inline
template<class T >
const std::shared_ptr<T>& orca::common::Parameter< std::shared_ptr< T > >::get ( ) const
inline
template<class T >
bool orca::common::Parameter< std::shared_ptr< T > >::isSet ( ) const
inlinevirtual
template<class T >
bool orca::common::Parameter< std::shared_ptr< T > >::onLoadFromString ( const std::string &  s)
inlinevirtual
template<class T >
template<class T2 >
Parameter<std::shared_ptr<T> >& orca::common::Parameter< std::shared_ptr< T > >::operator= ( std::shared_ptr< T2 >  val)
inline
template<class T >
void orca::common::Parameter< std::shared_ptr< T > >::print ( ) const
inlinevirtual

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