vrfSubObjectParameterList.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2013 MaK Technologies, Inc.
** All rights reserved.
*******************************************************************************/



#pragma once

#include "vrfutil/rwList.h"
#include "vrfutil/vrfSubObjectParameterEntry.h"

class DtVrfSubObjectParameterEntry;

#include "vrfutil/vrfutilDefines.h"
class DT_DLL_vrfutil DtVrfSubObjectParameterList : public DtRwList
{
public:

   struct SubordinateAdder
   {
      SubordinateAdder(DtVrfSubObjectParameterList* list) : myList(list) {}
      void operator()(DtReaderWriter* rwObject)
      {
         myList->addSubObjectEntry(*static_cast<DtVrfSubObjectParameterEntry*>(rwObject));
      }
      DtVrfSubObjectParameterList* myList;
   };

   DtVrfSubObjectParameterList(const DtString& name = DtString::nullString(), 
      DtReaderWriterRegistry* parentRegistry = NULL);
   DtVrfSubObjectParameterList(const DtSymbolString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtVrfSubObjectParameterList(const DtVrfSubObjectParameterList& orig, 
      const DtString& name = DtString::nullString(), 
      DtReaderWriterRegistry* parentRegistry = NULL);
   DtVrfSubObjectParameterList(const DtVrfSubObjectParameterList& orig, 
      const DtSymbolString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   const DtVrfSubObjectParameterList& operator=(
      const DtVrfSubObjectParameterList& orig);

   virtual ~DtVrfSubObjectParameterList();

   virtual DtVrfSubObjectParameterList* clone(
      const DtString& name = DtString::nullString(), 
      DtReaderWriterRegistry* parentRegistry = NULL) const;
   virtual DtVrfSubObjectParameterList* clone(
      const DtSymbolString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL) const;

   virtual DtVrfSubObjectParameterEntry* addSubObjectEntry(
      const DtVrfSubObjectParameterEntry& subEntry);

   virtual void removeSubObjectEntry(const DtVrfSubObjectParameterEntry* subEntry);

   bool operator==(const DtVrfSubObjectParameterList&) const;
   bool operator!=(const DtVrfSubObjectParameterList&) const;

   virtual const char* readerWriterType() const;

   virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings);

   virtual void getData(const DtEnvironmentSP, const DtEnvValueSP value,
      const DtReaderWriter::SearchPaths& searchPaths = DtReaderWriter::SearchPaths(), 
      const DtVariableBindingsList& bindings = DtVariableBindingsList());

   static const char* theXmlType();

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

   virtual std::set<DtString> supportedXmlTypes() const;

   virtual std::vector<DtObjectType> subordinateObjects() const;

protected:

   virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings);

   virtual void emptyList();
   virtual void copyList(const DtVrfSubObjectParameterList & orig);

   virtual DtVrfSubObjectParameterEntry* addSubObjectEntry(
      DtVrfSubObjectParameterEntry* subEntry);
};