Public Member Functions | List of all members
OCL::OSService Class Reference
Inheritance diagram for OCL::OSService:
Inheritance graph
[legend]

Public Member Functions

int argc (void)
 
std::vector< std::string > argv (void)
 
int execute (const std::string &command)
 
std::string getenv (const std::string &arg)
 
bool isenv (const std::string &arg)
 
int millisleep (unsigned int milliseconds)
 
int nanosleep (unsigned int seconds, unsigned int nanoseconds)
 
 OSService (RTT::TaskContext *parent)
 
bool setenv (const std::string &arg, const std::string &value)
 
int sleep (unsigned int seconds)
 
int usleep (unsigned int microseconds)
 
- Public Member Functions inherited from RTT::Service
bool addLocalOperation (base::OperationBase &op)
 
Operation< Signature > & addOperation (Operation< Signature > &op)
 
Operation< Func > & addOperation (const std::string name, Func *func, ExecutionThread et=ClientThread)
 
Operation< typename internal::GetSignature< Func >::Signature > & addOperation (const std::string name, Func func, Class *obj, ExecutionThread et=ClientThread)
 
Operation< typename internal::GetSignatureDS< Func >::Signature > & addOperationDS (const std::string &name, Func func, internal::DataSource< boost::shared_ptr< ObjT > > *sp, ExecutionThread et=ClientThread)
 
Operation< Signature > & addOperationDS (internal::DataSource< boost::shared_ptr< ObjT > > *sp, Operation< Signature > &op)
 
virtual bool addService (shared_ptr obj)
 
Operation< Signature > & addSynchronousOperation (Operation< Signature > &op)
 
Operation< typename internal::GetSignature< Func >::Signature > & addSynchronousOperation (const std::string name, Func func, Class *obj, ExecutionThread et=ClientThread)
 
void clear ()
 
internal::OperationCallerC create (std::string name, ExecutionEngine *caller)
 
const std::string & doc () const
 
void doc (const std::string &description)
 
boost::shared_ptr< base::DisposableInterface > getLocalOperation (std::string name)
 
const std::string & getName () const
 
OperationInterfacePart * getOperation (std::string name)
 
base::DataSourceBase::shared_ptr getOperation (std::string name, const std::vector< base::DataSourceBase::shared_ptr > &args, ExecutionEngine *caller) const
 
std::vector< std::string > getOperationNames () const
 
TaskContext * getOwner () const
 
ExecutionEngine * getOwnerExecutionEngine () const
 
shared_ptr getParent () const
 
virtual ProviderNames getProviderNames () const
 
shared_ptr getService (const std::string &service_name)
 
bool hasOperation (const std::string &name) const
 
bool hasService (const std::string &service_name)
 
Service::shared_ptr provides (const std::string &service_name)
 
Service::shared_ptr provides ()
 
void removeOperation (const std::string &name)
 
virtual void removeService (std::string const &service_name)
 
bool resetOperation (std::string name, base::OperationBase *impl)
 
 Service (const std::string &name, TaskContext *owner=0)
 
void setName (const std::string &name)
 
bool setOperationThread (std::string const &name, ExecutionThread et)
 
void setOwner (TaskContext *new_owner)
 
void setParent (shared_ptr new_parent)
 
virtual ~Service ()
 
- Public Member Functions inherited from RTT::OperationInterface
void add (const std::string &name, OperationInterfacePart *part)
 
void clear ()
 
Descriptions getArgumentList (const std::string &name) const
 
int getArity (const std::string &name) const
 
int getCollectArity (const std::string &name) const
 
std::string getDescription (const std::string &name) const
 
std::vector< std::string > getNames () const
 
OperationInterfacePart * getPart (const std::string &name)
 
std::string getResultType (const std::string &name) const
 
bool hasMember (const std::string &name) const
 
bool isSynchronous (const std::string &name) const
 
base::DataSourceBase::shared_ptr produce (const std::string &name, const Arguments &args, ExecutionEngine *caller) const
 
base::DataSourceBase::shared_ptr produceCollect (const std::string &name, const Arguments &args, internal::DataSource< bool >::shared_ptr blocking) const
 
base::DataSourceBase::shared_ptr produceHandle (const std::string &name) const
 
base::DataSourceBase::shared_ptr produceSend (const std::string &name, const Arguments &args, ExecutionEngine *caller) const
 
void remove (const std::string &name)
 
- Public Member Functions inherited from RTT::ConfigurationInterface
bool addAttribute (const std::string &name, T &attr)
 
Attribute< T > & addAttribute (const std::string &name, Attribute< T > &attr)
 
bool addAttribute (base::AttributeBase &a)
 
bool addConstant (const std::string &name, const T &cnst)
 
Constant< T > & addConstant (const std::string &name, Constant< T > &cnst)
 
bool addConstant (base::AttributeBase &c)
 
Property< T > & addProperty (const std::string &name, Property< T > &prop)
 
bool addProperty (base::PropertyBase &pb)
 
Property< T > & addProperty (const std::string &name, T &prop)
 
void clear ()
 
 ConfigurationInterface ()
 
ConfigurationInterface * copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &repl, bool instantiate) const
 
base::AttributeBase * getAttribute (const std::string &name) const
 
AttributeNames getAttributeNames () const
 
base::AttributeBase * getConstant (const std::string &name) const
 
base::PropertyBase * getProperty (const std::string &name) const
 
base::AttributeBase * getValue (const std::string &name) const
 
AttributeObjects const & getValues () const
 
bool hasAttribute (const std::string &name) const
 
bool hasProperty (const std::string &name) const
 
void loadValues (AttributeObjects const &new_values)
 
PropertyBag * properties ()
 
void removeAttribute (const std::string &name)
 
bool removeProperty (base::PropertyBase &p)
 
bool removeValue (const std::string &name)
 
bool setValue (base::AttributeBase *ab)
 
 ~ConfigurationInterface ()
 
- Public Member Functions inherited from RTT::DataFlowInterface
base::InputPortInterface & addEventPort (const std::string &name, base::InputPortInterface &port, SlotFunction callback=SlotFunction())
 
base::InputPortInterface & addEventPort (base::InputPortInterface &port, SlotFunction callback=SlotFunction())
 
base::InputPortInterface & addLocalEventPort (base::InputPortInterface &port, SlotFunction callback=SlotFunction())
 
base::PortInterface & addLocalPort (base::PortInterface &port)
 
base::PortInterface & addPort (const std::string &name, base::PortInterface &port)
 
base::PortInterface & addPort (base::PortInterface &port)
 
void clear ()
 
 DataFlowInterface (Service *parent=0)
 
void dataOnPort (base::PortInterface *port)
 
TaskContext * getOwner () const
 
base::PortInterface * getPort (const std::string &name) const
 
std::string getPortDescription (const std::string &name) const
 
PortNames getPortNames () const
 
Ports getPorts () const
 
Type * getPortType (const std::string &name)
 
Service * getService () const
 
void removeLocalPort (const std::string &name)
 
void removePort (const std::string &name)
 
bool setPortDescription (const std::string &name, const std::string description)
 
 ~DataFlowInterface ()
 

Additional Inherited Members

- Public Types inherited from RTT::Service
typedef OperationInterface Factory
 
typedef std::vector< std::string > ProviderNames
 
typedef boost::shared_ptr< const Service > shared_constptr
 
typedef boost::shared_ptr< Service > shared_ptr
 
- Public Types inherited from RTT::OperationInterface
typedef std::vector< base::DataSourceBase::shared_ptr > Arguments
 
typedef std::vector< ArgumentDescription > Descriptions
 
- Public Types inherited from RTT::ConfigurationInterface
typedef std::vector< std::string > AttributeNames
 
typedef std::vector< base::AttributeBase * > AttributeObjects
 
- Public Types inherited from RTT::DataFlowInterface
typedef std::vector< std::string > PortNames
 
typedef std::vector< base::PortInterface * > Ports
 
typedef boost::function< void(base::PortInterface *)> SlotFunction
 
- Static Public Member Functions inherited from RTT::Service
static Service::shared_ptr Create (const std::string &name, TaskContext *owner=0)
 
- Protected Types inherited from RTT::Service
typedef std::vector< base::OperationBase * > OperationList
 
typedef std::map< std::string, shared_ptr > Services
 
typedef std::map< std::string, base::OperationBase * > SimpleOperations
 
- Protected Types inherited from RTT::OperationInterface
typedef std::map< std::string, OperationInterfacePart * > map_t
 
- Protected Types inherited from RTT::ConfigurationInterface
typedef std::vector< base::AttributeBase * > map_t
 
- Protected Member Functions inherited from RTT::Service
bool testOperation (base::OperationBase &op)
 
- Protected Member Functions inherited from RTT::ConfigurationInterface
bool chkPtr (const std::string &where, const std::string &name, const void *ptr)
 
- Protected Member Functions inherited from RTT::DataFlowInterface
bool chkPtr (const std::string &where, const std::string &name, const void *ptr)
 
Service * createPortObject (const std::string &name)
 
- Protected Attributes inherited from RTT::Service
std::string mdescription
 
std::string mname
 
TaskContext * mowner
 
OperationList ownedoperations
 
shared_ptr parent
 
Services services
 
SimpleOperations simpleoperations
 
- Protected Attributes inherited from RTT::OperationInterface
map_t data
 
- Protected Attributes inherited from RTT::ConfigurationInterface
PropertyBag bag
 
map_t values
 
- Protected Attributes inherited from RTT::DataFlowInterface
Ports mports
 
Service * mservice
 

Detailed Description

A service that provides access to some useful Operating System functions. Can be loaded in scripts by writing 'requires("os")' on top of the file.

Definition at line 67 of file OSService.cpp.

Constructor & Destructor Documentation

OCL::OSService::OSService ( RTT::TaskContext *  parent)
inline

Definition at line 70 of file OSService.cpp.

Member Function Documentation

int OCL::OSService::argc ( void  )
inline

Definition at line 98 of file OSService.cpp.

std::vector<std::string> OCL::OSService::argv ( void  )
inline

Definition at line 103 of file OSService.cpp.

int OCL::OSService::execute ( const std::string &  command)
inline

Definition at line 160 of file OSService.cpp.

std::string OCL::OSService::getenv ( const std::string &  arg)
inline

Definition at line 113 of file OSService.cpp.

bool OCL::OSService::isenv ( const std::string &  arg)
inline

Definition at line 118 of file OSService.cpp.

int OCL::OSService::millisleep ( unsigned int  milliseconds)
inline

Definition at line 136 of file OSService.cpp.

int OCL::OSService::nanosleep ( unsigned int  seconds,
unsigned int  nanoseconds 
)
inline

Definition at line 152 of file OSService.cpp.

bool OCL::OSService::setenv ( const std::string &  arg,
const std::string &  value 
)
inline

Definition at line 123 of file OSService.cpp.

int OCL::OSService::sleep ( unsigned int  seconds)
inline

Definition at line 128 of file OSService.cpp.

int OCL::OSService::usleep ( unsigned int  microseconds)
inline

Definition at line 144 of file OSService.cpp.

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

ocl
Author(s): OCL Development Team
autogenerated on Mon Mar 23 2020 04:47:20