DataLogTrigger class

An element included in a Task and contains information about which ProcessDataVariables values shall be logged as DataLogValues during task processing.

The reference to the deviceElementIdRef can be added on the mobile system, as soon as a Device is allocated to the Task. When the reference to the DeviceElement is already given at FMIS then a specific device was planned for the task. The attributes of the DataLogTrigger define the behaviour of the task controller, regarding how to collect and store the ProcessDataVariable values.

The data log methods time interval, distance interval and on change can be used in any combination. The logging is triggered by the event that occurs first, and all active methods of these three data log methods are then restarted. Additionally, the threshold limits method can be added. With this addition, the logging is triggered when the logging value enters the value range specified by the threshold limit definitions and is enabled as long as the value is within the value range specified by the threshold limit definitions.

If the thresholdMinimum is smaller than the thresholdMaximum, data logging is enabled when the value is between the thresholdMinimum and the thresholdMaximum. If the thresholdMinimum is larger than the thresholdMaximum, data logging is enabled when the value is larger than the thresholdMinimum or smaller than the thresholdMaximum.

The data log method counter is independent of the other data log methods and can be used with any combination described above. DataLogValues of the type counter shall be stored once per task in the data transfer file.

A maximum of 10 messages per process data variable per second can be transmitted by a device.

Values from Parameter Group Numbers can be logged by specification of the attributes pgn, pgnStartBit and pgnStopBit. When these attributes are specified, the ddi attribute shall be set to DFFE (PGN logvalue).

Inheritance
Mixed-in types
Available extensions
Annotations

Constructors

DataLogTrigger.new({required String ddi, required int method, int? distanceInterval, int? timeInterval, int? thresholdMinimum, int? thresholdMaximum, int? thresholdChange, String? deviceElementIdRef, String? valuePresentationIdRef, int? pgn, int? pgnStartBit, int? pgnStopBit, List<XmlAttribute>? customAttributes})
Default factory for creating a DataLogTrigger with verified arguments.
factory
DataLogTrigger.fromXmlElement(XmlElement element)
Creates a DataLogTrigger from element.
factory

Properties

copyWith → _$DataLogTriggerCWProxy

Available on DataLogTrigger, provided by the $DataLogTriggerCopyWith extension

Returns a callable class that can be used as follows: instanceOfDataLogTrigger.copyWith(...) or like so:instanceOfDataLogTrigger.copyWith.fieldName(...).
no setter
customAttributes → List<XmlAttribute>?
XML attributes that exist in the files but are not part of the standard.
finalinherited
ddi → String
A unique Data Dictionary Identifier which identifies a ProcessDataVariable.
final
description → String
A short description of the element type.
finalinherited
deviceElementIdRef → String?
ID reference to the DeviceElement this log value was supplied by.
final
distanceInterval → int?
Distance interval for data log in millimeters.
final
elementType → Iso11783ElementType
Which type of ISO 11783-10 element this is based on the XML tag.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String?
The ID of this, if it has one;
no setterinherited
idRefPattern → String?
The ID reference pattern (regExp) for id if there is one.
no setterinherited
method → int
Selection of the log method:
final
onlyVersion4AndAbove → bool
Whether this element type is only supported in version 4 and above.
finalinherited
pgn → int?
Parameter Group Number to log a value from.
final
pgnStartBit → int?
First bit of the value to log from a Parameter Group Number.
final
pgnStopBit → int?
Stop bit of the value to log from a Parameter Group Number.
final
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setteroverride
recursiveChildren → Iterable<Iso11783Element>?
All the element children connected to this, and their children recursively.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selfWithRecursiveChildren → Iterable<Iso11783Element>
All the element children connected to this, and their children recursively.
no setterinherited
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
thresholdChange → int?
Change threshold to activate the data log. 0 stops measurement, 1 lags each change.
final
thresholdMaximum → int?
Maximum threshold to activate the data log.
final
thresholdMinimum → int?
Minimum threshold to activate the data log.
final
timeInterval → int?
Time interval for data lag in milliseconds.
final
valuePresentationIdRef → String?
ID reference to the ValuePresentation to use with this log.
final

Methods

buildXmlChildren(XmlBuilder builder, {Map<String, String> namespaces = const {}}) → void
Builds the XML children of this on the builder.
buildXmlElement(XmlBuilder builder, {Map<String, String> namespaces = const {}}) → void
inherited
mapPropsToString(Type runtimeType, List<Object?> props) → String
Returns a string for props.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
toXmlAttributes({Map<String, String?> namespaces = const {}}) → List<XmlAttribute>
Returns a list of the XML attributes of this.
toXmlChildren({Map<String, String?> namespaces = const {}}) → List<XmlNode>
inherited
toXmlElement({Map<String, String?> namespaces = const {}}) → XmlElement
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited