Cypress  1.0
C++ Spiking Neural Network Simulation Framework
Public Member Functions | List of all members
cypress::PowerDevice Class Referenceabstract

#include <power.hpp>

Inheritance diagram for cypress::PowerDevice:
Inheritance graph
[legend]

Public Member Functions

virtual ~PowerDevice ()
 
virtual bool has_config ()=0
 
virtual bool state (const std::string &device)=0
 
virtual bool switch_on (const std::string &device)=0
 
virtual bool switch_off (const std::string &device)=0
 

Detailed Description

Abstract base class used to represent an device which is capable of switching a power device.

Constructor & Destructor Documentation

virtual cypress::PowerDevice::~PowerDevice ( )
inlinevirtual

Member Function Documentation

virtual bool cypress::PowerDevice::has_config ( )
pure virtual

Implemented in cypress::NetIO4, and cypress::energenie.

virtual bool cypress::PowerDevice::state ( const std::string &  device)
pure virtual

Returns the state of the device with the given name. If the device cannot be controlled, false should be returned.

Parameters
deviceis the canonical backend name (returned by backend.name()) of the device for which the state should be returned.
Returns
true if the device is currently switched on, false in all other cases.

Implemented in cypress::NetIO4, and cypress::energenie.

virtual bool cypress::PowerDevice::switch_off ( const std::string &  device)
pure virtual

Switches the device with teh given name off.

Parameters
deviceis the canonical backend name (returned by backend.name()) of the device that should be controlled.
Returns
true if the operation was successful, false otherwise.

Implemented in cypress::NetIO4, and cypress::energenie.

virtual bool cypress::PowerDevice::switch_on ( const std::string &  device)
pure virtual

Switches the device with teh given name on.

Parameters
deviceis the canonical backend name (returned by backend.name()) of the device that should be controlled.
Returns
true if the operation was successful, false otherwise.

Implemented in cypress::NetIO4, and cypress::energenie.


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