com.inductiveautomation.ignition.common.script

Class ProjectScriptDiagnostic

java.lang.Object

com.inductiveautomation.ignition.common.script.ProjectScriptDiagnostic

public class ProjectScriptDiagnostic
extends java.lang.Object

Used in the gateway status section to show information about gateway-run project scripts.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MESSAGE_HANDLER
static int	SHUTDOWN
static int	STARTUP
static int	TAG_CHANGE
static int	TIMER

Constructor Summary

Constructors

Constructor and Description
ProjectScriptDiagnostic(int type, java.lang.String name, java.lang.String projectName, boolean enabled, ScriptExecutionReport executionReport)

Method Summary

Modifier and Type	Method and Description
java.lang.String	get(java.lang.String key) Get some useful information about the script, depending on its type.
java.util.Map<java.lang.String,java.lang.String>	getDetails()
java.lang.Long	getDuration() The duration of the last execution of this script, in ms.
java.lang.String	getErrorMessage() The last error message produced when this script was executed.
java.lang.Long	getLastExecution() The timestamp when this script last executed, in ms.
java.lang.String	getName()
java.lang.String	getProjectName()
int	getType()
boolean	isEnabled()
void	put(java.lang.String key, java.lang.String value)

Methods inherited from class java.lang.Object

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

Field Detail

STARTUP

public static final int STARTUP

See Also:

Constant Field Values

SHUTDOWN

public static final int SHUTDOWN

See Also:

Constant Field Values

TIMER

public static final int TIMER

See Also:

Constant Field Values

TAG_CHANGE

public static final int TAG_CHANGE

See Also:

Constant Field Values

MESSAGE_HANDLER

public static final int MESSAGE_HANDLER

See Also:

Constant Field Values

Constructor Detail

ProjectScriptDiagnostic

public ProjectScriptDiagnostic(int type,
                               java.lang.String name,
                               java.lang.String projectName,
                               boolean enabled,
                               ScriptExecutionReport executionReport)

Method Detail

getType

public int getType()

getName

public java.lang.String getName()

get

public java.lang.String get(java.lang.String key)

Get some useful information about the script, depending on its type.

getDetails

public java.util.Map<java.lang.String,java.lang.String> getDetails()

put

public void put(java.lang.String key,
                java.lang.String value)

getProjectName

public java.lang.String getProjectName()

getLastExecution

public java.lang.Long getLastExecution()

The timestamp when this script last executed, in ms.

Returns:

getDuration

public java.lang.Long getDuration()

The duration of the last execution of this script, in ms.

Returns:

null if the script has not run.

getErrorMessage

public java.lang.String getErrorMessage()

The last error message produced when this script was executed.

Returns:

null if the script has not run, or if there was no error.

isEnabled

public boolean isEnabled()