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.Summitobjects
-
__setitem__(idx, summit)[source]¶ Gives SummitsContainer list like set capabilities
Parameters: - idx (int) – index value
- summit (
pyprom.lib.locations.summit.Summit) – Summit to add.
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.Summitto this container.Parameters: summit ( pyprom.lib.locations.summit.Summit) – Summit to append.Raises: TypeError if summit not of 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:
-
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 SummitsContainerReturn type: dict()
-