mirror of
https://github.com/OPM/ResInsight.git
synced 2026-10-24 22:27:55 -05:00
Magne Sjaastad
92da6633bb
Introduce a shared base for tree-shaped folder containers that hold a list of leaf items together with a list of subcontainers of the same kind. Replaces the per-class plumbing (subcollections field, top-folder flag, add/remove/find sub-collection, factory) that is duplicated across RimSurfaceCollection, RimPolygonCollection and similar candidates. - caf::PdmNestedCollectionBase: non-templated PdmObject base exposing collection-name, add-new-subcollection, leaf-check and topmost-folder marking for generic command features and script methods. - caf::PdmNestedCollection<SelfT, ItemT>: CRTP template that owns the typed m_subCollections field and inherits the m_items array from PdmObjectCollection<ItemT>. Provides allItems(), find-sub-collection, and a typed factory hook. - RimNestedMirrorCollectionInView: view-side analogue for in-view collections that mirror a nested source collection, with orphan-sweep + find-or-create + reorder sync. Design rationale (templated vs non-templated, break-even on derived class count) lives in docs/pdm-nested-collection-design.md. No callers migrated in this commit.
75 lines
2.7 KiB
C++
75 lines
2.7 KiB
C++
/////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (C) 2026 Equinor ASA
|
|
//
|
|
// 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 "cafPdmField.h"
|
|
#include "cafPdmObject.h"
|
|
|
|
#include <QString>
|
|
|
|
namespace caf
|
|
{
|
|
|
|
//==================================================================================================
|
|
///
|
|
/// Non-templated PdmObject base class for tree-shaped containers.
|
|
///
|
|
/// Provides the type-erased interface (collection name, add-new-subcollection, leaf check) that
|
|
/// generic command features and script methods need. The templated caf::PdmNestedCollection<>
|
|
/// derives from this and supplies typed storage and accessors.
|
|
///
|
|
/// Concrete (instantiable) so the CAF factory can create a dummy instance for the Python
|
|
/// generator. The base's addNewSubCollection() is a no-op returning nullptr; the templated
|
|
/// derived class overrides it with a real implementation.
|
|
///
|
|
//==================================================================================================
|
|
class PdmNestedCollectionBase : public PdmObject
|
|
{
|
|
CAF_PDM_HEADER_INIT;
|
|
|
|
public:
|
|
PdmNestedCollectionBase();
|
|
~PdmNestedCollectionBase() override;
|
|
|
|
QString collectionName() const;
|
|
void setCollectionName( const QString& name );
|
|
|
|
// Whether this container accepts sub-collections. Leaf containers (e.g. file-backed
|
|
// folders) override to return false; generic UI / script features hide the corresponding
|
|
// action when this is false.
|
|
virtual bool canAddSubCollection() const { return true; }
|
|
|
|
// Creates a subcollection, adds it to this collection, and returns it. Default returns
|
|
// nullptr; concrete derivations (typically PdmNestedCollection<>) override.
|
|
virtual PdmObject* addNewSubCollection() { return nullptr; }
|
|
|
|
// Marks this instance as the topmost folder: hides and disables IO on the collection name,
|
|
// makes the object non-deletable.
|
|
void setAsTopmostFolder();
|
|
|
|
protected:
|
|
PdmFieldHandle* userDescriptionField() override;
|
|
|
|
PdmField<QString> m_collectionName;
|
|
|
|
bool m_isTopmostFolder;
|
|
};
|
|
|
|
} // namespace caf
|