4.2.11. SummitsContainer

class pyprom.lib.containers.summits.SummitsContainer(summitList)[source]

Container for Summits. Allows for various list transformations.

__init__(summitList)[source]
Parameters

summitList (list(pyprom.lib.locations.summit.Summit)) – list of Summits which reside in this container.

Raises

TypeError if summitList contains non pyprom.lib.locations.summit.Summit objects

__repr__()[source]
Returns

String representation of this object

__setitem__(idx, summit)[source]

Gives SummitsContainer list like set capabilities

Parameters
Raises

TypeError if summit not of pyprom.lib.locations.summit.Summit

__str__()
Returns

String representation of this object

__unicode__()
Returns

String representation of this object

append(summit)[source]

Append a pyprom.lib.locations.summit.Summit to this container.

Parameters

summit (pyprom.lib.locations.summit.Summit) – Summit to append.

Raises

TypeError if summit not of pyprom.lib.locations.summit.Summit

extend(summits)[source]

Extend a list of :class:`pyprom.lib.locations.summit.Summit to this container.

Parameters

summits – list of Saddles to append.

Raises

TypeError if point not of :class:`pyprom.lib.locations.summit.Summit’

classmethod from_dict(summitContainerDict, datamap=None)[source]

Create this object from dictionary representation

Parameters

  • summitContainerDict – dict() representation of this object.

  • datamap (pyprom.lib.datamap.DataMap) – datamap which MultiPoint style Saddles use.

Returns

a new SummitsContainer

Return type

SummitsContainer

property multipoints
Returns list of all multipoint

pyprom.lib.locations.summit.Summit within container

Returns

list(pyprom.lib.locations.summit.Summit)

property summits

Getter alias for self.points

Returns

All summits in this container.

Return type

list(pyprom.lib.locations.summit.Summit)

to_dict()[source]

Create the dictionary representation of this object.

Returns

dict() representation of SummitsContainer

Return type

dict()