//******************************************************************************************************// IInputAdapter.cs - Gbtc//// Copyright © 2012, Grid Protection Alliance. All Rights Reserved.//// Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See// the NOTICE file distributed with this work for additional information regarding copyright ownership.// The GPA licenses this file to you under the MIT License (MIT), the "License"; you may// not use this file except in compliance with the License. You may obtain a copy of the License at://// http://www.opensource.org/licenses/MIT//// Unless agreed to in writing, the subject software distributed under the License is distributed on an// "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the// License for the specific language governing permissions and limitations.//// Code Modification History:// ----------------------------------------------------------------------------------------------------// 09/02/2010 - J. Ritchie Carroll// Generated original version of source code.// 12/20/2012 - Starlynn Danyelle Gilliam// Modified Header.////****************************************************************************************************** using System;using System.Collections.Generic; namespace GSF.TimeSeries.Adapters{ /// <summary> /// Represents the abstract interface for any incoming adapter. /// </summary> public interface IInputAdapter : IAdapter { /// <summary> /// Provides new measurements from input adapter. /// </summary> /// <remarks> /// <see cref="EventArgs{T}.Argument"/> is a collection of new measurements for host to process. /// </remarks> event EventHandler<EventArgs<ICollection<IMeasurement>>> NewMeasurements; /// <summary> /// Indicates to the host that processing for the input adapter has completed. /// </summary> /// <remarks> /// This event is expected to only be raised when an input adapter has been designed to process /// a finite amount of data, e.g., reading a historical range of data during temporal processing. /// </remarks> event EventHandler ProcessingComplete; /// <summary> /// Gets or sets <see cref="MeasurementKey.Source"/> values used to filter output measurements. /// </summary> /// <remarks> /// This allows an adapter to associate itself with entire collections of measurements based on the source of the measurement keys. /// Set to <c>null</c> apply no filter. /// </remarks> string[] OutputSourceIDs { get; set; } /// <summary> /// Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide. /// </summary> MeasurementKey[] RequestedOutputMeasurementKeys { get; set; } }}
//******************************************************************************************************
// IInputAdapter.cs - Gbtc
//
// Copyright © 2012, Grid Protection Alliance. All Rights Reserved.
//
// Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See
// the NOTICE file distributed with this work for additional information regarding copyright ownership.
// The GPA licenses this file to you under the MIT License (MIT), the "License"; you may
// not use this file except in compliance with the License. You may obtain a copy of the License at:
//
// http://www.opensource.org/licenses/MIT
//
// Unless agreed to in writing, the subject software distributed under the License is distributed on an
// "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the
// License for the specific language governing permissions and limitations.
//
// Code Modification History:
// ----------------------------------------------------------------------------------------------------
// 09/02/2010 - J. Ritchie Carroll
// Generated original version of source code.
// 12/20/2012 - Starlynn Danyelle Gilliam
// Modified Header.
//
//******************************************************************************************************
using System;
using System.Collections.Generic;
namespace GSF.TimeSeries.Adapters
{
/// <summary>
/// Represents the abstract interface for any incoming adapter.
/// </summary>
public interface IInputAdapter : IAdapter
{
/// <summary>
/// Provides new measurements from input adapter.
/// </summary>
/// <remarks>
/// <see cref="EventArgs{T}.Argument"/> is a collection of new measurements for host to process.
/// </remarks>
event EventHandler<EventArgs<ICollection<IMeasurement>>> NewMeasurements;
/// <summary>
/// Indicates to the host that processing for the input adapter has completed.
/// </summary>
/// <remarks>
/// This event is expected to only be raised when an input adapter has been designed to process
/// a finite amount of data, e.g., reading a historical range of data during temporal processing.
/// </remarks>
event EventHandler ProcessingComplete;
/// <summary>
/// Gets or sets <see cref="MeasurementKey.Source"/> values used to filter output measurements.
/// </summary>
/// <remarks>
/// This allows an adapter to associate itself with entire collections of measurements based on the source of the measurement keys.
/// Set to <c>null</c> apply no filter.
/// </remarks>
string[] OutputSourceIDs
{
get;
set;
}
/// <summary>
/// Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
/// </summary>
MeasurementKey[] RequestedOutputMeasurementKeys
{
get;
set;
}
}
}