Files
ResInsight/ApplicationLibCode/ProjectDataModelCommands/RimcNestedCollectionBase.h
T
Stefan Crooijmans c0dcb78824 #15008 Python: Typed add_folder() and collection_name() for nested collections
The Python generator emits add_folder() again on a concrete collection
class when the folder type narrows: SurfaceCollection.add_folder()
returns SurfaceCollection and PolygonCollection.add_folder() returns
PolygonCollection, while PdmNestedCollectionBase keeps the declared type.
PdmObjectMethod::classKeywordReturnedTypeForSelf() reports the narrowed
type, and the super class method check in the generator accepts such an
override (same arguments, subclass return type).

PdmNestedCollectionBase: subCollectionClassKeyword() names the folder
type without creating one, addNewSubCollection() is a template method
over createSubCollection() and returns PdmNestedCollectionBase*, and the
base virtuals are pure. The leaf polygon containers only override
canAddSubCollection().

collection_name() in rips returns the folder name for every nested
collection; the class specific name attributes are kept.
2026-11-05 08:50:36 +01:00

69 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 "RiaDefines.h"
#include "cafAppEnum.h"
#include "cafPdmField.h"
#include "cafPdmObjectHandle.h"
#include "cafPdmObjectMethod.h"
#include <QString>
//==================================================================================================
///
/// Generic "Add Folder" script method registered once against caf::PdmNestedCollectionBase.
/// Every concrete nested collection inherits the method through the CAF method-factory
/// inheritance walk, so derived classes do not need their own AddFolder counterpart.
///
//==================================================================================================
class RimcNestedCollectionBase : public caf::PdmObjectCreationMethod
{
CAF_PDM_HEADER_INIT;
public:
RimcNestedCollectionBase( caf::PdmObjectHandle* self );
std::expected<caf::PdmObjectHandle*, QString> execute() override;
QString classKeywordReturnedType() const override;
QString classKeywordReturnedTypeForSelf() const override;
private:
caf::PdmField<QString> m_folderName;
caf::PdmField<caf::AppEnum<RiaDefines::NameConflictPolicy>> m_onNameConflict;
};
//==================================================================================================
///
/// Name of the folder, the same for every nested collection whichever class owns the name field.
/// Exposed in Python as PdmNestedCollectionBase.collection_name() (rips/nested_collection.py).
///
//==================================================================================================
class RimcNestedCollectionBase_collectionName : public caf::PdmObjectMethod
{
CAF_PDM_HEADER_INIT;
public:
RimcNestedCollectionBase_collectionName( caf::PdmObjectHandle* self );
std::expected<caf::PdmObjectHandle*, QString> execute() override;
QString classKeywordReturnedType() const override;
};