//
// LDASTools frameCPP - A library implementing the LIGO/Virgo frame
// specification
//
// Copyright (C) 2018 California Institute of Technology
//
// LDASTools frameCPP is free software; you may redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 (GPLv2) of the
// License or at your discretion, any later version.
//
// LDASTools frameCPP is distributed in the hope that it will be useful, but
// without any warranty or even the implied warranty of merchantability
// or fitness for a particular purpose. See the GNU General Public
// License (GPLv2) for more details.
//
// Neither the names of the California Institute of Technology (Caltech),
// The Massachusetts Institute of Technology (M.I.T), The Laser
// Interferometer Gravitational-Wave Observatory (LIGO), nor the names
// of its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// You should have received a copy of the licensing terms for this
// software included in the file LICENSE located in the top-level
// directory of this package. If you did not, you can view a copy at
// http://dcc.ligo.org/M1500244/LICENSE
//

#ifndef FrameCPP_UNIVERSAL_FrEndOfFrame_HH
#define FrameCPP_UNIVERSAL_FrEndOfFrame_HH

#include "ldastoolsal/types.hh"

#include "framecpp/Universal/impl/FrEndOfFrameClassicIO.hh"
#include "framecpp/Universal/impl/FrEndOfFrameSerialIO.hh"

namespace FrameCPP
{
    namespace Universal
    {
        //-------------------------------------------------------------------
        /// \brief End of Frame data structure
        //-------------------------------------------------------------------
        class FrEndOfFrame : public FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >,
                             public FrEndOfFrameImpl::SerialIO< FrEndOfFrame >
        {
        public:
            //-----------------------------------------------------------------
            /// \brief Default constructor
            //-----------------------------------------------------------------
            FrEndOfFrame( );

            //-----------------------------------------------------------------
            /// \brief Constructor
            //-----------------------------------------------------------------
            FrEndOfFrame( run_type Run, frame_type Frame );

            //-----------------------------------------------------------------
            /// \brief Desctructor
            //-----------------------------------------------------------------
            virtual ~FrEndOfFrame( );

            //-----------------------------------------------------------------
            /// \brief equality operator for abstract data type
            ///
            /// \param[in] RHS
            ///     The object to be compared.
            ///
            /// \return
            ///     The value true is returned if this object is equivelent
            ///     to the RHS instance; false otherwise.
            //-----------------------------------------------------------------
            virtual bool
            operator==( const Common::FrameSpec::Object& RHS ) const;

            /// Typed equality declared as a hidden friend, not a member, so
            /// it does not pair with the virtual operator==(Object&) override
            /// above under C++20's reversed-candidate rule.
            friend bool
            operator==( const FrEndOfFrame& LHS, const FrEndOfFrame& RHS )
            {
                return ( LHS.FrEndOfFrameImpl::Data::operator==( RHS ) );
            }
        };

    } // namespace Universal
} // namespace FrameCPP

#endif /* FrameCPP_UNIVERSAL_FrEndOfFrame_HH */
