IntercomRecord Class

Represents a record in the IntercomFile that contains runtime information of a historian.

Inheritance Hierarchy

SystemObject
GSF.Historian.FilesIntercomRecord

Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.257-beta

Syntax

public class IntercomRecord : ISupportBinaryImage

Public Class IntercomRecord
	Implements ISupportBinaryImage

public ref class IntercomRecord : ISupportBinaryImage

type IntercomRecord = 
    class
        interface ISupportBinaryImage
    end

GSF.Historian.Files.IntercomRecord = function();

Type.createClass(
	'GSF.Historian.Files.IntercomRecord',
	null,
	GSF.Parsing.ISupportBinaryImage);

The IntercomRecord type exposes the following members.

Constructors

	Name	Description
	IntercomRecord(Int32)	Initializes a new instance of the IntercomRecord class.
	IntercomRecord(Int32, Byte, Int32, Int32)	Initializes a new instance of the IntercomRecord class.

Properties

	Name	Description
	BinaryLength	Gets the length of the IntercomRecord.
	DataBlocksUsed	Gets or sets the number of allocated ArchiveDataBlocks in the active ArchiveFile.
	LatestDataID	Gets or sets the historian identifier of latest ArchiveDataPoint received by the active ArchiveFile.
	LatestDataTime	Gets or sets the TimeTag of latest ArchiveDataPoint received by the active ArchiveFile.
	RecordID	Gets the ID of the IntercomRecord.
	RolloverInProgress	Gets or sets a boolean value that indicates whether the active ArchiveFile if being rolled-over.
	SourceLatestDataTime	Gets a list of TimeTags of the latest ArchiveDataPoint received from each of the SourceIDs.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GenerateBinaryImage	Generates binary image of the IntercomRecord and copies it into the given buffer, for BinaryLength bytes.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ParseBinaryImage	Initializes IntercomRecord from the specified buffer.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Fields

	Name	Description
	FixedLength	Specifies the number of bytes in the binary image of IntercomRecord.

Extension Methods

	Name	Description
	BinaryImage	Returns a binary image of an object that implements ISupportBinaryImage. (Defined by ISupportBinaryImageExtensions)
	CopyBinaryImageToStream	Copies binary image of object that implements ISupportBinaryImage to a Stream. (Defined by ISupportBinaryImageExtensions)
	CopyImage	This is a common optimized block copy function for any kind of data. (Defined by Common)
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	ParseBinaryImageFromStream	Parses binary image of object that implements ISupportBinaryImage from a Stream. (Defined by ISupportBinaryImageExtensions)