/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/prdf/common/framework/resolution/prdfCaptureResolution.H $ */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2006,2014              */
/*                                                                        */
/* Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0                         */
/*                                                                        */
/* Unless required by applicable law or agreed to in writing, software    */
/* distributed under the License is distributed on an "AS IS" BASIS,      */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
/* implied. See the License for the specific language governing           */
/* permissions and limitations under the License.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */

#include <iipResolution.h>
#include <prdfExtensibleChip.H>

namespace PRDF
{

/**
 * @class CaptureResolution
 * @brief Adds a capture-group to the capture data when hitting an error.
 */
class CaptureResolution : public Resolution
{
    public:
        CaptureResolution() :iv_captureGroup(0) {};

        /** @fn CaptureResolution
         *  @brief Typical constructor.
         *
         *  @param i_chip - Extensible chip object to capture from.
         *  @param i_group - Capture-group to gather.
         */
        CaptureResolution( uint32_t i_captureGroup ) :
                        iv_captureGroup(i_captureGroup) {};

        /** @brief      Perform capture.
         *  @param[io]  io_serviceData Reference to STEP_CODE_DATA_STRUCT
         *  @return     SUCCESS| FAIL
         */
        virtual int32_t Resolve( STEP_CODE_DATA_STRUCT & io_serviceData );

        /**
         *  Comparison operator to aid in ResolutionFactory.
         */
        bool operator == ( const CaptureResolution & i_rhs )
        {
            return ( iv_captureGroup == i_rhs.iv_captureGroup );
        };
    private:

            /** The group id to capture */
        uint32_t iv_captureGroup;

};

} // end namespace PRDF