mirror of
https://github.com/OPM/ResInsight.git
synced 2025-02-15 10:03:34 -06:00
c63c7f2eac
* Also store class keyword in fields so they can be assigned to the correct Python object even if the class itself is abstract.
95 lines
3.9 KiB
C++
95 lines
3.9 KiB
C++
#pragma once
|
|
|
|
#include "cafPdmObjectCapability.h"
|
|
|
|
#include <QString>
|
|
|
|
#include <list>
|
|
#include <vector>
|
|
|
|
class QXmlStreamReader;
|
|
class QXmlStreamWriter;
|
|
|
|
|
|
namespace caf
|
|
{
|
|
|
|
class PdmXmlFieldHandle;
|
|
class PdmObjectHandle;
|
|
class PdmObjectFactory;
|
|
class PdmReferenceHelper;
|
|
class PdmFieldHandle;
|
|
|
|
|
|
//==================================================================================================
|
|
//
|
|
//
|
|
//
|
|
//==================================================================================================
|
|
class PdmXmlObjectHandle : public PdmObjectCapability
|
|
{
|
|
public:
|
|
|
|
PdmXmlObjectHandle(PdmObjectHandle* owner, bool giveOwnership);
|
|
~PdmXmlObjectHandle() override { }
|
|
|
|
/// The classKeyword method is overridden in subclasses by the CAF_PDM_XML_HEADER_INIT macro
|
|
virtual QString classKeyword() const = 0;
|
|
virtual bool matchesClassKeyword(const QString& classKeyword) const = 0;
|
|
|
|
/// Convenience methods to serialize/de-serialize this particular object (with children)
|
|
void readObjectFromXmlString(const QString& xmlString, PdmObjectFactory* objectFactory);
|
|
QString writeObjectToXmlString() const;
|
|
static PdmObjectHandle* readUnknownObjectFromXmlString(const QString& xmlString, PdmObjectFactory* objectFactory, bool isCopyOperation);
|
|
PdmObjectHandle* copyByXmlSerialization(PdmObjectFactory* objectFactory);
|
|
PdmObjectHandle* copyAndCastByXmlSerialization(const QString& destinationClassKeyword,
|
|
const QString& sourceClassKeyword,
|
|
PdmObjectFactory* objectFactory);
|
|
|
|
// Main XML serialization methods that is used internally by the document serialization system
|
|
// Not supposed to be used directly.
|
|
void readFields(QXmlStreamReader& inputStream, PdmObjectFactory* objectFactory, bool isCopyOperation);
|
|
void writeFields(QXmlStreamWriter& outputStream) const;
|
|
|
|
/// Check if a string is a valid Xml element name
|
|
static bool isValidXmlElementName(const QString& name);
|
|
|
|
void initAfterReadRecursively() { initAfterReadRecursively(this->m_owner); };
|
|
void setupBeforeSaveRecursively() { setupBeforeSaveRecursively(this->m_owner); };
|
|
|
|
void resolveReferencesRecursively(std::vector<PdmFieldHandle*>* fieldWithFailingResolve = nullptr);
|
|
bool inheritsClassWithKeyword(const QString& testClassKeyword) const;
|
|
|
|
const std::list<QString>& classInheritanceStack() const;
|
|
protected: // Virtual
|
|
/// Method gets called from PdmDocument after all objects are read.
|
|
/// Re-implement to set up internal pointers etc. in your data structure
|
|
virtual void initAfterRead() {};
|
|
/// Method gets called from PdmDocument before saving document.
|
|
/// Re-implement to make sure your fields have correct data before saving
|
|
virtual void setupBeforeSave() {};
|
|
|
|
/// This method is intended to be used in macros to make compile time errors
|
|
// if user uses them on wrong type of objects
|
|
bool isInheritedFromPdmXmlSerializable() { return true; }
|
|
|
|
void registerClassKeyword(const QString& registerKeyword);
|
|
|
|
private:
|
|
void initAfterReadRecursively(PdmObjectHandle* object);
|
|
void setupBeforeSaveRecursively(PdmObjectHandle * object);
|
|
void resolveReferencesRecursively(PdmObjectHandle* object, std::vector<PdmFieldHandle*>* fieldWithFailingResolve);
|
|
|
|
private:
|
|
friend class PdmObjectHandle ; // Only temporary for void PdmObject::addFieldNoDefault( ) accessing findField
|
|
|
|
std::list<QString> m_classInheritanceStack;
|
|
PdmObjectHandle* m_owner;
|
|
};
|
|
|
|
PdmXmlObjectHandle* xmlObj(PdmObjectHandle* obj);
|
|
|
|
} // End of namespace caf
|
|
|
|
#include "cafPdmXmlFieldHandle.h"
|