Click or drag to resize

MetadataRecordComposedFields Class

Defines specific fields for MetadataRecords that are of type Composed.
Inheritance Hierarchy
SystemObject
  GSF.Historian.FilesMetadataRecordComposedFields

Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.218-beta
Syntax
public class MetadataRecordComposedFields : ISupportBinaryImage
View Source

The MetadataRecordComposedFields type exposes the following members.

Properties
 NameDescription
Public propertyBinaryLength Gets the length of the MetadataRecordComposedFields.
Public propertyCompressionLimit Gets or sets the amount, expressed in EngineeringUnits, by which data values for the MetadataRecord must changed before being archived.
Public propertyDisplayDigits Gets or sets the number of digits after the decimal point to be displayed for the MetadataRecord.
Public propertyEngineeringUnits Gets or sets the engineering units of archived data values for the MetadataRecord.
Public propertyEquation Gets or sets the mathematical equation used for calculating the data value for the MetadataRecord.
Public propertyHighAlarm Gets or sets the value above which archived data for the MetadataRecord is assigned a quality of ValueAboveHiHiAlarm.
Public propertyHighRange Gets or sets the value above which archived data for the MetadataRecord is assigned a quality of UnreasonableHigh.
Public propertyHighWarning Gets or sets the value above which archived data for the MetadataRecord is assigned a quality of ValueAboveHiAlarm.
Public propertyInputPointers Gets or sets the historian identifiers being used in the Equation.
Public propertyLowAlarm Gets or sets the value above which archived data for the MetadataRecord is assigned a quality of ValueBelowLoLoAlarm.
Public propertyLowRange Gets or sets the value above which archived data for the MetadataRecord is assigned a quality of UnreasonableLow.
Public propertyLowWarning Gets or sets the value above which archived data for the MetadataRecord is assigned a quality of ValueBelowLoAlarm.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGenerateBinaryImage Generates binary image of the MetadataRecordComposedFields and copies it into the given buffer, for BinaryLength bytes.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodParseBinaryImage Initializes MetadataRecordComposedFields from the specified buffer.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
 NameDescription
Public fieldStatic memberFixedLength Specifies the number of bytes in the binary image of MetadataRecordComposedFields.
Top
Extension Methods
 NameDescription
Public Extension MethodBinaryImage Returns a binary image of an object that implements ISupportBinaryImage.
(Defined by ISupportBinaryImageExtensions)
Public Extension MethodCopyBinaryImageToStream Copies binary image of object that implements ISupportBinaryImage to a Stream.
(Defined by ISupportBinaryImageExtensions)
Public Extension MethodCopyImage This is a common optimized block copy function for any kind of data.
(Defined by Common)
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodParseBinaryImageFromStream Parses binary image of object that implements ISupportBinaryImage from a Stream.
(Defined by ISupportBinaryImageExtensions)
Top
See Also