//******************************************************************************************************
//  COutputAdapter.h - 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:
//  ----------------------------------------------------------------------------------------------------
//  01/27/2012 - J. Ritchie Carroll
//       Generated original version of source code.
//
//******************************************************************************************************

#pragma once

using namespace System;
using namespace System::Collections::Generic;
using namespace System::ComponentModel;
using namespace GSF::TimeSeries;
using namespace GSF::TimeSeries::Adapters;
using namespace GSF;

namespace CSampleAdapters
{
    /// <summary>
    /// Represents a C++ output adapter implementation sample.
    /// </summary>
    [Description("Represents a C++ output adapter implementation sample.")]
    public ref class COutputAdapter : public OutputAdapterBase
    {
        #pragma region [ Properties ]

    public:

        /// <summary>
        /// Returns a flag that determines if measurements sent to this <see cref="COutputAdapter"/> are destined for archival.
        /// </summary>
        property bool OutputIsForArchive
        {
            virtual bool get() override;
        }

        /// <summary>
        /// Gets the flag indicating if this <see cref="COutputAdapter"/> supports temporal processing.
        /// </summary>
        property bool SupportsTemporalProcessing
        {
            virtual bool get() override;
        };

    protected:
   
        /// <summary>
        /// Gets flag that determines if this <see cref="COutputAdapter"/> uses an asynchronous connection.
        /// </summary>
        property bool UseAsyncConnect
        {
            virtual bool get() override;
        };

        #pragma endregion

        #pragma region [ Methods ]

    public:

        /// <summary>
        /// Initializes <see cref="COutputAdapter"/>.
        /// </summary>
        virtual void Initialize() override;

        /// <summary>
        /// Gets a short one-line status of this <see cref="COutputAdapter"/>.
        /// </summary>
        virtual String^ GetShortStatus(int maxLength) override;

    protected:

        /// <summary>
        /// Attempts to connect this <see cref="COutputAdapter"/>.
        /// </summary>
        virtual void AttemptConnection() override;

        /// <summary>
        /// Attempts to disconnect this <see cref="COutputAdapter"/>.
        /// </summary>
        virtual void AttemptDisconnection() override;

        /// <summary>
        /// Serializes measurements to data output stream.
        /// </summary>
        virtual void ProcessMeasurements(array<IMeasurement^>^ measurements) override;

        #pragma endregion
    };
}