TimeLog class

An element for collecting DataLogValues from external binary files.

Time elements are used as embedded lists inside the data transfer file or as a time template specification in the TimeLog element. TimeLog enables the collection of all DataLogValues in a binary-coded data log file. Within the TimeLog element, the TimeType attribute of the Time element shall be set to TimeType.effective. The type attribute is defined to enable future expansion of the data logging method. The value of the type shall be set a value of TimeLogType.binaryTimeLogFileType1 for the current data logging method.

TimeLog is always related to a Task and refers to a set of two files of a unique name. Both files shall exist in the same folder as the data transfer file. The name of the files shall be unique over all TimeLogs referred to by all tasks of a data transfer file.

Inheritance

Available extensions

$TimeLogCopyWith

Annotations

@CopyWith()
@XmlRootElement(name: 'TLG')
@XmlSerializable(createMixin: true)

Constructors

TimeLog.new({required String filename, int? fileLength, TimeLogType type = TimeLogType.binaryTimeLogFileType1, Uint8List? byteData, TimeLogHeader? header, List<Time>? records, List<XmlAttribute>? customAttributes}): Default factory for creating a TimeLog with verified arguments.
factory
TimeLog.fromXmlElement(XmlElement element): Creates a TimeLog from element.
factory

Properties

byteData ↔ Uint8List: Byte data from the file at filename.
getter/setter pair
copyWith → _$TimeLogCWProxy: Available on TimeLog, provided by the $TimeLogCopyWith extension
Returns a callable class that can be used as follows: instanceOfTimeLog.copyWith(...) or like so:instanceOfTimeLog.copyWith.fieldName(...).
no setter
customAttributes → List<XmlAttribute>?: XML attributes that exist in the files but are not part of the standard.
finalinherited
description → String: A short description of the element type.
finalinherited
elementType → Iso11783ElementType: Which type of ISO 11783-10 element this is based on the XML tag.
finalinherited
fileLength ↔ int?: Byte length of the TimeLog file.
getter/setter pair
filename → String: Unique name for the TimeLog file.
final
hashCode → int: The hash code for this object.
no setterinherited
header ↔ TimeLogHeader?: A header that describes the data format in the byteData.
getter/setter pair
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
onlyVersion4AndAbove → bool: Whether this element type is only supported in version 4 and above.
finalinherited
props → List<Object?>: The list of properties that will be used to determine whether two instances are equal.
no setter
records → List<Time>: Logged Time records for this.
final
recursiveChildren → Iterable<Iso11783Element>?: All the element children connected to this, and their children recursively.
no setteroverride
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
type → TimeLogType: Which type the TimeLog file is.
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
parseData() → List<Time>?: Returns byteData parsed with header to a log of Time records.
recordsToBytes() → Uint8List?: Converts records to bytes ready to be saved as a TLG-----.BIN file.
toString() → String: Returns a string for props.
override
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

Constants

fileNamePattern → const String: Regular expression matching pattern for the filename of this.