C# Class GSF.PQDIF.Logical.ObservationRecord

Represents an observation record in a PQDIF file.
Show file Open project: GridProtectionAlliance/gsf Class Usage Examples

Public Properties

Property Type Description
ChannelInstancesTag System.Guid
ObservationNameTag System.Guid
OneChannelInstanceTag System.Guid
TimeCreateTag System.Guid
TimeStartTag System.Guid
TriggerMethodTag System.Guid

Public Methods

Method Description
AddNewChannelInstance ( ) : ChannelInstance

Adds a new channel instance to the collection of channel instances in this observation record.
CreateObservationRecord ( GSF.PQDIF.Physical.Record physicalRecord, DataSourceRecord dataSource, GSF.PQDIF.Logical.MonitorSettingsRecord settings ) : ObservationRecord

Creates a new observation record from the given physical record if the physical record is of type observation. Returns null if it is not.
Remove ( ChannelInstance channelInstance ) : void

Removes the given channel instance from the collection of channel instances.

Private Methods

Method Description
ObservationRecord ( GSF.PQDIF.Physical.Record physicalRecord, DataSourceRecord dataSource, GSF.PQDIF.Logical.MonitorSettingsRecord settings ) : System

Creates a new instance of the ObservationRecord class.

Method Details

AddNewChannelInstance() public method

Adds a new channel instance to the collection of channel instances in this observation record.
public AddNewChannelInstance ( ) : ChannelInstance
return ChannelInstance

CreateObservationRecord() public static method

Creates a new observation record from the given physical record if the physical record is of type observation. Returns null if it is not.
public static CreateObservationRecord ( GSF.PQDIF.Physical.Record physicalRecord, DataSourceRecord dataSource, GSF.PQDIF.Logical.MonitorSettingsRecord settings ) : ObservationRecord
physicalRecord GSF.PQDIF.Physical.Record The physical record used to create the observation record.
dataSource DataSourceRecord The data source record that defines the channels in this observation record.
settings GSF.PQDIF.Logical.MonitorSettingsRecord The monitor settings to be applied to this observation record.
return ObservationRecord

Remove() public method

Removes the given channel instance from the collection of channel instances.
public Remove ( ChannelInstance channelInstance ) : void
channelInstance ChannelInstance The channel instance to be removed.
return void

Property Details

ChannelInstancesTag public static property

Tag that identifies the channel instances collection.
public static Guid,System ChannelInstancesTag
return System.Guid

ObservationNameTag public static property

Tag that identifies the name of the observation record.
public static Guid,System ObservationNameTag
return System.Guid

OneChannelInstanceTag public static property

Tag that identifies a single channel instance in the collection.
public static Guid,System OneChannelInstanceTag
return System.Guid

TimeCreateTag public static property

Tag that identifies the time that the observation record was created.
public static Guid,System TimeCreateTag
return System.Guid

TimeStartTag public static property

Tag that identifies the start time of the data in the observation record.
public static Guid,System TimeStartTag
return System.Guid

TriggerMethodTag public static property

Tag that identifies the type of trigger that caused the observation.
public static Guid,System TriggerMethodTag
return System.Guid