SELKIELogger.Specs.ChannelSpec Class Reference

ChannelSpec: Specify a data channel with a formatted string. More...

Public Member Functions
def	__init__ (self, s)
	Split string into source, channel, and optionally array index components. More...
def	getValue (self, state)
	Extract value from state corresponding to this Spec. More...
def	__str__ (self)
def	__repr__ (self)

Public Attributes
	source
	Selected source ID.
	channel
	Selected channel ID.
	index
	Selected array index (optional)

Detailed Description

ChannelSpec: Specify a data channel with a formatted string.

Definition at line 28 of file Specs.py.

Constructor & Destructor Documentation

__init__()

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

Split string into source, channel, and optionally array index components.

Values are validated to the extent possible without device and source specific information

Parameters

s	String in format 'source:channel[:index]'

Definition at line 31 of file Specs.py.

Member Function Documentation

__repr__()

def SELKIELogger.Specs.ChannelSpec.__repr__

(

self

)

Returns

Parseable representation

Definition at line 85 of file Specs.py.

__str__()

def SELKIELogger.Specs.ChannelSpec.__str__

(

self

)

Returns

Correctly formatted string

Definition at line 78 of file Specs.py.

getValue()

def SELKIELogger.Specs.ChannelSpec.getValue	(		self,
			state
	)

Extract value from state corresponding to this Spec.

Parameters

state

Dataframe containing StateFile data

Returns

floating point value, or NaN if not found

Definition at line 63 of file Specs.py.

---

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

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