TwiceAsNice  2019-02-18
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
basda::PlinkPowerMeterDevice Class Reference

#include <PlinkPowerMeterDevice.hpp>

Inheritance diagram for basda::PlinkPowerMeterDevice:
Inheritance graph
Collaboration diagram for basda::PlinkPowerMeterDevice:
Collaboration graph

Public Member Functions

 PlinkPowerMeterDevice (const Nice::JointPtr &_config)
 
virtual ~PlinkPowerMeterDevice ()
 
virtual void open ()
 
virtual void close ()
 
virtual void reset (Basda::DeviceAsync &)
 
virtual void version ()
 
virtual void init (Basda::DeviceAsync &)
 
virtual void deinit (Basda::DeviceAsync &)
 
virtual void activate (Basda::DeviceAsync &)
 
virtual void deactivate (Basda::DeviceAsync &)
 
virtual void measure ()
 
virtual Basda::PowerPtr getMeasuredPower ()
 
virtual bool isReachable ()
 
virtual void checkReachability ()
 
 PlinkPowerMeterDevice (const Nice::JointPtr &_config)
 
virtual ~PlinkPowerMeterDevice ()
 
virtual void open ()
 
virtual void close ()
 
virtual void reset (Basda::DeviceAsync &)
 
virtual void version ()
 
virtual void init (Basda::DeviceAsync &)
 
virtual void deinit (Basda::DeviceAsync &)
 
virtual void activate (Basda::DeviceAsync &)
 
virtual void deactivate (Basda::DeviceAsync &)
 
virtual void measure ()
 
virtual Basda::PowerPtr getMeasuredPower ()
 
virtual bool isReachable ()
 
virtual void checkReachability ()
 
- Public Member Functions inherited from Basda::PowerMeterDevice
 PowerMeterDevice (const Nice::JointPtr &_config)
 
virtual ~PowerMeterDevice ()
 
 PowerMeterDevice (const Nice::JointPtr &_config)
 
virtual ~PowerMeterDevice ()
 
 PowerMeterDevice (const Nice::JointPtr &_config)
 
virtual ~PowerMeterDevice ()
 
- Public Member Functions inherited from Basda::Device
 Device (const Nice::JointPtr &_config)
 constructor. This is an elementary (lazy) action which stores the name and gets configuration. More...
 
virtual ~Device ()
 destructor Does nothing More...
 
virtual void setConfig (const Nice::JointPtr &_config)
 init with config tree ptr More...
 
Nice::JointPtrconfig ()
 retrieve the property tree More...
 
std::string & name ()
 retrieve the name set at ctor time. More...
 
 Device (const Nice::JointPtr &_config)
 constructor. This is an elementary (lazy) action which stores the name and gets configuration. More...
 
virtual ~Device ()
 destructor Does nothing More...
 
virtual void setConfig (const Nice::JointPtr &_config)
 init with config tree ptr More...
 
Nice::JointPtrconfig ()
 retrieve the property tree More...
 
std::string & name ()
 retrieve the name set at ctor time. More...
 

Static Public Member Functions

static std::string getPropertyNameForMeasuredPowerInWatt ()
 
static std::string getPowerValidityAttributeName ()
 
static std::string getPropertyNameForReachable ()
 
static std::string getPowerAsTextAttributeName ()
 
static std::string getPropertyNameForMeasuredPowerInWatt ()
 
static std::string getPowerValidityAttributeName ()
 
static std::string getPropertyNameForReachable ()
 
static std::string getPowerAsTextAttributeName ()
 

Protected Member Functions

void injectPlinkPowerMeterFactory (basda::gentec::PlinkPowerMeterFactoryPtr factory)
 
void injectPlinkPowerMeterFactory (basda::gentec::PlinkPowerMeterFactoryPtr factory)
 

Private Member Functions

basda::gentec::PlinkPowerMeterConfig buildConfigurationFromProperties ()
 
void putConfigurationFromPropertiesForSerialLineInto (basda::gentec::PlinkPowerMeterConfig &conf)
 
void putConfigurationFromPropertiesForTcpConnectionInto (basda::gentec::PlinkPowerMeterConfig &conf)
 
void insertPowerPropertyInToTree ()
 
void buildNewPowerMeter ()
 
void configureHardware ()
 
void updateMeasuredPowerProperty ()
 
std::string convertToTextInWatt (const Basda::Power &power)
 
void setPowerValidityPropertyTo (bool state)
 
void setPowerDisplayTextTo (const std::string &powerInWatt)
 
void markDeviceAsUnusable ()
 
basda::gentec::PlinkPowerMeterPtr getPowerMeter ()
 
basda::gentec::PlinkPowerMeterConfig buildConfigurationFromProperties ()
 
void putConfigurationFromPropertiesForSerialLineInto (basda::gentec::PlinkPowerMeterConfig &conf)
 
void putConfigurationFromPropertiesForTcpConnectionInto (basda::gentec::PlinkPowerMeterConfig &conf)
 
void insertPowerPropertyInToTree ()
 
void buildNewPowerMeter ()
 
void configureHardware ()
 
void updateMeasuredPowerProperty ()
 
std::string convertToTextInWatt (const Basda::Power &power)
 
void setPowerValidityPropertyTo (bool state)
 
void setPowerDisplayTextTo (const std::string &powerInWatt)
 
void markDeviceAsUnusable ()
 
basda::gentec::PlinkPowerMeterPtr getPowerMeter ()
 

Private Attributes

basda::gentec::PlinkPowerMeterFactoryPtr powerMeterFactory_
 
basda::gentec::PlinkPowerMeterPtr powerMeter_
 

Additional Inherited Members

- Static Public Attributes inherited from Basda::Device
static DeviceAsyncImpl s_async
 
- Protected Attributes inherited from Basda::Device
Nice::JointPtr m_config
 
Nice::JointPtr m_cfg
 
Nice::JointPtr m_var
 
std::string m_name
 

Constructor & Destructor Documentation

◆ PlinkPowerMeterDevice() [1/2]

basda::PlinkPowerMeterDevice::PlinkPowerMeterDevice ( const Nice::JointPtr _config)
explicit

◆ ~PlinkPowerMeterDevice() [1/2]

basda::PlinkPowerMeterDevice::~PlinkPowerMeterDevice ( )
virtual
Note
overridden

◆ PlinkPowerMeterDevice() [2/2]

basda::PlinkPowerMeterDevice::PlinkPowerMeterDevice ( const Nice::JointPtr _config)
explicit

◆ ~PlinkPowerMeterDevice() [2/2]

virtual basda::PlinkPowerMeterDevice::~PlinkPowerMeterDevice ( )
virtual
Note
overridden

Member Function Documentation

◆ activate() [1/2]

void basda::PlinkPowerMeterDevice::activate ( Basda::DeviceAsync _async)
virtual
Note
overridden

Implements Basda::Device.

◆ activate() [2/2]

virtual void basda::PlinkPowerMeterDevice::activate ( Basda::DeviceAsync )
virtual
Note
overridden

Implements Basda::Device.

◆ buildConfigurationFromProperties() [1/2]

PlinkPowerMeterConfig basda::PlinkPowerMeterDevice::buildConfigurationFromProperties ( )
private

◆ buildConfigurationFromProperties() [2/2]

basda::gentec::PlinkPowerMeterConfig basda::PlinkPowerMeterDevice::buildConfigurationFromProperties ( )
private

◆ buildNewPowerMeter() [1/2]

void basda::PlinkPowerMeterDevice::buildNewPowerMeter ( )
private

◆ buildNewPowerMeter() [2/2]

void basda::PlinkPowerMeterDevice::buildNewPowerMeter ( )
private

◆ checkReachability() [1/2]

virtual void basda::PlinkPowerMeterDevice::checkReachability ( )
virtual

◆ checkReachability() [2/2]

void basda::PlinkPowerMeterDevice::checkReachability ( )
virtual

◆ close() [1/2]

void basda::PlinkPowerMeterDevice::close ( void  )
virtual
Note
overridden

Implements Basda::Device.

Reimplemented in basda::PlinkPowerMeterDeviceFake, and basda::PlinkPowerMeterDeviceFake.

◆ close() [2/2]

virtual void basda::PlinkPowerMeterDevice::close ( )
virtual
Note
overridden

Implements Basda::Device.

Reimplemented in basda::PlinkPowerMeterDeviceFake, and basda::PlinkPowerMeterDeviceFake.

◆ configureHardware() [1/2]

void basda::PlinkPowerMeterDevice::configureHardware ( )
private

◆ configureHardware() [2/2]

void basda::PlinkPowerMeterDevice::configureHardware ( )
private

◆ convertToTextInWatt() [1/2]

string basda::PlinkPowerMeterDevice::convertToTextInWatt ( const Basda::Power power)
private

◆ convertToTextInWatt() [2/2]

std::string basda::PlinkPowerMeterDevice::convertToTextInWatt ( const Basda::Power power)
private

◆ deactivate() [1/2]

void basda::PlinkPowerMeterDevice::deactivate ( Basda::DeviceAsync _async)
virtual
Note
overridden

Implements Basda::Device.

◆ deactivate() [2/2]

virtual void basda::PlinkPowerMeterDevice::deactivate ( Basda::DeviceAsync )
virtual
Note
overridden

Implements Basda::Device.

◆ deinit() [1/2]

virtual void basda::PlinkPowerMeterDevice::deinit ( Basda::DeviceAsync )
virtual
Note
overridden

Implements Basda::Device.

◆ deinit() [2/2]

void basda::PlinkPowerMeterDevice::deinit ( Basda::DeviceAsync _async)
virtual
Note
overridden

Implements Basda::Device.

◆ getMeasuredPower() [1/2]

virtual Basda::PowerPtr basda::PlinkPowerMeterDevice::getMeasuredPower ( )
virtual

◆ getMeasuredPower() [2/2]

PowerPtr basda::PlinkPowerMeterDevice::getMeasuredPower ( )
virtual

◆ getPowerAsTextAttributeName() [1/2]

static std::string basda::PlinkPowerMeterDevice::getPowerAsTextAttributeName ( )
inlinestatic

◆ getPowerAsTextAttributeName() [2/2]

static std::string basda::PlinkPowerMeterDevice::getPowerAsTextAttributeName ( )
inlinestatic

◆ getPowerMeter() [1/2]

PlinkPowerMeterPtr basda::PlinkPowerMeterDevice::getPowerMeter ( )
private

◆ getPowerMeter() [2/2]

basda::gentec::PlinkPowerMeterPtr basda::PlinkPowerMeterDevice::getPowerMeter ( )
private

◆ getPowerValidityAttributeName() [1/2]

static std::string basda::PlinkPowerMeterDevice::getPowerValidityAttributeName ( )
inlinestatic

◆ getPowerValidityAttributeName() [2/2]

static std::string basda::PlinkPowerMeterDevice::getPowerValidityAttributeName ( )
inlinestatic

◆ getPropertyNameForMeasuredPowerInWatt() [1/2]

static std::string basda::PlinkPowerMeterDevice::getPropertyNameForMeasuredPowerInWatt ( )
inlinestatic

◆ getPropertyNameForMeasuredPowerInWatt() [2/2]

static std::string basda::PlinkPowerMeterDevice::getPropertyNameForMeasuredPowerInWatt ( )
inlinestatic

◆ getPropertyNameForReachable() [1/2]

static std::string basda::PlinkPowerMeterDevice::getPropertyNameForReachable ( )
inlinestatic

◆ getPropertyNameForReachable() [2/2]

static std::string basda::PlinkPowerMeterDevice::getPropertyNameForReachable ( )
inlinestatic

◆ init() [1/2]

void basda::PlinkPowerMeterDevice::init ( Basda::DeviceAsync _async)
virtual
Note
overridden

Implements Basda::Device.

◆ init() [2/2]

virtual void basda::PlinkPowerMeterDevice::init ( Basda::DeviceAsync )
virtual
Note
overridden

Implements Basda::Device.

◆ injectPlinkPowerMeterFactory() [1/2]

void basda::PlinkPowerMeterDevice::injectPlinkPowerMeterFactory ( basda::gentec::PlinkPowerMeterFactoryPtr  factory)
protected

◆ injectPlinkPowerMeterFactory() [2/2]

void basda::PlinkPowerMeterDevice::injectPlinkPowerMeterFactory ( basda::gentec::PlinkPowerMeterFactoryPtr  factory)
protected

◆ insertPowerPropertyInToTree() [1/2]

void basda::PlinkPowerMeterDevice::insertPowerPropertyInToTree ( )
private

◆ insertPowerPropertyInToTree() [2/2]

void basda::PlinkPowerMeterDevice::insertPowerPropertyInToTree ( )
private

◆ isReachable() [1/2]

bool basda::PlinkPowerMeterDevice::isReachable ( )
virtual

◆ isReachable() [2/2]

virtual bool basda::PlinkPowerMeterDevice::isReachable ( )
virtual

◆ markDeviceAsUnusable() [1/2]

void basda::PlinkPowerMeterDevice::markDeviceAsUnusable ( )
private

◆ markDeviceAsUnusable() [2/2]

void basda::PlinkPowerMeterDevice::markDeviceAsUnusable ( )
private

◆ measure() [1/2]

void basda::PlinkPowerMeterDevice::measure ( )
virtual

◆ measure() [2/2]

virtual void basda::PlinkPowerMeterDevice::measure ( )
virtual

◆ open() [1/2]

void basda::PlinkPowerMeterDevice::open ( void  )
virtual
Note
overridden

Implements Basda::Device.

Reimplemented in basda::PlinkPowerMeterDeviceFake, and basda::PlinkPowerMeterDeviceFake.

◆ open() [2/2]

virtual void basda::PlinkPowerMeterDevice::open ( )
virtual
Note
overridden

Implements Basda::Device.

Reimplemented in basda::PlinkPowerMeterDeviceFake, and basda::PlinkPowerMeterDeviceFake.

◆ putConfigurationFromPropertiesForSerialLineInto() [1/2]

void basda::PlinkPowerMeterDevice::putConfigurationFromPropertiesForSerialLineInto ( basda::gentec::PlinkPowerMeterConfig conf)
private

◆ putConfigurationFromPropertiesForSerialLineInto() [2/2]

void basda::PlinkPowerMeterDevice::putConfigurationFromPropertiesForSerialLineInto ( basda::gentec::PlinkPowerMeterConfig conf)
private

◆ putConfigurationFromPropertiesForTcpConnectionInto() [1/2]

void basda::PlinkPowerMeterDevice::putConfigurationFromPropertiesForTcpConnectionInto ( basda::gentec::PlinkPowerMeterConfig conf)
private

◆ putConfigurationFromPropertiesForTcpConnectionInto() [2/2]

void basda::PlinkPowerMeterDevice::putConfigurationFromPropertiesForTcpConnectionInto ( basda::gentec::PlinkPowerMeterConfig conf)
private

◆ reset() [1/2]

virtual void basda::PlinkPowerMeterDevice::reset ( Basda::DeviceAsync )
virtual
Note
overridden

Implements Basda::Device.

Reimplemented in basda::PlinkPowerMeterDeviceFake, and basda::PlinkPowerMeterDeviceFake.

◆ reset() [2/2]

void basda::PlinkPowerMeterDevice::reset ( Basda::DeviceAsync _async)
virtual
Note
overridden

Implements Basda::Device.

Reimplemented in basda::PlinkPowerMeterDeviceFake, and basda::PlinkPowerMeterDeviceFake.

◆ setPowerDisplayTextTo() [1/2]

void basda::PlinkPowerMeterDevice::setPowerDisplayTextTo ( const std::string &  powerInWatt)
private

◆ setPowerDisplayTextTo() [2/2]

void basda::PlinkPowerMeterDevice::setPowerDisplayTextTo ( const std::string &  powerInWatt)
private

◆ setPowerValidityPropertyTo() [1/2]

void basda::PlinkPowerMeterDevice::setPowerValidityPropertyTo ( bool  state)
private

◆ setPowerValidityPropertyTo() [2/2]

void basda::PlinkPowerMeterDevice::setPowerValidityPropertyTo ( bool  state)
private

◆ updateMeasuredPowerProperty() [1/2]

void basda::PlinkPowerMeterDevice::updateMeasuredPowerProperty ( )
private

◆ updateMeasuredPowerProperty() [2/2]

void basda::PlinkPowerMeterDevice::updateMeasuredPowerProperty ( )
private

◆ version() [1/2]

void basda::PlinkPowerMeterDevice::version ( void  )
virtual
Note
overridden

Implements Basda::Device.

◆ version() [2/2]

virtual void basda::PlinkPowerMeterDevice::version ( )
virtual
Note
overridden

Implements Basda::Device.

Member Data Documentation

◆ powerMeter_

basda::gentec::PlinkPowerMeterPtr basda::PlinkPowerMeterDevice::powerMeter_
private

◆ powerMeterFactory_

basda::gentec::PlinkPowerMeterFactoryPtr basda::PlinkPowerMeterDevice::powerMeterFactory_
private

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