C# Class GSF.PQDIF.Logical.DataSourceRecord

Represents a data source record in a PQDIF file. The data source record contains information about the source of the data in an ObservationRecord.
Show file Open project: GridProtectionAlliance/gsf Class Usage Examples

Public Properties

Property Type Description
ChannelDefinitionsTag System.Guid
DataSourceCoordinatesTag System.Guid
DataSourceNameTag System.Guid
DataSourceTypeTag System.Guid
EffectiveTag System.Guid
EquipmentIDTag System.Guid
OneChannelDefinitionTag System.Guid
VendorIDTag System.Guid

Public Methods

Method Description
AddNewChannelDefinition ( ) : ChannelDefinition

Adds a new channel definition to the collection of channel definitions in this data source record.
CreateDataSourceRecord ( GSF.PQDIF.Physical.Record physicalRecord ) : DataSourceRecord

Creates a new data source record from the given physical record if the physical record is of type data source. Returns null if it is not.
Remove ( ChannelDefinition channelDefinition ) : void

Removes the given channel definition from the collection of channel definitions.
RemoveElement ( System.Guid tag ) : void

Removes the element identified by the given tag from the record.

Private Methods

Method Description
DataSourceRecord ( GSF.PQDIF.Physical.Record physicalRecord ) : System

Creates a new instance of the DataSourceRecord class.

Method Details

AddNewChannelDefinition() public method

Adds a new channel definition to the collection of channel definitions in this data source record.
public AddNewChannelDefinition ( ) : ChannelDefinition
return ChannelDefinition

CreateDataSourceRecord() public static method

Creates a new data source record from the given physical record if the physical record is of type data source. Returns null if it is not.
public static CreateDataSourceRecord ( GSF.PQDIF.Physical.Record physicalRecord ) : DataSourceRecord
physicalRecord GSF.PQDIF.Physical.Record The physical record used to create the data source record.
return DataSourceRecord

Remove() public method

Removes the given channel definition from the collection of channel definitions.
public Remove ( ChannelDefinition channelDefinition ) : void
channelDefinition ChannelDefinition The channel definition to be removed.
return void

RemoveElement() public method

Removes the element identified by the given tag from the record.
public RemoveElement ( System.Guid tag ) : void
tag System.Guid The tag of the element to be removed.
return void

Property Details

ChannelDefinitionsTag public static property

Tag that identifies the channel definitions collection.
public static Guid,System ChannelDefinitionsTag
return System.Guid

DataSourceCoordinatesTag public static property

Tag that identifies the physical location of the data source.
public static Guid,System DataSourceCoordinatesTag
return System.Guid

DataSourceNameTag public static property

Tag that identifies the data source name.
public static Guid,System DataSourceNameTag
return System.Guid

DataSourceTypeTag public static property

Tag that identifies the data source type.
public static Guid,System DataSourceTypeTag
return System.Guid

EffectiveTag public static property

Tag that identifies the time that the data source record becomes effective.
public static Guid,System EffectiveTag
return System.Guid

EquipmentIDTag public static property

Tag that identifies the equipment ID.
public static Guid,System EquipmentIDTag
return System.Guid

OneChannelDefinitionTag public static property

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

VendorIDTag public static property

Tag that identifies the vendor ID.
public static Guid,System VendorIDTag
return System.Guid