Click or drag to resize

AdapterBase Methods

The AdapterBase type exposes the following members.

Methods
  Name Description
Public method Dispose Releases all the resources used by the AdapterBase object.
Protected method Dispose(Boolean) Releases the unmanaged resources used by the AdapterBase object and optionally releases the managed resources.
Public method Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
Protected method Finalize Releases the unmanaged resources before the AdapterBase object is reclaimed by GC.
(Overrides ObjectFinalize)
Public method GetHashCode Serves as a hash function for the current AdapterBase.
(Overrides ObjectGetHashCode)
Public method GetShortStatus Gets a short one-line status of this AdapterBase.
Public method Static member GetStatusWithMessageLevelPrefix Gets status message with common time-series messaging prefix for given MessageLevel.
Public method GetType Gets the Type of the current instance.
(Inherited from Object)
Protected method IncrementProcessedMeasurements Safely increments the total processed measurements.
Public method Initialize Initializes AdapterBase.
Public method Static member LoadInputSourceIDs Loads an IOutputAdapter or IActionAdapter instance's input measurement keys from a specific set of source ID's.
Public method Static member LoadOutputSourceIDs Loads an IInputAdapter or IActionAdapter instance's output measurements from a specific set of source ID's.
Protected method MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
Protected method OnConfigurationChanged Raises ConfigurationChanged event.
Protected method OnInputMeasurementKeysUpdated Raises InputMeasurementKeysUpdated event.
Protected method OnOutputMeasurementsUpdated Raises OutputMeasurementsUpdated event.
Protected method OnProcessException(Exception) Obsolete.
Raises the ProcessException event.
Protected method OnProcessException(MessageLevel, Exception, String, MessageFlags) Raises the ProcessException event.
Protected method OnStatusMessage(String) Obsolete.
Raises the StatusMessage event.
Protected method OnStatusMessage(String, Object) Obsolete.
Raises the StatusMessage event with a formatted status message.
Protected method OnStatusMessage(MessageLevel, String, String, MessageFlags) Raises the StatusMessage event and sends this data to the Logger.
Public method Static member ParseFilterExpression Parses a standard FILTER styles expression into its constituent parts.
Public method Static member ParseInputMeasurementKeys Parses input measurement keys from connection string setting.
Public method Static member ParseOutputMeasurementKeys Parses output measurement keys from connection string setting.
Public method Static member ParseOutputMeasurements Parses output measurements from connection string setting.
Public method Static member ParseTimeTag Parses a string formatted as an absolute or relative time tag.
Public method SetInitializedState Manually sets the initialized state of the AdapterBase.
Public method SetTemporalConstraint Defines a temporal processing constraint for the adapter.
Public method Start Starts the AdapterBase or restarts it if it is already running.
Public method Stop Stops the AdapterBase.
Public method ToString Returns a string that represents the current object.
(Inherited from Object)
Top
Extension Methods
  Name Description
Public Extension Method GetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension Method GetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension Method GetMeasurementRecord Gets measurement record, creating it if needed.
(Defined by MetadataHelpers)
Public Extension Method GetParentDevice Gets ID of parent device, creating or updating record if needed, for the current IAdapter instance.
(Defined by MetadataHelpers)
Public Extension Method InputMeasurementKeys Returns the MeasurementKey values of the IAdapter input measurements.
(Defined by IAdapterExtensions)
Public Extension Method LookupDevice Looks up associated device acronym and ID from provided signalID.
(Defined by MetadataHelpers)
Public Extension Method LookupMeasurementKey Looks up or creates measurement key based on provided signalID.
(Defined by MetadataHelpers)
Public Extension Method LookupPointTag Looks up point tag name from provided signalID.
(Defined by MetadataHelpers)
Public Extension Method LookupSignalReference Looks up signal reference from provided signalID.
(Defined by MetadataHelpers)
Public Extension Method OnConfigurationChanged Notifies host system of configuration changes.
(Defined by MetadataHelpers)
Public Extension Method OutputMeasurementKeys Returns the MeasurementKey values of the IAdapter output measurements.
(Defined by IAdapterExtensions)
Public Extension Method PointTagExists Determines if pointTag exists in local configuration.
(Defined by MetadataHelpers)
Public Extension Method SignalIDExists Determines if signalID exists in local configuration.
(Defined by MetadataHelpers)
Public Extension Method SignalReferenceExists Determines if signalReference exists in local configuration.
(Defined by MetadataHelpers)
Public Extension Method TemporalConstraintIsDefined Returns true if IAdapter has a temporal constraint defined, i.e., either StartTimeConstraint or StopTimeConstraint is not set to its default value.
(Defined by IAdapterExtensions)
Public Extension Method WaitForSignalsToLoad Waits for signalIDs to be loaded in system configuration.
(Defined by MetadataHelpers)
Top
See Also