mirror of
https://github.com/OPM/ResInsight.git
synced 2025-02-25 18:55:39 -06:00
0c90f67dcc
* Refactor interface to PdmObjectHandle and PdmFieldHandle Return objects instead of passing in structures as parameters * Add nodiscard to several functions * Remove redundant this-> * Rename to ptrReferencedObjectsByType
105 lines
3.6 KiB
C++
105 lines
3.6 KiB
C++
#pragma once
|
|
|
|
#include "cafPdmBase.h"
|
|
#include <QString>
|
|
#include <vector>
|
|
|
|
namespace caf
|
|
{
|
|
class PdmObjectHandle;
|
|
class PdmUiFieldHandle;
|
|
class PdmXmlFieldHandle;
|
|
|
|
//==================================================================================================
|
|
/// Base class for all fields, making it possible to handle them generically
|
|
//==================================================================================================
|
|
class PdmFieldCapability;
|
|
|
|
class PdmFieldHandle
|
|
{
|
|
public:
|
|
PdmFieldHandle() { m_ownerObject = nullptr; }
|
|
virtual ~PdmFieldHandle();
|
|
|
|
QString keyword() const { return m_keyword; }
|
|
bool matchesKeyword( const QString& keyword ) const;
|
|
PdmObjectHandle* ownerObject();
|
|
QString ownerClass() const;
|
|
|
|
void registerKeywordAlias( const QString& alias );
|
|
bool matchesKeywordAlias( const QString& keyword ) const;
|
|
std::vector<QString> keywordAliases() const;
|
|
|
|
// Child objects
|
|
bool hasChildren() const;
|
|
[[nodiscard]] virtual std::vector<PdmObjectHandle*> children() const { return {}; }
|
|
virtual void removeChild( PdmObjectHandle* ) {}
|
|
void setOwnerClass( const QString& ownerClass );
|
|
|
|
// Ptr referenced objects
|
|
bool hasPtrReferencedObjects() const;
|
|
virtual std::vector<PdmObjectHandle*> ptrReferencedObjects() const { return {}; }
|
|
|
|
// Capabilities
|
|
void addCapability( PdmFieldCapability* capability, bool takeOwnership )
|
|
{
|
|
m_capabilities.push_back( std::make_pair( capability, takeOwnership ) );
|
|
}
|
|
|
|
std::vector<caf::PdmFieldCapability*> capabilities() const;
|
|
|
|
template <typename CapabilityType>
|
|
CapabilityType* capability();
|
|
template <typename CapabilityType>
|
|
const CapabilityType* capability() const;
|
|
|
|
PdmUiFieldHandle* uiCapability();
|
|
PdmXmlFieldHandle* xmlCapability();
|
|
|
|
protected:
|
|
bool isInitializedByInitFieldMacro() const { return m_ownerObject != nullptr; }
|
|
|
|
private:
|
|
PDM_DISABLE_COPY_AND_ASSIGN( PdmFieldHandle );
|
|
|
|
friend class PdmObjectHandle; // Give access to m_ownerObject and set Keyword
|
|
void setKeyword( const QString& keyword );
|
|
PdmObjectHandle* m_ownerObject;
|
|
QString m_ownerClass;
|
|
|
|
QString m_keyword;
|
|
std::vector<QString> m_keywordAliases;
|
|
|
|
std::vector<std::pair<PdmFieldCapability*, bool>> m_capabilities;
|
|
};
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
template <typename CapabilityType>
|
|
CapabilityType* PdmFieldHandle::capability()
|
|
{
|
|
for ( size_t i = 0; i < m_capabilities.size(); ++i )
|
|
{
|
|
CapabilityType* capability = dynamic_cast<CapabilityType*>( m_capabilities[i].first );
|
|
if ( capability ) return capability;
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
template <typename CapabilityType>
|
|
const CapabilityType* PdmFieldHandle::capability() const
|
|
{
|
|
for ( size_t i = 0; i < m_capabilities.size(); ++i )
|
|
{
|
|
const CapabilityType* capability = dynamic_cast<CapabilityType*>( m_capabilities[i].first );
|
|
if ( capability ) return capability;
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
} // End of namespace caf
|