Package com.inductiveautomation.ignition.gateway.clientcomm

Enum Class MutabilityMode

java.lang.Object

java.lang.Enum<MutabilityMode>

com.inductiveautomation.ignition.gateway.clientcomm.MutabilityMode

All Implemented Interfaces:

Serializable, Comparable<MutabilityMode>, Constable

public enum MutabilityMode
extends Enum<MutabilityMode>

Mutability mode represents how a session should interact with external sources of data, such as tags or databases.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
OFF	Don't communicate with sources at all
READ_ONLY	Only read values, don't alter them
READ_WRITE	Full read and write access enabled.

Method Summary

Modifier and Type	Method	Description
boolean	canRead()
boolean	canWrite()
static MutabilityMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MutabilityMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OFF

public static final MutabilityMode OFF

Don't communicate with sources at all

READ_ONLY

public static final MutabilityMode READ_ONLY

Only read values, don't alter them

READ_WRITE

public static final MutabilityMode READ_WRITE

Full read and write access enabled.

Method Details

values

public static MutabilityMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MutabilityMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

canRead

public boolean canRead()

Returns:

false if the designer session has its gateway comm mode set to "off". Avoid reading from data sources.

canWrite

public boolean canWrite()

Returns:

false if the designer session has its gateway comm mode set to "off" or "read-only". Avoid writing back to data sources.