/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2015-     Statoil ASA
//  Copyright (C) 2015-     Ceetron Solutions AS
// 
//  ResInsight is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
// 
//  ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
//  FITNESS FOR A PARTICULAR PURPOSE.
// 
//  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html> 
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#pragma once

#include "RimCheckableNamedObject.h"

#include "cafPdmObject.h"
#include "cafPdmChildField.h"
#include "cafPdmChildArrayField.h"
#include "cafPdmField.h"

class RimPerforationInterval;
class RimMswCompletionParameters;
class RimNonDarcyPerforationParameters;

//==================================================================================================
//
// 
//
//==================================================================================================
class RimPerforationCollection : public RimCheckableNamedObject
{
    CAF_PDM_HEADER_INIT;

public:
    enum ReferenceMDType
    {
        AUTO_REFERENCE_MD = 0,
        MANUAL_REFERENCE_MD
    };
    typedef caf::AppEnum<ReferenceMDType> ReferenceMDEnum;

    RimPerforationCollection();
    ~RimPerforationCollection() override;

    const RimMswCompletionParameters*          mswParameters() const;
    const RimNonDarcyPerforationParameters*    nonDarcyParameters() const;
    void                                       setUnitSystemSpecificDefaults();
    void                                       appendPerforation(RimPerforationInterval* perforation);
    std::vector<const RimPerforationInterval*> perforations() const;
    std::vector<const RimPerforationInterval*> activePerforations() const;    

private:
    void                                       defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering) override;
    void                                       fieldChangedByUi(const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue) override;

    friend class RiuEditPerforationCollectionWidget;

private:
    caf::PdmChildArrayField<RimPerforationInterval*>      m_perforations;
    caf::PdmChildField<RimMswCompletionParameters*>       m_mswParameters;
    caf::PdmChildField<RimNonDarcyPerforationParameters*> m_nonDarcyParameters;
};