Package empro :: Module empro :: Class NearFieldSensorList

Class NearFieldSensorList

core.Updatable --+    
                 |    
   core.Selectable --+
                     |
                    NearFieldSensorList

Manages the list of near field sensors.

Class Hierarchy for NearFieldSensorList

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 near field sensor to the list.

NearFieldSensor

at(iName)
Returns the near field sensor by name.

None

clear()
Clear the list.

bool

contains(iSensor)
Determines if the near field sensor is in the list.

int

index(iSensor)
Retrieves the index of a near field sensor.

bool

insert(iIndex, iSensor)
Inserts a near field sensor into the list.

list{string}

names()
Returns the names of the near field sensors in the list.

bool

remove(iIndex)
Removes a near field sensor.

bool

replace(iIndex, iSensor)
Replaces a near field sensor.

int

size()
Returns the size of the list.

list{string}

swap()
Returns the names of the near field 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 near field sensor to the list.

Parameters:

iSensor (NearFieldSensor) - Near field sensor to add.

Returns: bool

at(iName)

Returns the near field sensor by name.

Parameters:

iName (string) - Name of the requested near field sensor.

Returns: NearFieldSensor

contains(iSensor)

Determines if the near field sensor is in the list.

Parameters:

iSensor (NearFieldSensor) - Near field sensor to query.

Returns: bool

index(iSensor)

Retrieves the index of a near field sensor.

Parameters:

iSensor (NearFieldSensor) - Near field sensor to query.

Returns: int

insert(iIndex, iSensor)

Inserts a near field sensor into the list.

Parameters:

iIndex (int) - Index of where to insert the new element.
iSensor (NearFieldSensor) - Near field sensor to add.

Returns: bool

remove(iIndex)

Removes a near field sensor.

Parameters:

iIndex (int) - Index of the near field sensor to remove.

Returns: bool

replace(iIndex, iSensor)

Replaces a near field sensor.

Parameters:

iIndex (int) - Index of which sensor to replace.
iSensor (NearFieldSensor) - Near field sensor to add.

Returns: bool