rwPropertiesStructure.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include "readerWriter/rwProperties.h"

class DT_DLL_readerWriter DtRwPropertiesStructure : public DtRwProperties
{
public:
   // Implement so can be used in a map
   DtRwPropertiesStructure();

   DtRwPropertiesStructure(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertiesStructure(const DtString& name, const DtRwPropertiesStructure& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertiesStructure(const DtRwPropertiesStructure& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertiesStructure& operator=(const DtRwPropertiesStructure& orig);
   virtual ~DtRwPropertiesStructure() override;

   inline const DtPropertyInterface* findFieldPropertyInterface(const DtString& fieldName) const
   {
      return findPropertyInterface(fieldName);
   }

   inline DtPropertyInterface* findFieldPropertyInterface(const DtString& fieldName)
   {
      return findPropertyInterface(fieldName);
   }

   template <typename SpecificPropType>
   const SpecificPropType* findField(const DtString& fieldName) const
   {
      return findProperty<SpecificPropType>(fieldName);
   }

   template <typename SpecificPropType>
   SpecificPropType* findField(const DtString& fieldName)
   {
      return findProperty<SpecificPropType>(fieldName);
   }

      
   template <typename ValueType>
   boost::optional<ValueType> findFieldValue(const DtString& fieldName) const
   {
      return findPropertyValue<ValueType>(fieldName);
   }

   template <typename ValueType>
   bool findAndSetFieldValue(const DtString& fieldName, ValueType val)
   {
      return findAndSetPropertyValue<ValueType>(fieldName, val);
   }

      
   virtual bool addField(DtPropertyInterface* field)
   {
      return addProperty(field);
   }

   template <typename SpecificPropType>
   SpecificPropType* addNewField(const DtString& fieldName)
   {
      return addNewProperty<SpecificPropType>(fieldName);
   }

   virtual bool removeField(const DtString& propertyName)
   {
      return removeProperty(propertyName);
   }

   virtual bool removeField(const DtPropertyInterface* property)
   {
      return removeProperty(property);
   }

   DtPropertyInterface& operator[](const DtString& fieldName);

   const DtPropertyInterface& operator[](const DtString& fieldName) const;

   virtual void putSelf(std::string &fp, int indentLevel, bool writeUnspecified,
                        const DtFilename &path) override;

   virtual const char *readerWriterType() const override;

   static const char* theXmlType();

   virtual const char *xmlType() const override {
      return theXmlType();
   }

   virtual void copyVariables(const DtRwVariableBindings &other) override;

   virtual bool isSimilarProperty(const DtPropertyInterface *rhs,
                                  bool strict = true) const override;

protected:
   virtual void getData(const DtEnvironmentSP env, const DtEnvValueSP root,
                        const DtReaderWriter::SearchPaths &searchPaths,
                        const DtVariableBindingsList &varBindings) override;
   virtual void putData(DtEnvironmentSP, DtEnvValueSP value) const override;

protected:

   mutable DtPropertyInterface* myScratchItem;
};