Class PropertyTreeScriptWrapper
- java.lang.Object
-
- org.python.core.PyObject
-
- com.inductiveautomation.ignition.common.script.abc.AbstractJythonMap
-
- com.inductiveautomation.ignition.common.script.abc.AbstractMutableJythonMap
-
- com.inductiveautomation.perspective.gateway.script.PropertyTreeScriptWrapper
-
- All Implemented Interfaces:
JythonMap,MutableJythonMap,java.io.Serializable
public final class PropertyTreeScriptWrapper extends AbstractMutableJythonMap
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classPropertyTreeScriptWrapper.ArrayWrapperSpecial array that writes back to the underling property treeclassPropertyTreeScriptWrapper.ObjectWrapperSpecial dictionary that writes back to the underlying property tree
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean__contains__(org.python.core.PyObject pyKey)void__delattr__(java.lang.String name)void__delitem__(org.python.core.PyObject pyKey)RemovepyKeyfrom the map.org.python.core.PyObject__findattr_ex__(java.lang.String name)org.python.core.PyObject__finditem__(java.lang.String key)Look up and return the specified key.int__len__()void__setattr__(java.lang.String name, org.python.core.PyObject value)void__setitem__(org.python.core.PyObject pyKey, org.python.core.PyObject pyValue)Update the map atpyKeywith new valuepyValuevoidclear()Set every value in this mapping to null.org.python.core.PyObjectget(org.python.core.PyObject pyKey, org.python.core.PyObject def)Get the value for the specified key, ordefaultif the key was not present.org.python.core.PyListitems()org.python.core.PyListkeys()org.python.core.PyObjectpop(org.python.core.PyObject pyKey)Returns the value specified bypyKeyin the mapping, and deletes that entry.org.python.core.PyObjectpopitem()Returns an arbitrary (not guaranteed random, nor guaranteed last) item (PyTuple key: value pair) from the dictionary, and removes that item from the mapping.org.python.core.PyObjectsetdefault(org.python.core.PyObject pyKey, org.python.core.PyObject def)Returns the value ofpyKeyif it is already present in the map.voidupdate(org.python.core.PyObject[] args, java.lang.String[] keywords)Updates this mapping, one of three possible ways: with a set of keyword arguments; eg{"a": 1}.update(b=2, c=3) == {"a": 1, "b": 2, * "c": 3}with another dictionary directly with an iterable sequence of key:value pairsorg.python.core.PyListvalues()-
Methods inherited from class com.inductiveautomation.ignition.common.script.abc.AbstractMutableJythonMap
pop, setdefault
-
Methods inherited from class com.inductiveautomation.ignition.common.script.abc.AbstractJythonMap
__finditem__, __finditem__, __iter__, __repr__, __str__, get, has_key, isMappingType, isNumberType, isSequenceType, iteritems, iterkeys, itervalues, toString
-
Methods inherited from class org.python.core.PyObject
__abs__, __add__, __and__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __cmp__, __coerce__, __coerce_ex__, __complex__, __delattr__, __delete__, __delitem__, __delslice__, __delslice__, __dir__, __div__, __divmod__, __ensure_finalizer__, __eq__, __findattr__, __findattr__, __float__, __floordiv__, __format__, __ge__, __get__, __getattr__, __getattr__, __getitem__, __getitem__, __getnewargs__, __getslice__, __getslice__, __gt__, __hash__, __hex__, __iadd__, __iand__, __idiv__, __idivmod__, __ifloordiv__, __ilshift__, __imod__, __imul__, __index__, __int__, __invert__, __ior__, __ipow__, __irshift__, __isub__, __iternext__, __itruediv__, __ixor__, __le__, __long__, __lshift__, __lt__, __mod__, __mul__, __ne__, __neg__, __nonzero__, __not__, __oct__, __or__, __pos__, __pow__, __pow__, __radd__, __rand__, __rawdir__, __rdiv__, __rdivmod__, __reduce__, __reduce_ex__, __reduce_ex__, __rfloordiv__, __rlshift__, __rmod__, __rmul__, __ror__, __rpow__, __rrshift__, __rshift__, __rsub__, __rtruediv__, __rxor__, __set__, __setattr__, __setitem__, __setitem__, __setslice__, __setslice__, __sub__, __tojava__, __truediv__, __trunc__, __unicode__, __xor__, _add, _and, _callextra, _cmp, _div, _divmod, _doget, _doget, _doset, _eq, _floordiv, _ge, _gt, _iadd, _iand, _idiv, _idivmod, _ifloordiv, _ilshift, _imod, _imul, _in, _ior, _ipow, _irshift, _is, _isnot, _isub, _itruediv, _ixor, _jcall, _jcallexc, _jthrow, _le, _lshift, _lt, _mod, _mul, _ne, _notin, _or, _pow, _rshift, _sub, _truediv, _unsupportedop, _xor, adaptToCoerceTuple, asDouble, asIndex, asIndex, asInt, asInt, asIterable, asLong, asLong, asName, asName, asString, asString, asStringOrNull, asStringOrNull, bit_length, conjugate, delDict, delType, dispatch__init__, equals, fastGetClass, fastGetDict, finalize, getDict, getJavaProxy, getType, hashCode, impAttr, implementsDescrDelete, implementsDescrGet, implementsDescrSet, invoke, invoke, invoke, invoke, invoke, invoke, isCallable, isDataDescr, isIndex, isInteger, mergeClassDict, mergeDictAttr, mergeListAttr, noAttributeError, object___subclasshook__, readonlyAttributeError, runsupportedopMessage, setDict, setType, unsupportedopMessage
-
-
-
-
Method Detail
-
keys
public org.python.core.PyList keys()
- Returns:
- A list of keys
-
values
public org.python.core.PyList values()
- Returns:
- a list of values
-
items
public org.python.core.PyList items()
- Returns:
- a list of items; should be a PyTuple consisting of key: value pairs
-
get
public org.python.core.PyObject get(org.python.core.PyObject pyKey, org.python.core.PyObject def)Description copied from interface:JythonMapGet the value for the specified key, ordefaultif the key was not present.- Parameters:
pyKey- The pyKey, which may be a string (PyObject.asString()or a numeric index (PyObject.asInt()
-
clear
public void clear()
Description copied from interface:MutableJythonMapSet every value in this mapping to null.- Specified by:
clearin interfaceMutableJythonMap- Specified by:
clearin classAbstractMutableJythonMap
-
pop
public org.python.core.PyObject pop(org.python.core.PyObject pyKey) throws org.python.core.PyExceptionDescription copied from interface:MutableJythonMapReturns the value specified bypyKeyin the mapping, and deletes that entry.- Specified by:
popin interfaceMutableJythonMap- Specified by:
popin classAbstractMutableJythonMap- Throws:
org.python.core.PyException-Py.KeyErrorif the pyKey is not present in the map.
-
popitem
public org.python.core.PyObject popitem()
Description copied from interface:MutableJythonMapReturns an arbitrary (not guaranteed random, nor guaranteed last) item (PyTuple key: value pair) from the dictionary, and removes that item from the mapping.- Specified by:
popitemin interfaceMutableJythonMap- Specified by:
popitemin classAbstractMutableJythonMap
-
setdefault
public org.python.core.PyObject setdefault(org.python.core.PyObject pyKey, org.python.core.PyObject def)Description copied from interface:MutableJythonMapReturns the value ofpyKeyif it is already present in the map. If it is not, the value is added to the map withdef, and returns the value added to the map.- Specified by:
setdefaultin interfaceMutableJythonMap- Specified by:
setdefaultin classAbstractMutableJythonMap
-
update
public void update(org.python.core.PyObject[] args, java.lang.String[] keywords)Description copied from interface:MutableJythonMapUpdates this mapping, one of three possible ways:- with a set of keyword arguments; eg
{"a": 1}.update(b=2, c=3) == {"a": 1, "b": 2, * "c": 3} - with another dictionary directly
- with an iterable sequence of key:value pairs
- Specified by:
updatein interfaceMutableJythonMap- Specified by:
updatein classAbstractMutableJythonMap- Parameters:
args- arguments passed to this object. The second and third methods described above will pass a single PyObject in argskeywords- 1:1 with arguments
- with a set of keyword arguments; eg
-
__contains__
public boolean __contains__(org.python.core.PyObject pyKey)
- Specified by:
__contains__in interfaceJythonMap- Overrides:
__contains__in classorg.python.core.PyObject- Returns:
trueif the underlying map has the requisite key
-
__len__
public int __len__()
-
__finditem__
public org.python.core.PyObject __finditem__(java.lang.String key)
Description copied from interface:JythonMapLook up and return the specified key.- Specified by:
__finditem__in interfaceJythonMap- Overrides:
__finditem__in classorg.python.core.PyObject
-
__findattr_ex__
public org.python.core.PyObject __findattr_ex__(java.lang.String name)
- Overrides:
__findattr_ex__in classorg.python.core.PyObject
-
__setattr__
public void __setattr__(java.lang.String name, org.python.core.PyObject value)- Overrides:
__setattr__in classorg.python.core.PyObject
-
__setitem__
public void __setitem__(org.python.core.PyObject pyKey, org.python.core.PyObject pyValue)Description copied from interface:MutableJythonMapUpdate the map atpyKeywith new valuepyValue- Specified by:
__setitem__in interfaceMutableJythonMap- Specified by:
__setitem__in classAbstractMutableJythonMap
-
__delitem__
public void __delitem__(org.python.core.PyObject pyKey)
Description copied from interface:MutableJythonMapRemovepyKeyfrom the map.- Specified by:
__delitem__in interfaceMutableJythonMap- Specified by:
__delitem__in classAbstractMutableJythonMap
-
__delattr__
public void __delattr__(java.lang.String name)
- Overrides:
__delattr__in classorg.python.core.PyObject
-
-