SELKIELogger.Specs.LimitSpec Class Reference

LimitSpec: String representation of channel limit specification. More...

Public Member Functions
def	__init__ (self, s)
	Split string into components defining channel and warning limits. More...
def	check (self, s)
	Check whether channel is within warning threshold or not, based on the data in s More...
def	getValue (self, s)
def	__str__ (self)
def	__repr__ (self)

Public Attributes
	channel
	ChannelSpec() identifying source of latitude data.
	lowLim
	Lower limit.
	highLim
	Upper limit.
	name
	Name for this locator (used in reporting)

Detailed Description

LimitSpec: String representation of channel limit specification.

Definition at line 192 of file Specs.py.

Constructor & Destructor Documentation

__init__()

def SELKIELogger.Specs.LimitSpec.__init__	(		self,
			s
	)

Split string into components defining channel and warning limits.

Values are validated to the extent possible without device and source specific information String is a set of comma separated values in this order:

• ChannelSpec()
• Low value threshold
• High value threshold
• [Optional] Name

  Parameters

  s	String in required format.

Definition at line 197 of file Specs.py.

Member Function Documentation

__repr__()

def SELKIELogger.Specs.LimitSpec.__repr__

(

self

)

Returns

Parseable representation

Definition at line 256 of file Specs.py.

__str__()

def SELKIELogger.Specs.LimitSpec.__str__

(

self

)

Returns

Correctly formatted string

Definition at line 252 of file Specs.py.

check()

def SELKIELogger.Specs.LimitSpec.check	(		self,
			s
	)

Check whether channel is within warning threshold or not, based on the data in s

Returns true if value is unknown or outside limits

Parameters

s	State dataframe

Returns

true/false

Definition at line 230 of file Specs.py.

getValue()

def SELKIELogger.Specs.LimitSpec.getValue	(		self,
			s
	)

Returns

Channel getValue result

Definition at line 248 of file Specs.py.

---

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

• /home/runner/work/Logger/Logger/python/SELKIELogger/Specs.py