Package com.inductiveautomation.perspective.gateway.script

Class SessionScriptWrapper.SafetyWrapper

java.lang.Object

com.inductiveautomation.perspective.gateway.script.SessionScriptWrapper.SafetyWrapper

All Implemented Interfaces:

PropertyTreeOwner

Enclosing class:

SessionScriptWrapper

public static class SessionScriptWrapper.SafetyWrapper
extends java.lang.Object

Delegates to the actual view, this prevents the scripting system from being able to call everything on ViewModel, like startup(), shutdown, etc.

Also gives us a good place to implement methods that make sense for script authors, that don't belong on the the model object, like more user friendly versions of getChild

Field Summary

Fields

Modifier and Type	Field	Description
protected PerspectiveElement	element

Constructor Summary

Constructors

Constructor	Description
SafetyWrapper(Session session)

Method Summary

Modifier and Type	Method	Description
void	close()
void	close(java.lang.String message)
org.python.core.PyObject	getInfo()
java.lang.String	getName()
Page	getPage()
Page	getPage(java.lang.String id)
java.util.List<? extends Page>	getPages()
java.lang.String	getProject()
org.python.core.PyObject	getProjectInfo()
PropertyTree	getPropertyTreeOf(PropertyType propertyType)	Fetch the PropertyTree associated with the given PropertyType
Session	getSession()
View	getView()
org.python.core.PyObject	invokeOnQueue(org.python.core.PyObject func)	Invokes a python script on the queue.
void	print(java.lang.String message)
boolean	refreshBinding(java.lang.String propertyStr)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

element

protected final PerspectiveElement element

Constructor Detail

SafetyWrapper

public SafetyWrapper(Session session)

Method Detail

getProject

public java.lang.String getProject()

getProjectInfo

public org.python.core.PyObject getProjectInfo()

refreshBinding

public boolean refreshBinding(java.lang.String propertyStr)
                       throws java.lang.Throwable

Throws:

java.lang.Throwable

getInfo

public org.python.core.PyObject getInfo()

Returns:

info about this session. Note that the return format matches the format of system.perspective.getSessionInfos() except that this object does include the pages array.

getPage

@Nullable
public Page getPage(java.lang.String id)

getPages

public java.util.List<? extends Page> getPages()

close

public void close()

close

public void close(@Nullable
                  java.lang.String message)

invokeOnQueue

public org.python.core.PyObject invokeOnQueue(org.python.core.PyObject func)
                                       throws java.lang.Exception

Invokes a python script on the queue. In general this is a big no-no, but it can be useful in certain circumstances where you need atomicity across multiple statements with respect to changes to property trees. For example, an atomic increment. We use this method for testing. Not documented for customer use.

Throws:

java.lang.Exception

getPropertyTreeOf

@Nullable
public PropertyTree getPropertyTreeOf(@Nullable
                                      PropertyType propertyType)

Description copied from interface: PropertyTreeOwner

Fetch the PropertyTree associated with the given PropertyType

Specified by:

getPropertyTreeOf in interface PropertyTreeOwner

Parameters:

propertyType - The PropertyType of the PropertyTree we want to fetch

Returns:

The PropertyTree or null if this PropertyTreeOwner does not manage a PropertyTree for the given PropertyType or if a null PropertyType is given

print

public void print(java.lang.String message)

getView

public View getView()

getSession

public Session getSession()

getPage

public Page getPage()

getName

public java.lang.String getName()