Package empro :: Module empro :: Class FarZoneSensorList

Class FarZoneSensorList

core.Updatable --+    
                 |    
   core.Selectable --+
                     |
                    FarZoneSensorList

Manages the list of far zone sensors.

Class Hierarchy for FarZoneSensorList

Instance Methods

__call__(x, ...)
x(...)

__contains__(x, y)
y in x

__delitem__(x, y)
del x[y]

__getitem__(x, y)
x[y]

__len__(x)
len(x)

__setitem__(x, i, y)
x[i]=y

bool

append(iSensor)
Appends a far zone sensor to the list.

FarZoneSensor

at(iName)
Returns the far zone sensor by name.

None

clear()
Clear the list.

bool

contains(iSensor)
Determines if the far zone sensor is in the list.

int

index(iSensor)
Retrieves the index of a far zone sensor.

bool

insert(iIndex, iSensor)
Inserts a far zone sensor into the list.

list{string}

names()
Returns the names of the far zone sensors in the list.

bool

remove(iIndex)
Removes a far zone sensor.

bool

replace(iIndex, iSensor)
Replaces a far zone sensor.

int

size()
Returns the size of the list.

list{string}

swap()
Returns the names of the far zone sensors in the list.

Inherited from core.Selectable: clone, isSelected

Inherited from core.Updatable: __enter__, __exit__, hash, isValid, reasonWhyInvalid

Properties
Inherited from `core.Selectable`: `metaData`, `name`, `notes`

Method Details

append(iSensor)

Appends a far zone sensor to the list.

Parameters:

iSensor (FarZoneSensor) - Far zone sensor to add.

Returns: bool

at(iName)

Returns the far zone sensor by name.

Parameters:

iName (string) - Name of the requested far zone sensor.

Returns: FarZoneSensor

contains(iSensor)

Determines if the far zone sensor is in the list.

Parameters:

iSensor (FarZoneSensor) - Far zone sensor to query.

Returns: bool

index(iSensor)

Retrieves the index of a far zone sensor.

Parameters:

iSensor (FarZoneSensor) - Far zone sensor to query.

Returns: int

insert(iIndex, iSensor)

Inserts a far zone sensor into the list.

Parameters:

iIndex (int) - Index of where to insert the new element.
iSensor (FarZoneSensor) - Far zone sensor to add.

Returns: bool

remove(iIndex)

Removes a far zone sensor.

Parameters:

iIndex (int) - Index of the far zone sensor to remove.

Returns: bool

replace(iIndex, iSensor)

Replaces a far zone sensor.

Parameters:

iIndex (int) - Index of which sensor to replace.
iSensor (FarZoneSensor) - Far zone sensor to add.

Returns: bool