TwiceAsNice  2019-02-18
Public Member Functions | Public Attributes | List of all members
power_meter.PowerMeter Class Reference
Collaboration diagram for power_meter.PowerMeter:
Collaboration graph

Public Member Functions

def __init__ (self, fullDeviceName)
 
def isReachable (self)
 
def getMeasuredPowerInWatt (self)
 
def isMeasuredPowerValid (self)
 
def name (self)
 
def __init__ (self, fullDeviceName)
 
def isReachable (self)
 
def getMeasuredPowerInWatt (self)
 
def isMeasuredPowerValid (self)
 
def name (self)
 

Public Attributes

 fullDeviceName_
 

Detailed Description

This class remotely queries the property tree of a power meter basda device.

Constructor & Destructor Documentation

◆ __init__() [1/2]

def power_meter.PowerMeter.__init__ (   self,
  fullDeviceName 
)
Constructs the PowerMeter.

@param the full path of the remote device name (e.g. FOO.DEV1)

◆ __init__() [2/2]

def power_meter.PowerMeter.__init__ (   self,
  fullDeviceName 
)
Constructs the PowerMeter.

@param the full path of the remote device name (e.g. FOO.DEV1)

Member Function Documentation

◆ getMeasuredPowerInWatt() [1/2]

def power_meter.PowerMeter.getMeasuredPowerInWatt (   self)
Retrieves the recently measured power in unit Watt.
   
@return the measured power in unit Watt.

◆ getMeasuredPowerInWatt() [2/2]

def power_meter.PowerMeter.getMeasuredPowerInWatt (   self)
Retrieves the recently measured power in unit Watt.
   
@return the measured power in unit Watt.

◆ isMeasuredPowerValid() [1/2]

def power_meter.PowerMeter.isMeasuredPowerValid (   self)
Checks if the measured power is valid.

@return true if the recently measured power is valid.

◆ isMeasuredPowerValid() [2/2]

def power_meter.PowerMeter.isMeasuredPowerValid (   self)
Checks if the measured power is valid.

@return true if the recently measured power is valid.

◆ isReachable() [1/2]

def power_meter.PowerMeter.isReachable (   self)
Checks if the power meter hardware is reachable.

@return true if the hardware is reachable.

◆ isReachable() [2/2]

def power_meter.PowerMeter.isReachable (   self)
Checks if the power meter hardware is reachable.

@return true if the hardware is reachable.

◆ name() [1/2]

def power_meter.PowerMeter.name (   self)
@return the name of the device

◆ name() [2/2]

def power_meter.PowerMeter.name (   self)
@return the name of the device

Member Data Documentation

◆ fullDeviceName_

power_meter.PowerMeter.fullDeviceName_

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