TwiceAsNice  2019-02-18
Classes | Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
basda::pulsegenerator::BasdaServiceWorker Class Reference

This service worker controls PulseGeneratorDevices. More...

#include <BasdaServiceWorker.h>

Inheritance diagram for basda::pulsegenerator::BasdaServiceWorker:
Inheritance graph
Collaboration diagram for basda::pulsegenerator::BasdaServiceWorker:
Collaboration graph

Classes

struct  AsyncDevice
 
struct  Callback
 
struct  PulseGeneratorDevicePtrComparator
 

Public Types

typedef Basda::PulseGeneratorDevicePtr DevicePtr
 
typedef std::set< DevicePtr, PulseGeneratorDevicePtrComparator > DeviceContainer
 
typedef Basda::PulseGeneratorDevicePtr DevicePtr
 
typedef std::set< DevicePtr, PulseGeneratorDevicePtrComparator > DeviceContainer
 

Public Member Functions

 BasdaServiceWorker (const Nice::JointPtr &config, DeviceContainer &devices)
 
virtual ~BasdaServiceWorker ()
 
virtual void init ()
 
virtual void deinit ()
 
virtual void activate ()
 
virtual void deactivate ()
 
virtual void work ()
 
virtual void idleOnline ()
 
virtual void terminate ()
 
 BasdaServiceWorker (const Nice::JointPtr &config, DeviceContainer &devices)
 
virtual ~BasdaServiceWorker ()
 
virtual void init ()
 
virtual void deinit ()
 
virtual void activate ()
 
virtual void deactivate ()
 
virtual void work ()
 
virtual void idleOnline ()
 
virtual void terminate ()
 
- Public Member Functions inherited from Basda::ServiceWorker
const Nice::JointPtr & config ()
 
Nice::JointPtr cfg ()
 
Nice::JointPtr var ()
 
virtual const std::string & name ()
 
virtual WorkerThreadPtr worker ()
 
virtual Nice::Monitor & monitor ()
 
virtual void lock ()
 
virtual void unlock ()
 
bool stateIsSettled ()
 
bool stateHasChanged ()
 
void changeState (Basda::ServiceState _state)
 change state to a new state If the state is the current state, or a negative state, do nothing. Otherwise change the "next" state in the state machine and notify all threads. More...
 
bool tryChangeState (Basda::ServiceState _state, const Nice::Time &_timeout=Nice::Time::seconds(0.0))
 change state to a new state More...
 
void waitForState (Basda::ServiceState _state)
 wait (indefinitely) until the worker has reached a spcifici state More...
 
bool timedWaitForState (Basda::ServiceState _state, const Nice::Time &_timeout)
 wait (indefinitely) until the worker has reached a specific state More...
 
bool changeStateOnlyFromTo (Basda::ServiceState _from, Basda::ServiceState _to)
 wait (indefinitely) until the worker has reached a spcifici state More...
 
Basda::ServiceState state ()
 
Basda::ServiceState stateNow ()
 
Basda::ServiceState stateNext ()
 
Basda::ServiceState stateLast ()
 
bool isTransit ()
 
bool isTerminated ()
 
const Nice::JointPtr & config ()
 
Nice::JointPtr cfg ()
 
Nice::JointPtr var ()
 
virtual const std::string & name ()
 
virtual WorkerThreadPtr worker ()
 
virtual Nice::Monitor & monitor ()
 
virtual void lock ()
 
virtual void unlock ()
 
bool stateIsSettled ()
 
bool stateHasChanged ()
 
void changeState (Basda::ServiceState _state)
 
bool tryChangeState (Basda::ServiceState _state, const Nice::Time &_timeout=Nice::Time::seconds(0.0))
 
void waitForState (Basda::ServiceState _state)
 
bool timedWaitForState (Basda::ServiceState _state, const Nice::Time &_timeout)
 
bool changeStateOnlyFromTo (Basda::ServiceState _from, Basda::ServiceState _to)
 
Basda::ServiceState state ()
 
Basda::ServiceState stateNow ()
 
Basda::ServiceState stateNext ()
 
Basda::ServiceState stateLast ()
 
bool isTransit ()
 
bool isTerminated ()
 

Protected Member Functions

virtual void sleepOnline (const Nice::Time &sleepDuration)
 
virtual void sleepOnline (const Nice::Time &sleepDuration)
 
- Protected Member Functions inherited from Basda::ServiceWorker
 ServiceWorker (const Nice::JointPtr &_jointPtr)
 ctor More...
 
virtual ~ServiceWorker ()
 dtor Does nothing (in this base class) More...
 
void triggerState (const Basda::ServiceStateMachine &_state)
 change state to a new state More...
 
void sendStateStatus (const std::string &_action, int _percent)
 
void setState (Basda::ServiceState _next)
 
virtual void waitForNewState ()
 
virtual bool timedWaitForNewState (const Nice::Time &_timeout)
 
virtual void preinit ()
 
virtual void abort ()
 does nothing. More...
 
virtual void stop ()
 does nothing. More...
 
virtual void packin ()
 schedule ONLINE as the next target state. More...
 
virtual void errorOffline ()
 set the target state to OFFLINE. More...
 
virtual void errorStandby ()
 set the target state to OFFLINE. More...
 
virtual void errorOnline ()
 set the target state to OFFLINE. More...
 
virtual void errorWorking ()
 set the target state to OFFLINE. More...
 
virtual void idleOffline ()
 wait for a state change. More...
 
virtual void idleStandby ()
 wait for a state change. More...
 
 ServiceWorker (const Nice::JointPtr &_jointPtr)
 
virtual ~ServiceWorker ()
 
void triggerState (const Basda::ServiceStateMachine &_state)
 
void sendStateStatus (const std::string &_action, int _percent)
 
void setState (Basda::ServiceState _next)
 
virtual void waitForNewState ()
 
virtual bool timedWaitForNewState (const Nice::Time &_timeout)
 
virtual void preinit ()
 
virtual void abort ()
 
virtual void stop ()
 
virtual void packin ()
 
virtual void errorOffline ()
 
virtual void errorStandby ()
 
virtual void errorOnline ()
 
virtual void errorWorking ()
 
virtual void idleOffline ()
 
virtual void idleStandby ()
 

Private Types

typedef std::vector< AsyncDevice > AsyncDevices
 
typedef std::vector< AsyncDevice > AsyncDevices
 

Private Member Functions

void createWorkIntervalPropertyIfMissing ()
 
void createWorkIntervalPropertyIfMissing ()
 

Private Attributes

AsyncDevices asyncDevices_
 

Additional Inherited Members

- Protected Types inherited from Basda::ServiceWorker
typedef void(ServiceWorker::* ServiceWorkerMemFn) ()
 
typedef Branch BranchTable[6][6]
 
typedef IceUtil::Handle< WorkerThread > WorkerThreadPtr
 
typedef void(ServiceWorker::* ServiceWorkerMemFn) ()
 
typedef Branch BranchTable[6][6]
 
typedef IceUtil::Handle< WorkerThread > WorkerThreadPtr
 
- Protected Attributes inherited from Basda::ServiceWorker
Nice::JointPtr m_config
 
Nice::PropertyPtr m_state
 
std::string m_name
 
- Static Protected Attributes inherited from Basda::ServiceWorker
static BranchTable s_stateTable
 A table which tells which state should go via which intermediate state to a target state. The 6 states are SHUTDOWN, OFFLINE, STANDBY, ONLINE, WORKING and ERROR. The principles are that. More...
 

Detailed Description

This service worker controls PulseGeneratorDevices.

Member Typedef Documentation

◆ AsyncDevices [1/2]

typedef std::vector<AsyncDevice> basda::pulsegenerator::BasdaServiceWorker::AsyncDevices
private

◆ AsyncDevices [2/2]

typedef std::vector<AsyncDevice> basda::pulsegenerator::BasdaServiceWorker::AsyncDevices
private

◆ DeviceContainer [1/2]

typedef std::set<DevicePtr, PulseGeneratorDevicePtrComparator> basda::pulsegenerator::BasdaServiceWorker::DeviceContainer

◆ DeviceContainer [2/2]

typedef std::set<DevicePtr, PulseGeneratorDevicePtrComparator> basda::pulsegenerator::BasdaServiceWorker::DeviceContainer

◆ DevicePtr [1/2]

typedef Basda::PulseGeneratorDevicePtr basda::pulsegenerator::BasdaServiceWorker::DevicePtr

◆ DevicePtr [2/2]

typedef Basda::PulseGeneratorDevicePtr basda::pulsegenerator::BasdaServiceWorker::DevicePtr

Constructor & Destructor Documentation

◆ BasdaServiceWorker() [1/2]

basda::pulsegenerator::BasdaServiceWorker::BasdaServiceWorker ( const Nice::JointPtr &  config,
DeviceContainer &  devices 
)

◆ ~BasdaServiceWorker() [1/2]

basda::pulsegenerator::BasdaServiceWorker::~BasdaServiceWorker ( )
virtual
Note
overridden

◆ BasdaServiceWorker() [2/2]

basda::pulsegenerator::BasdaServiceWorker::BasdaServiceWorker ( const Nice::JointPtr &  config,
DeviceContainer &  devices 
)

◆ ~BasdaServiceWorker() [2/2]

virtual basda::pulsegenerator::BasdaServiceWorker::~BasdaServiceWorker ( )
virtual
Note
overridden

Member Function Documentation

◆ activate() [1/2]

void basda::pulsegenerator::BasdaServiceWorker::activate ( )
virtual
Note
overridden

Implements Basda::ServiceWorker.

◆ activate() [2/2]

virtual void basda::pulsegenerator::BasdaServiceWorker::activate ( )
virtual
Note
overridden

Implements Basda::ServiceWorker.

◆ createWorkIntervalPropertyIfMissing() [1/2]

void basda::pulsegenerator::BasdaServiceWorker::createWorkIntervalPropertyIfMissing ( )
private

◆ createWorkIntervalPropertyIfMissing() [2/2]

void basda::pulsegenerator::BasdaServiceWorker::createWorkIntervalPropertyIfMissing ( )
private

◆ deactivate() [1/2]

void basda::pulsegenerator::BasdaServiceWorker::deactivate ( )
virtual
Note
overridden

Implements Basda::ServiceWorker.

◆ deactivate() [2/2]

virtual void basda::pulsegenerator::BasdaServiceWorker::deactivate ( )
virtual
Note
overridden

Implements Basda::ServiceWorker.

◆ deinit() [1/2]

virtual void basda::pulsegenerator::BasdaServiceWorker::deinit ( )
virtual
Note
overridden

Implements Basda::ServiceWorker.

◆ deinit() [2/2]

void basda::pulsegenerator::BasdaServiceWorker::deinit ( )
virtual
Note
overridden

Implements Basda::ServiceWorker.

◆ idleOnline() [1/2]

void basda::pulsegenerator::BasdaServiceWorker::idleOnline ( )
virtual
Note
overridden

Reimplemented from Basda::ServiceWorker.

◆ idleOnline() [2/2]

virtual void basda::pulsegenerator::BasdaServiceWorker::idleOnline ( )
virtual
Note
overridden

Reimplemented from Basda::ServiceWorker.

◆ init() [1/2]

void basda::pulsegenerator::BasdaServiceWorker::init ( )
virtual
Note
overridden

Implements Basda::ServiceWorker.

◆ init() [2/2]

virtual void basda::pulsegenerator::BasdaServiceWorker::init ( )
virtual
Note
overridden

Implements Basda::ServiceWorker.

◆ sleepOnline() [1/2]

void basda::pulsegenerator::BasdaServiceWorker::sleepOnline ( const Nice::Time &  sleepDuration)
protectedvirtual

Reimplemented in TestableBasdaServiceWorker, and TestableBasdaServiceWorker.

◆ sleepOnline() [2/2]

virtual void basda::pulsegenerator::BasdaServiceWorker::sleepOnline ( const Nice::Time &  sleepDuration)
protectedvirtual

Reimplemented in TestableBasdaServiceWorker, and TestableBasdaServiceWorker.

◆ terminate() [1/2]

virtual void basda::pulsegenerator::BasdaServiceWorker::terminate ( )
virtual
Note
overridden

Reimplemented from Basda::ServiceWorker.

◆ terminate() [2/2]

void basda::pulsegenerator::BasdaServiceWorker::terminate ( )
virtual
Note
overridden

Reimplemented from Basda::ServiceWorker.

◆ work() [1/2]

virtual void basda::pulsegenerator::BasdaServiceWorker::work ( )
virtual
Note
overridden

Implements Basda::ServiceWorker.

◆ work() [2/2]

void basda::pulsegenerator::BasdaServiceWorker::work ( )
virtual
Note
overridden

Implements Basda::ServiceWorker.

Member Data Documentation

◆ asyncDevices_

AsyncDevices basda::pulsegenerator::BasdaServiceWorker::asyncDevices_
private
The documentation for this class was generated from the following files:
Generated on Mon Feb 18 2019 14:14:49 for TwiceAsNice by   doxygen 1.8.14