MetadataRecordGeneralFlags Class

Defines general boolean settings for a MetadataRecord.

Inheritance Hierarchy

SystemObject
GSF.Historian.FilesMetadataRecordGeneralFlags

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

Syntax

public class MetadataRecordGeneralFlags

Public Class MetadataRecordGeneralFlags

public ref class MetadataRecordGeneralFlags

type MetadataRecordGeneralFlags = class end

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

Type.createClass(
	'GSF.Historian.Files.MetadataRecordGeneralFlags');

The MetadataRecordGeneralFlags type exposes the following members.

Constructors

	Name	Description
	MetadataRecordGeneralFlags	Initializes a new instance of the MetadataRecordGeneralFlags class

Properties

	Name	Description
	AlarmByEmail	Gets or sets a boolean value that indicates whether email alarm notifications are to be sent for the MetadataRecord.
	AlarmByPager	Gets or sets a boolean value that indicates whether text alarm notifications are to be sent for the MetadataRecord.
	AlarmByPhone	Gets or sets a boolean value that indicates whether voice alarm notifications are to be sent for the MetadataRecord.
	AlarmEnabled	Gets or sets a boolean value that indicates whether alarm notifications are enabled for the MetadataRecord.
	AlarmToFile	Gets or sets a boolean value that indicates whether alarm notifications for the MetadataRecord are to be logged to a text file.
	Changed	Gets or sets a boolean value that indicates whether the MetadataRecord has been modified.
	DataType	Gets or sets the DataType of archived data for the MetadataRecord.
	Enabled	Gets or sets a boolean value that indicates whether the MetadataRecord is currently enabled for archival of new data.
	StepCheck	Gets or sets a boolean value that indicates whether a "step change" operation is to be performed on incoming time-series data for the MetadataRecord.
	Used	Gets or sets a boolean value that indicates whether the MetadataRecord is being used (need to be verify).
	Value	Gets or sets the 32-bit integer value used for defining general boolean settings for a MetadataRecord.

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

Extension Methods

	Name	Description
	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)