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

Class Module. More...

#include <yarp/manager/module.h>

+ Inheritance diagram for yarp::manager::Module:

Public Member Functions

 Module ()
 
 Module (const char *szName)
 
 Module (const Module &mod)
 
 ~Module () override
 
Node * clone () override
 
Module & operator= (const Module &rhs)
 
void setName (const char *szName)
 
void setRank (int rank)
 
void setVersion (const char *szVersion)
 
void setDescription (const char *szDesc)
 
void setHost (const char *szHost)
 
void setForced (bool flag)
 
bool setParam (const char *szParam)
 
void setXmlFile (const char *szFilename)
 
void setWorkDir (const char *szWDir)
 
void setStdio (const char *szStdio)
 
void setBroker (const char *szBroker)
 
void setPrefix (const char *szPrefix)
 
void setEnvironment (const char *szEnv)
 
void setBasePrefix (const char *szPrefix)
 
void setNeedDeployer (bool need)
 
void setDisplay (const char *szDisplay)
 
int getRank ()
 
const char * getName ()
 
const char * getVersion ()
 
const char * getDescription ()
 
const char * getHost ()
 
bool getForced ()
 
bool getNeedDeployer ()
 
const char * getParam ()
 
const char * getXmlFile ()
 
const char * getWorkDir ()
 
const char * getStdio ()
 
const char * getBroker ()
 
const char * getPrefix ()
 
const char * getEnvironment ()
 
const char * getBasePrefix ()
 
const char * getDisplay ()
 
int argumentCount ()
 
Argument & getArgumentAt (int index)
 
int outputCount ()
 
OutputData & getOutputAt (int index)
 
int inputCount ()
 
InputData & getInputAt (int index)
 
int resourceCount () const
 
GenericResource & getResourceAt (int index) const
 
void addAuthor (Author &author)
 
int authorCount ()
 
Author & getAuthorAt (int index)
 
bool removeAuthor (Author &author)
 
bool addArgument (Argument &arg)
 
bool removeArgument (Argument &argument)
 
bool addOutput (OutputData &output)
 
bool removeOutput (OutputData &output)
 
bool addInput (InputData &input)
 
bool removeInput (InputData &input)
 
bool addResource (GenericResource &res)
 
bool removeResource (GenericResource &res)
 
void setPostExecWait (double t)
 
double getPostExecWait ()
 
void setPostStopWait (double t)
 
double getPostStopWait ()
 
void clearInputs ()
 
void clearOutputs ()
 
void clearResources ()
 
void setOwner (Node *owner)
 
Node * owner ()
 
void clear ()
 
GraphicModel & getModelBase ()
 
void setModelBase (GraphicModel &mdl)
 
- Public Member Functions inherited from yarp::manager::Node
 Node (NodeType _type)
 
 Node (NodeType _type, const char *szLabel)
 
virtual ~Node ()
 
void setSatisfied (bool sat)
 
bool isSatisfied ()
 
void setVisited (bool vis)
 
bool isVisited ()
 
bool isLeaf ()
 
NodeType getType ()
 
void setLabel (const char *szLabel)
 
const char * getLabel ()
 
int sucCount ()
 
Link & getLinkAt (int index)
 
bool addSuc (Node *node, float weight, bool _virtual=false)
 class Node More...
 
bool removeSuc (Node *node)
 
void removeAllSuc ()
 
bool hasSuc (Node *node)
 
virtual Node * clone ()=0
 
GraphicModel * getModel ()
 
void setModel (GraphicModel *mdl)
 

Friends

class ModuleInterface
 

Detailed Description

Class Module.

Definition at line 99 of file module.h.

Constructor & Destructor Documentation

◆ Module() [1/3]

Module::Module ( )

Definition at line 15 of file module.cpp.

◆ Module() [2/3]

Module::Module ( const char *  szName)

Definition at line 18 of file module.cpp.

◆ Module() [3/3]

Module::Module ( const Module &  mod)

Definition at line 25 of file module.cpp.

◆ ~Module()

Module::~Module ( )
overridedefault

Member Function Documentation

◆ addArgument()

bool Module::addArgument ( Argument &  arg)

Definition at line 82 of file module.cpp.

◆ addAuthor()

void yarp::manager::Module::addAuthor ( Author &  author)
inline

Definition at line 155 of file module.h.

◆ addInput()

bool Module::addInput ( InputData &  input)

Definition at line 121 of file module.cpp.

◆ addOutput()

bool Module::addOutput ( OutputData &  output)

Definition at line 100 of file module.cpp.

◆ addResource()

bool Module::addResource ( GenericResource &  res)

Definition at line 142 of file module.cpp.

◆ argumentCount()

int yarp::manager::Module::argumentCount ( )
inline

Definition at line 146 of file module.h.

◆ authorCount()

int yarp::manager::Module::authorCount ( )
inline

Definition at line 156 of file module.h.

◆ clear()

void Module::clear ( )

Definition at line 222 of file module.cpp.

◆ clearInputs()

void yarp::manager::Module::clearInputs ( )
inline

Definition at line 175 of file module.h.

◆ clearOutputs()

void yarp::manager::Module::clearOutputs ( )
inline

Definition at line 176 of file module.h.

◆ clearResources()

void yarp::manager::Module::clearResources ( )
inline

Definition at line 177 of file module.h.

◆ clone()

Node * Module::clone ( )
overridevirtual

Implements yarp::manager::Node.

Definition at line 75 of file module.cpp.

◆ getArgumentAt()

Argument & yarp::manager::Module::getArgumentAt ( int  index)
inline

Definition at line 147 of file module.h.

◆ getAuthorAt()

Author & yarp::manager::Module::getAuthorAt ( int  index)
inline

Definition at line 157 of file module.h.

◆ getBasePrefix()

const char * yarp::manager::Module::getBasePrefix ( )
inline

Definition at line 142 of file module.h.

◆ getBroker()

const char * yarp::manager::Module::getBroker ( )
inline

Definition at line 139 of file module.h.

◆ getDescription()

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

Definition at line 130 of file module.h.

◆ getDisplay()

const char * yarp::manager::Module::getDisplay ( )
inline

Definition at line 143 of file module.h.

◆ getEnvironment()

const char * yarp::manager::Module::getEnvironment ( )
inline

Definition at line 141 of file module.h.

◆ getForced()

bool yarp::manager::Module::getForced ( )
inline

Definition at line 132 of file module.h.

◆ getHost()

const char * yarp::manager::Module::getHost ( )
inline

Definition at line 131 of file module.h.

◆ getInputAt()

InputData & yarp::manager::Module::getInputAt ( int  index)
inline

Definition at line 151 of file module.h.

◆ getModelBase()

GraphicModel & yarp::manager::Module::getModelBase ( )
inline

Definition at line 186 of file module.h.

◆ getName()

const char * yarp::manager::Module::getName ( )
inline

Definition at line 128 of file module.h.

◆ getNeedDeployer()

bool yarp::manager::Module::getNeedDeployer ( )
inline

Definition at line 133 of file module.h.

◆ getOutputAt()

OutputData & yarp::manager::Module::getOutputAt ( int  index)
inline

Definition at line 149 of file module.h.

◆ getParam()

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

Definition at line 135 of file module.h.

◆ getPostExecWait()

double yarp::manager::Module::getPostExecWait ( )
inline

Definition at line 170 of file module.h.

◆ getPostStopWait()

double yarp::manager::Module::getPostStopWait ( )
inline

Definition at line 172 of file module.h.

◆ getPrefix()

const char * yarp::manager::Module::getPrefix ( )
inline

Definition at line 140 of file module.h.

◆ getRank()

int yarp::manager::Module::getRank ( )
inline

Definition at line 127 of file module.h.

◆ getResourceAt()

GenericResource & yarp::manager::Module::getResourceAt ( int  index) const
inline

Definition at line 153 of file module.h.

◆ getStdio()

const char * yarp::manager::Module::getStdio ( )
inline

Definition at line 138 of file module.h.

◆ getVersion()

const char * yarp::manager::Module::getVersion ( )
inline

Definition at line 129 of file module.h.

◆ getWorkDir()

const char * yarp::manager::Module::getWorkDir ( )
inline

Definition at line 137 of file module.h.

◆ getXmlFile()

const char * yarp::manager::Module::getXmlFile ( )
inline

Definition at line 136 of file module.h.

◆ inputCount()

int yarp::manager::Module::inputCount ( )
inline

Definition at line 150 of file module.h.

◆ operator=()

Module & Module::operator= ( const Module &  rhs)

Definition at line 31 of file module.cpp.

◆ outputCount()

int yarp::manager::Module::outputCount ( )
inline

Definition at line 148 of file module.h.

◆ owner()

Node * yarp::manager::Module::owner ( )
inline

Definition at line 180 of file module.h.

◆ removeArgument()

bool Module::removeArgument ( Argument &  argument)

Definition at line 89 of file module.cpp.

◆ removeAuthor()

bool Module::removeAuthor ( Author &  author)

Definition at line 162 of file module.cpp.

◆ removeInput()

bool Module::removeInput ( InputData &  input)

Definition at line 129 of file module.cpp.

◆ removeOutput()

bool Module::removeOutput ( OutputData &  output)

Definition at line 108 of file module.cpp.

◆ removeResource()

bool Module::removeResource ( GenericResource &  res)

Definition at line 151 of file module.cpp.

◆ resourceCount()

int yarp::manager::Module::resourceCount ( ) const
inline

Definition at line 152 of file module.h.

◆ setBasePrefix()

void yarp::manager::Module::setBasePrefix ( const char *  szPrefix)
inline

Definition at line 123 of file module.h.

◆ setBroker()

void yarp::manager::Module::setBroker ( const char *  szBroker)
inline

Definition at line 120 of file module.h.

◆ setDescription()

void yarp::manager::Module::setDescription ( const char *  szDesc)
inline

Definition at line 112 of file module.h.

◆ setDisplay()

void yarp::manager::Module::setDisplay ( const char *  szDisplay)
inline

Definition at line 125 of file module.h.

◆ setEnvironment()

void yarp::manager::Module::setEnvironment ( const char *  szEnv)
inline

Definition at line 122 of file module.h.

◆ setForced()

void yarp::manager::Module::setForced ( bool  flag)
inline

Definition at line 114 of file module.h.

◆ setHost()

void yarp::manager::Module::setHost ( const char *  szHost)
inline

Definition at line 113 of file module.h.

◆ setModelBase()

void yarp::manager::Module::setModelBase ( GraphicModel &  mdl)
inline

Definition at line 187 of file module.h.

◆ setName()

void yarp::manager::Module::setName ( const char *  szName)
inline

Definition at line 109 of file module.h.

◆ setNeedDeployer()

void yarp::manager::Module::setNeedDeployer ( bool  need)
inline

Definition at line 124 of file module.h.

◆ setOwner()

void yarp::manager::Module::setOwner ( Node *  owner)
inline

Definition at line 179 of file module.h.

◆ setParam()

bool Module::setParam ( const char *  szParam)

Definition at line 254 of file module.cpp.

◆ setPostExecWait()

void yarp::manager::Module::setPostExecWait ( double  t)
inline

Definition at line 169 of file module.h.

◆ setPostStopWait()

void yarp::manager::Module::setPostStopWait ( double  t)
inline

Definition at line 171 of file module.h.

◆ setPrefix()

void yarp::manager::Module::setPrefix ( const char *  szPrefix)
inline

Definition at line 121 of file module.h.

◆ setRank()

void yarp::manager::Module::setRank ( int  rank)
inline

Definition at line 110 of file module.h.

◆ setStdio()

void yarp::manager::Module::setStdio ( const char *  szStdio)
inline

Definition at line 119 of file module.h.

◆ setVersion()

void yarp::manager::Module::setVersion ( const char *  szVersion)
inline

Definition at line 111 of file module.h.

◆ setWorkDir()

void yarp::manager::Module::setWorkDir ( const char *  szWDir)
inline

Definition at line 118 of file module.h.

◆ setXmlFile()

void yarp::manager::Module::setXmlFile ( const char *  szFilename)
inline

Definition at line 117 of file module.h.

Friends And Related Function Documentation

◆ ModuleInterface

friend class ModuleInterface
friend

Definition at line 190 of file module.h.

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