ParamsDictObject#

class orbit.utils.ParamsDictObject[source]#

Bases: object

Class. Object that has a parameters dictionary.

Methods Summary

`addParam`(key, value)	Method.
`getParam`(key)	Method.
`getParamsDict`()	Method.
`hasParam`(key)	Method.
`keys`()	return the list of the keys for the parameters
`removeParam`(key)	Method.
`setParam`(key, value)	Method.
`setParamsDict`(params)	Method.
`updateParamsDict`(params)	Method.

Methods Documentation

addParam(key, value)[source]#: Method. Adds a parameter to the object.

getParam(key)[source]#: Method. Returns requested parameters of the object.

getParamsDict()[source]#: Method. Returns the whole parameters dictionary.

hasParam(key)[source]#: Method. Returns True if the object has a parameter for this key. Returns False otherwise.

keys()[source]#: return the list of the keys for the parameters

removeParam(key)[source]#: Method. Removes a parameter.

setParam(key, value)[source]#: Method. Sets a parameter to the object.

setParamsDict(params)[source]#: Method. Sets an external dictionary as a parameter dictionary for this element.

updateParamsDict(params)[source]#: Method. Updates the dictionary with external dictionary data.