io_switch.OutputPort Class Reference

Inheritance diagram for io_switch.OutputPort:

Collaboration diagram for io_switch.OutputPort:

Public Member Functions
def	__init__ (self, deviceName, portIndex)
def	setOn (self)
def	setOff (self)
def	getState (self)
def	getDescription (self)
def	__init__ (self, deviceName, portIndex)
def	setOn (self)
def	setOff (self)
def	getState (self)
def	getDescription (self)

Public Attributes
	deviceName_
	portIndex_
	setOnCommand_
	setOffCommand_
	statusPropertyName_

Static Public Attributes
string	OUTPUT_PORT_SET_ON_COMMAND_NAME = "OUTPUT.COMMAND.SET_ON"
string	OUTPUT_PORT_SET_OFF_COMMAND_NAME = "OUTPUT.COMMAND.SET_OFF"
Static Public Attributes inherited from io_switch.Port
string	PROPERTY_DESCRIPTION = "DESCRIPTION"

Detailed Description

This class represents an output port.

Constructor & Destructor Documentation

__init__() [1/2]

def io_switch.OutputPort.__init__	(		self,
			deviceName,
			portIndex
	)

Constructs an OutputPort.

@param deviceName the node name of this output port.
@param portIndex the port index.

__init__() [2/2]

def io_switch.OutputPort.__init__	(		self,
			deviceName,
			portIndex
	)

Constructs an OutputPort.

@param deviceName the node name of this output port.
@param portIndex the port index.

Member Function Documentation

getDescription() [1/2]

def io_switch.OutputPort.getDescription

(

self

)

getDescription() [2/2]

def io_switch.OutputPort.getDescription

(

self

)

getState() [1/2]

def io_switch.OutputPort.getState

(

self

)

Gets the port state.

@return the port state (element of PORT_STATES)

getState() [2/2]

def io_switch.OutputPort.getState

(

self

)

Gets the port state.

@return the port state (element of PORT_STATES)

setOff() [1/2]

def io_switch.OutputPort.setOff

(

self

)

Sets this port to OFF.

setOff() [2/2]

def io_switch.OutputPort.setOff

(

self

)

Sets this port to OFF.

setOn() [1/2]

def io_switch.OutputPort.setOn

(

self

)

Sets this port to ON.

setOn() [2/2]

def io_switch.OutputPort.setOn

(

self

)

Sets this port to ON.

Member Data Documentation

deviceName_

io_switch.OutputPort.deviceName_

OUTPUT_PORT_SET_OFF_COMMAND_NAME

string io_switch.OutputPort.OUTPUT_PORT_SET_OFF_COMMAND_NAME = "OUTPUT.COMMAND.SET_OFF"

static

OUTPUT_PORT_SET_ON_COMMAND_NAME

string io_switch.OutputPort.OUTPUT_PORT_SET_ON_COMMAND_NAME = "OUTPUT.COMMAND.SET_ON"

static

portIndex_

io_switch.OutputPort.portIndex_

setOffCommand_

io_switch.OutputPort.setOffCommand_

setOnCommand_

io_switch.OutputPort.setOnCommand_

statusPropertyName_

io_switch.OutputPort.statusPropertyName_

---

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

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