ConnectionParameters Class

Represents the extra connection parameters required for a connection to a BPA PDCstream.

Inheritance Hierarchy

SystemObject
GSF.PhasorProtocolsConnectionParametersBase
GSF.PhasorProtocols.BPAPDCstreamConnectionParameters

Namespace: GSF.PhasorProtocols.BPAPDCstream
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.257-beta

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public class ConnectionParameters : ConnectionParametersBase

<SerializableAttribute>
Public Class ConnectionParameters
	Inherits ConnectionParametersBase

[SerializableAttribute]
public ref class ConnectionParameters : public ConnectionParametersBase

[<SerializableAttribute>]
type ConnectionParameters = 
    class
        inherit ConnectionParametersBase
    end

GSF.PhasorProtocols.BPAPDCstream.ConnectionParameters = function();

Type.createClass(
	'GSF.PhasorProtocols.BPAPDCstream.ConnectionParameters',
	GSF.PhasorProtocols.ConnectionParametersBase);

View Source

The ConnectionParameters type exposes the following members.

Constructors

	Name	Description
	ConnectionParameters	Creates a new ConnectionParameters.
	ConnectionParameters(SerializationInfo, StreamingContext)	Creates a new ConnectionParameters from serialization parameters.

Top

Properties

	Name	Description
	ConfigurationFileName	Gets or sets required external BPA PDCstream INI based configuration file.
	ParseWordCountFromByte	Gets or sets flag that interprets word count in packet header from a byte instead of a word.
	RefreshConfigurationFileOnChange	Gets or sets flag that determines if configuration file is automatically reloaded when it has changed on disk.
	UsePhasorDataFileFormat	Gets or sets flag that determines if source data is in the Phasor Data File Format (i.e., a DST file).
	ValuesAreValid	Determines if selected BPA PDCstream configuration file exists. (Overrides ConnectionParametersBaseValuesAreValid)

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)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object. (Overrides ConnectionParametersBaseGetObjectData(SerializationInfo, StreamingContext))
	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)

Top

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)

Top

Remarks

This class is designed to be exposed by a "PropertyGrid" so a UI can request protocol specific connection parameters. As a result the CategoryAttribute and DescriptionAttribute elements should be defined for each of the exposed properties.

Reference

GSF.PhasorProtocols.BPAPDCstream Namespace