Skip to end of metadata
Go to start of metadata

The following sections describe the structure of some prominent objects returned or expected by Ignition system functions. Not all classes, fields, and methods are included in the lists below. For a fully comprehensive reference of all Ignition types, refer to the Javadocs in the Ignition SDK Programmers Guide.

Alarming

AlarmEvent

Used By: Alarm Pipelines, Tag Event Scripts, Vision Extension Functions

See Alarm Event Properties Reference.

AlarmQueryResult

Used By: system.alarm.queryStatussystem.alarm.queryJournal

The AlarmQueryResult object represents a collection of AlarmEvent objects with some additional helper methods.

Methods
NameReturnsDescription
getDataset()dataset

Returns the alarms as a dataset. Columns are:

  • Event Id (UUID of the alarm)
  • Source Path
  • Display Path
  • Event Time
  • State (integer)
  • Priority (integer)
  • IsSystemEvent (boolean)
getAssociatedData(String uuid)datasetReturns the associated data of an event as a dataset.
AlarmEvent(String uuid)alarmEventReturns the alarmEvent object for the specified event UUID.


ShelvedPath

Used By: system.alarm.getShelvedPaths

This class provides information about an alarm that has been "shelved", including the alarm path, when it was shelved, and by whom.

Methods
NameReturnsDescription
getPath()path

Returns a Path object representing the path to the alarm. Can be cast to a string.

getExpiration()dateReturns the time that the shelve expires.
getUser()QualifiedPathReturns the actual AlarmEvent object for the specified event UUID.
isExpired()booleanReturns True if the shelve has expired for the alarm; otherwise returns False.

On this page ...



Datasets and PyDatasets

Used By: Many facets of Ignition including queries, Vision and Perspective components, and Tags

See Datasets.






Tags

Results

Used By: system.tag.browsesystem.tag.browseHistoricalTags

Methods
NameReturnsDescription
getResults()list

Returns a list of node dictionaries, one for each Tag (including folders and UDT instances) in the result set. See Tag Dictionary Keys below for a summary of available keys in the Tag dictionaries.

getReturnedSize()integer

Returns the number of results contained in this object. If different than getTotalAvailableSize(), only a partial browse was performed, and the continuation point should be non-null.

Tag Dictionary Keys
All Nodes (Tags, Folders, UDT Definitions, and UDT Instances)
NameTypeDescription
fullPathBasicTagPath

A fully qualified Tag path to the node, including the name of the node. 

The value returned by this key is a BasicTagPath. However, Python's str() method can be used to convert the path to a string.

hasChildrenboolean

Represents whether the node contains sub-nodes, such as folders and UDT definitions.

namestringThe name of the node.
tagTypestring

The type of the node. Possible values are:

  • AtomicTag: Represents a standard Tag.
  • Folder: Represents a Tag folder.
  • UdtType: Represents a UDT definition.
  • UdtInstance: Represents a UDT instance.
Tags (tagType = AtomicTag)
NameTypeDescription
dataTypestringThe data type of the Tag.
valueSourcestringRepresents how the Tag derives its value.
value
VariesThe last known qualified value on the Tag. 
UDT Definitions and Instances (tagType = UdtType or UdtInstance)
NameTypeDescription
typeIdstring

Represents the parent data type for the UDT. 

UDT definitions without a specified parent type will have a value of None






Misc Objects

Qualified Value

Used By: Many facets of Ignition including Tag Event Scripts, various system.tag functions, and Perspective Property Change scripts

The QualifiedValue class is a representation of an Ignition value often used to represent a Tag's current condition (as in the result of a Tag read) and is meant to provide more context than a value alone. The properties and methods on a QualifiedValue object are as follows:

Properties
NameTypeDescription

value

variesThe data associated with the QualifiedValue object. Type depends on the type of the underlying value.
qualityqualityCodeThe quality associated with the returned value. See QualityCode.
timestampdateThe time associated with the returned value. 
Methods
NameReturnsDescription
getValue()variesGets the data associated with the QualifiedValue object. Type depends on the type of the underlying value.
getQuality()qualityCodeGets the quality associated with the returned value. See QualityCode.
getTimestamp()dateGets the time associated with the returned value. 

QualityCode

Used By: QualifiedValue Objects

The QualityCode class describes a quality for a value.

Methods
NameReturnsDescription
getCode()integer

Returns the 32-bit integer code associated with the quality. For more information on quality codes, including a list of available codes, see Quality Codes and Overlays.

getDiagnosticMessage()stringReturns the diagnostic message associated with this quality, if present. Otherwise, returns None.
isGood()booleanReturns True if this code represents a Good quality level. Otherwise, returns False.
isUncertain()booleanReturns True if this code represents an Uncertain quality level. Otherwise, returns False. Note that Bad and Error quality levels return False.
isBad()booleanReturns True if this code represents a Bad quality level. Otherwise, returns False. Note that Uncertain and Error quality levels return False.
isError()booleanReturns True if this code represents an Error quality level. Otherwise, returns False. Note that Bad and Uncertain quality levels return False.
isNotGood()booleanReturns True if this code represents an Uncertain, Bad, or Error quality level. Otherwise, returns False.
isBadOrError()booleanReturns True if this code represents a Bad or Error quality level. Otherwise, returns False.
toValue()QualifiedValueReturns this quality as the quality component of a QualifiedValue object.
is(QualityCode other)booleanCompares the integer quality codes of another QualityCode object to this one. Returns True if they match.
isNot(QualityCode other)booleanCompares the integer quality codes of another QualityCode object to this one. Returns True if they do not match.



  • No labels