Package com.inductiveautomation.ignition.common

Class WellKnownPathTypes

java.lang.Object

com.inductiveautomation.ignition.common.WellKnownPathTypes

public class WellKnownPathTypes
extends Object

These are path identifiers used by QualifiedPath for the well-known objects in Ignition.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	Alarm
static final String	Driver	The driver is the driving gateway name, sometimes with the provider, separated by ":".
static final String	Event	A particular event, in the context of the system or parent path.
static final String	HistoryProvider
static final String	Machine	The Machine ID of the physical server running Ignition.
static final String	Project	Fairly self explanatory.
static final String	Property
static final String	Provider	Can refer to different types of providers, depends on the following object for context.
static final String	Source	The source indicates where a remote event of some kind originated, ideally in a unique way.
static final String	System	The id of the particular Ignition
static final String	Tag	A path to a tag
static final String	User
static final String	UserProfile

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

Machine

public static final String Machine

The Machine ID of the physical server running Ignition.

See Also:

• Constant Field Values

System

public static final String System

The id of the particular Ignition

See Also:

• Constant Field Values

Tag

public static final String Tag

A path to a tag

See Also:

• Constant Field Values

Alarm

public static final String Alarm

See Also:

• Constant Field Values

Event

public static final String Event

A particular event, in the context of the system or parent path.

See Also:

• Constant Field Values

Provider

public static final String Provider

Can refer to different types of providers, depends on the following object for context.

See Also:

• Constant Field Values

HistoryProvider

public static final String HistoryProvider

See Also:

• Constant Field Values

Driver

public static final String Driver

The driver is the driving gateway name, sometimes with the provider, separated by ":". In other words: gatewayName[:providerName]

See Also:

• Constant Field Values

UserProfile

public static final String UserProfile

See Also:

• Constant Field Values

User

public static final String User

See Also:

• Constant Field Values

Property

public static final String Property

See Also:

• Constant Field Values

Source

public static final String Source

The source indicates where a remote event of some kind originated, ideally in a unique way.

See Also:

• Constant Field Values

Project

public static final String Project

Fairly self explanatory. Not often used in paths, but useful for logging.

See Also:

• Constant Field Values