Package com.inductiveautomation.ignition.common.model

Class ApplicationScope

java.lang.Object

com.inductiveautomation.ignition.common.model.ApplicationScope

public final class ApplicationScope
extends Object

Various parts of the system allow operations to be filtered based on "scope". This class defines various values and masks that can be used as those parameters.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALL
static final int	CLIENT
static final int	DESIGNER
static final int	GATEWAY
static final int	NONE

Method Summary

Modifier and Type	Method	Description
static int	getGlobalScope()	Returns the scope of this jvm, wherever it may be.
static String	getScopePrefix()	Returns the current jvm's scope prefix, for use in thread names.
static void	init(int globalScope)
static boolean	isClient(int scope)
static boolean	isDesigner(int scope)
static boolean	isGateway(int scope)
static int	parseScope(String s)	Returns a bitmask representing application scope for strings like:
static String	toCode(int scope)	Turns a scope int into the various scope codes: "C"= client, "DC"= designer or client, "G"= gateway, "N"=none, "A"=all.
static String	toString(int scope)
static String	toString(Integer scope, Locale locale)

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static final int NONE

See Also:

• Constant Field Values

GATEWAY

public static final int GATEWAY

See Also:

• Constant Field Values

DESIGNER

public static final int DESIGNER

See Also:

• Constant Field Values

CLIENT

public static final int CLIENT

See Also:

• Constant Field Values

ALL

public static final int ALL

See Also:

• Constant Field Values

Method Details

parseScope

public static int parseScope(@Nullable
 String s)

Returns a bitmask representing application scope for strings like:

"C"= client, "DC"= designer or client, "G"= gateway, "N"=none, "A"=all

init

public static void init(int globalScope)

getGlobalScope

public static int getGlobalScope()

Returns the scope of this jvm, wherever it may be. Some code (such as code in common) doesn't know where it will end up running, and this is one way to tell where you are.

getScopePrefix

public static String getScopePrefix()

Returns the current jvm's scope prefix, for use in thread names. "gateway", "designer" or "client"

isGateway

public static boolean isGateway(int scope)

isClient

public static boolean isClient(int scope)

isDesigner

public static boolean isDesigner(int scope)

toString

public static String toString(int scope)

toString

public static String toString(Integer scope,
 Locale locale)

toCode

public static String toCode(int scope)

Turns a scope int into the various scope codes: "C"= client, "DC"= designer or client, "G"= gateway, "N"=none, "A"=all. Scope codes can be combined (such as "CD"), but "A" is always returned instead of "CDG"