//******************************************************************************************************// IFrameImageParser.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:// ----------------------------------------------------------------------------------------------------// 12/03/2008 - J. Ritchie Carroll// Generated original version of source code.// 09/14/2009 - Stephen C. Wills// Added new header and license agreement.// 12/14/2012 - Starlynn Danyelle Gilliam// Modified Header.////****************************************************************************************************** using System; namespace GSF.Parsing{ /// <summary> /// This interface represents a basic implementation of parsing functionality suitable for automating the parsing of /// a binary data stream represented as frames with common headers and returning the parsed data via an event. /// </summary> /// <typeparam name="TTypeIdentifier">Type of identifier used to distinguish output types.</typeparam> /// <typeparam name="TOutputType">Type of the interface or class used to represent outputs.</typeparam> public interface IFrameImageParser<TTypeIdentifier, TOutputType> : IBinaryImageParser where TOutputType : ISupportFrameImage<TTypeIdentifier> { /// <summary> /// Occurs when a data image is deserialized successfully to one of the output types that the data /// image represents. /// </summary> /// <remarks> /// <see cref="EventArgs{T}.Argument"/> is the object that was deserialized from the binary image. /// </remarks> event EventHandler<EventArgs<TOutputType>> DataParsed; /// <summary> /// Occurs when matching a output type for deserializing the data image cound not be found. /// </summary> /// <remarks> /// <see cref="EventArgs{T}.Argument"/> is the ID of the output type that could not be found. /// </remarks> event EventHandler<EventArgs<TTypeIdentifier>> OutputTypeNotFound; }}
//******************************************************************************************************
// IFrameImageParser.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:
// ----------------------------------------------------------------------------------------------------
// 12/03/2008 - J. Ritchie Carroll
// Generated original version of source code.
// 09/14/2009 - Stephen C. Wills
// Added new header and license agreement.
// 12/14/2012 - Starlynn Danyelle Gilliam
// Modified Header.
//
//******************************************************************************************************
using System;
namespace GSF.Parsing
{
/// <summary>
/// This interface represents a basic implementation of parsing functionality suitable for automating the parsing of
/// a binary data stream represented as frames with common headers and returning the parsed data via an event.
/// </summary>
/// <typeparam name="TTypeIdentifier">Type of identifier used to distinguish output types.</typeparam>
/// <typeparam name="TOutputType">Type of the interface or class used to represent outputs.</typeparam>
public interface IFrameImageParser<TTypeIdentifier, TOutputType> : IBinaryImageParser where TOutputType : ISupportFrameImage<TTypeIdentifier>
{
/// <summary>
/// Occurs when a data image is deserialized successfully to one of the output types that the data
/// image represents.
/// </summary>
/// <remarks>
/// <see cref="EventArgs{T}.Argument"/> is the object that was deserialized from the binary image.
/// </remarks>
event EventHandler<EventArgs<TOutputType>> DataParsed;
/// <summary>
/// Occurs when matching a output type for deserializing the data image cound not be found.
/// </summary>
/// <remarks>
/// <see cref="EventArgs{T}.Argument"/> is the ID of the output type that could not be found.
/// </remarks>
event EventHandler<EventArgs<TTypeIdentifier>> OutputTypeNotFound;
}
}