io_switch.IoSwitch Class Reference

Inheritance diagram for io_switch.IoSwitch:

Collaboration diagram for io_switch.IoSwitch:

Public Member Functions
def	__init__ (self, deviceRootName)
def	getNumOfInputPorts (self)
def	getNumOfOutputPorts (self)
def	setOn (self, outputPortIndex)
def	setOff (self, outputPortIndex)
def	getOutputPortState (self, outputPortIndex)
def	getInputPortState (self, inputPortIndex)
def	getOutputPortDescription (self, outputPortIndex)
def	getInputPortDescription (self, inputPortIndex)
def	isReachable (self)
def	name (self)
def	turnOffLoggingWhenSettingOutputPort (self, port)
def	turnOnLoggingWhenSettingOutputPort (self, port)
def	isLoggingTurnedOnWhenSettingOutputPort (self, port)
def	__init__ (self, deviceRootName)
def	getNumOfInputPorts (self)
def	getNumOfOutputPorts (self)
def	setOn (self, outputPortIndex)
def	setOff (self, outputPortIndex)
def	getOutputPortState (self, outputPortIndex)
def	getInputPortState (self, inputPortIndex)
def	getOutputPortDescription (self, outputPortIndex)
def	getInputPortDescription (self, inputPortIndex)
def	isReachable (self)
def	name (self)
def	turnOffLoggingWhenSettingOutputPort (self, port)
def	turnOnLoggingWhenSettingOutputPort (self, port)
def	isLoggingTurnedOnWhenSettingOutputPort (self, port)

Public Attributes
	deviceRootName_
	inputPorts_
	outputPorts_

Static Public Attributes
	DEBUG_LEVEL_IN_SETTING_OUTPUT_PORT_NAME = \

Private Member Functions
def	_loggingEnabledPropertyName (self, port)
def	_configureLoggingForOutputPortSetting (self, deactivated, port)
def	_buildInputPorts (self)
def	_buildOutputPorts (self)
def	_checkOutputPortIndex (self, outputPortIndex)
def	_checkInputPortIndex (self, inputPortIndex)
def	_loggingEnabledPropertyName (self, port)
def	_configureLoggingForOutputPortSetting (self, deactivated, port)
def	_buildInputPorts (self)
def	_buildOutputPorts (self)
def	_checkOutputPortIndex (self, outputPortIndex)
def	_checkInputPortIndex (self, inputPortIndex)

Detailed Description

This class represents a I/O switch devices with several input ports and output ports.

Constructor & Destructor Documentation

__init__() [1/2]

def io_switch.IoSwitch.__init__	(		self,
			deviceRootName
	)

Constructs an IoSwitch.

@param deviceRootName the root node name of the device in the property tree.

__init__() [2/2]

def io_switch.IoSwitch.__init__	(		self,
			deviceRootName
	)

Constructs an IoSwitch.

@param deviceRootName the root node name of the device in the property tree.

Member Function Documentation

_buildInputPorts() [1/2]

def io_switch.IoSwitch._buildInputPorts (   self )

private

_buildInputPorts() [2/2]

def io_switch.IoSwitch._buildInputPorts (   self )

private

_buildOutputPorts() [1/2]

def io_switch.IoSwitch._buildOutputPorts (   self )

private

_buildOutputPorts() [2/2]

def io_switch.IoSwitch._buildOutputPorts (   self )

private

_checkInputPortIndex() [1/2]

def io_switch.IoSwitch._checkInputPortIndex (   self,   inputPortIndex  )

private

_checkInputPortIndex() [2/2]

def io_switch.IoSwitch._checkInputPortIndex (   self,   inputPortIndex  )

private

_checkOutputPortIndex() [1/2]

def io_switch.IoSwitch._checkOutputPortIndex (   self,   outputPortIndex  )

private

_checkOutputPortIndex() [2/2]

def io_switch.IoSwitch._checkOutputPortIndex (   self,   outputPortIndex  )

private

_configureLoggingForOutputPortSetting() [1/2]

def io_switch.IoSwitch._configureLoggingForOutputPortSetting (   self,   deactivated,   port  )

private

_configureLoggingForOutputPortSetting() [2/2]

def io_switch.IoSwitch._configureLoggingForOutputPortSetting (   self,   deactivated,   port  )

private

_loggingEnabledPropertyName() [1/2]

def io_switch.IoSwitch._loggingEnabledPropertyName (   self,   port  )

private

_loggingEnabledPropertyName() [2/2]

def io_switch.IoSwitch._loggingEnabledPropertyName (   self,   port  )

private

getInputPortDescription() [1/2]

def io_switch.IoSwitch.getInputPortDescription	(		self,
			inputPortIndex
	)

getInputPortDescription() [2/2]

def io_switch.IoSwitch.getInputPortDescription	(		self,
			inputPortIndex
	)

getInputPortState() [1/2]

def io_switch.IoSwitch.getInputPortState	(		self,
			inputPortIndex
	)

Gets the state of an input port.

@param inputPortIndex an port index.
@return the port state (element of PORT_STATES)

getInputPortState() [2/2]

def io_switch.IoSwitch.getInputPortState	(		self,
			inputPortIndex
	)

Gets the state of an input port.

@param inputPortIndex an port index.
@return the port state (element of PORT_STATES)

getNumOfInputPorts() [1/2]

def io_switch.IoSwitch.getNumOfInputPorts

(

self

)

getNumOfInputPorts() [2/2]

def io_switch.IoSwitch.getNumOfInputPorts

(

self

)

getNumOfOutputPorts() [1/2]

def io_switch.IoSwitch.getNumOfOutputPorts

(

self

)

getNumOfOutputPorts() [2/2]

def io_switch.IoSwitch.getNumOfOutputPorts

(

self

)

getOutputPortDescription() [1/2]

def io_switch.IoSwitch.getOutputPortDescription	(		self,
			outputPortIndex
	)

getOutputPortDescription() [2/2]

def io_switch.IoSwitch.getOutputPortDescription	(		self,
			outputPortIndex
	)

getOutputPortState() [1/2]

def io_switch.IoSwitch.getOutputPortState	(		self,
			outputPortIndex
	)

Gets the state of an output port.

@param outputPortIndex an port index.
@return the port state (element of PORT_STATES)

getOutputPortState() [2/2]

def io_switch.IoSwitch.getOutputPortState	(		self,
			outputPortIndex
	)

Gets the state of an output port.

@param outputPortIndex an port index.
@return the port state (element of PORT_STATES)

isLoggingTurnedOnWhenSettingOutputPort() [1/2]

def io_switch.IoSwitch.isLoggingTurnedOnWhenSettingOutputPort	(		self,
			port
	)

isLoggingTurnedOnWhenSettingOutputPort() [2/2]

def io_switch.IoSwitch.isLoggingTurnedOnWhenSettingOutputPort	(		self,
			port
	)

isReachable() [1/2]

def io_switch.IoSwitch.isReachable

(

self

)

Checks if the hardware is reachable.

@return true if the hardware is reachable.

isReachable() [2/2]

def io_switch.IoSwitch.isReachable

(

self

)

Checks if the hardware is reachable.

@return true if the hardware is reachable.

name() [1/2]

def io_switch.IoSwitch.name

(

self

)

@return the name of the device

name() [2/2]

def io_switch.IoSwitch.name

(

self

)

@return the name of the device

setOff() [1/2]

def io_switch.IoSwitch.setOff	(		self,
			outputPortIndex
	)

Sets on output port to OFF.

@param outputPortIndex an port index.

setOff() [2/2]

def io_switch.IoSwitch.setOff	(		self,
			outputPortIndex
	)

Sets on output port to OFF.

@param outputPortIndex an port index.

setOn() [1/2]

def io_switch.IoSwitch.setOn	(		self,
			outputPortIndex
	)

Sets an output port to ON.

@param outputPortIndex an port index.

setOn() [2/2]

def io_switch.IoSwitch.setOn	(		self,
			outputPortIndex
	)

Sets an output port to ON.

@param outputPortIndex an port index.

turnOffLoggingWhenSettingOutputPort() [1/2]

def io_switch.IoSwitch.turnOffLoggingWhenSettingOutputPort	(		self,
			port
	)

turnOffLoggingWhenSettingOutputPort() [2/2]

def io_switch.IoSwitch.turnOffLoggingWhenSettingOutputPort	(		self,
			port
	)

turnOnLoggingWhenSettingOutputPort() [1/2]

def io_switch.IoSwitch.turnOnLoggingWhenSettingOutputPort	(		self,
			port
	)

turnOnLoggingWhenSettingOutputPort() [2/2]

def io_switch.IoSwitch.turnOnLoggingWhenSettingOutputPort	(		self,
			port
	)

Member Data Documentation

DEBUG_LEVEL_IN_SETTING_OUTPUT_PORT_NAME

io_switch.IoSwitch.DEBUG_LEVEL_IN_SETTING_OUTPUT_PORT_NAME = \

static

deviceRootName_

io_switch.IoSwitch.deviceRootName_

inputPorts_

io_switch.IoSwitch.inputPorts_

outputPorts_

io_switch.IoSwitch.outputPorts_

---

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

• /home/nirva/insroot/lib/python/site-packages/io_switch.py