MetadataRecordSummary Class

A class with a subset of information defined in MetadataRecord. The generated binary image of MetadataRecordSummary is sent back as a reply to PacketType3 and PacketType4.

Inheritance Hierarchy

SystemObject
GSF.Historian.FilesMetadataRecordSummary

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

Syntax

C++

JavaScript

Copy

public class MetadataRecordSummary : ISupportBinaryImage

Public Class MetadataRecordSummary
	Implements ISupportBinaryImage

public ref class MetadataRecordSummary : ISupportBinaryImage

type MetadataRecordSummary = 
    class
        interface ISupportBinaryImage
    end

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

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

View Source

The MetadataRecordSummary type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	BinaryLength	Gets the length of the MetadataRecordSummary.
	Enabled	Same as Enabled.
	ExceptionLimit	Same as ExceptionLimit.
	HighAlarm	Same as HighAlarm.
	HighRange	Same as HighRange.
	HighWarning	Same as HighWarning.
	HistorianID	Same as HistorianID.
	LowAlarm	Same as LowAlarm.
	LowRange	Same as LowRange.
	LowWarning	Same as LowWarning.

Top

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 MetadataRecordSummary 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 MetadataRecordSummary from the specified buffer.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Fields

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

Top

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)

Top

Reference

GSF.Historian.Files Namespace

MetadataRecord