YARP
Yet Another Robot Platform
Public Member Functions | List of all members
yarp::manager::Argument Class Reference

Class Argument. More...

#include <yarp/manager/module.h>

Public Member Functions

 Argument (const char *szParam, bool required=false, const char *szDesc=nullptr, bool _switch=false)
 
virtual ~Argument ()
 
void setParam (const char *szParam)
 
void setDefault (const char *szDefault)
 
void setValue (const char *szValue)
 
const char * getDefault ()
 
const char * getParam ()
 
const char * getValue ()
 
const char * getDescription ()
 
bool isSwitch ()
 
bool isRequired ()
 
bool operator== (const Argument &alt) const
 

Detailed Description

Class Argument.

Definition at line 50 of file module.h.

Constructor & Destructor Documentation

◆ Argument()

yarp::manager::Argument::Argument ( const char *  szParam,
bool  required = false,
const char *  szDesc = nullptr,
bool  _switch = false 
)
inline

Definition at line 53 of file module.h.

◆ ~Argument()

virtual yarp::manager::Argument::~Argument ( )
inlinevirtual

Definition at line 62 of file module.h.

Member Function Documentation

◆ getDefault()

const char* yarp::manager::Argument::getDefault ( )
inline

Definition at line 67 of file module.h.

◆ getDescription()

const char* yarp::manager::Argument::getDescription ( )
inline

Definition at line 70 of file module.h.

◆ getParam()

const char* yarp::manager::Argument::getParam ( )
inline

Definition at line 68 of file module.h.

◆ getValue()

const char* yarp::manager::Argument::getValue ( )
inline

Definition at line 69 of file module.h.

◆ isRequired()

bool yarp::manager::Argument::isRequired ( )
inline

Definition at line 72 of file module.h.

◆ isSwitch()

bool yarp::manager::Argument::isSwitch ( )
inline

Definition at line 71 of file module.h.

◆ operator==()

bool yarp::manager::Argument::operator== ( const Argument &  alt) const
inline

Definition at line 73 of file module.h.

◆ setDefault()

void yarp::manager::Argument::setDefault ( const char *  szDefault)
inline

Definition at line 65 of file module.h.

◆ setParam()

void yarp::manager::Argument::setParam ( const char *  szParam)
inline

Definition at line 64 of file module.h.

◆ setValue()

void yarp::manager::Argument::setValue ( const char *  szValue)
inline

Definition at line 66 of file module.h.

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