formationTable.h

Go to the documentation of this file.

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



#pragma once

#include <readerWriter/rwList.h>
#include <vlutil/vlHashlist.h>
#include "vrfutil/formationTableEntry.h"
#include "vrfutil/formation.h"
#include <readerWriter/rwBoolean.h>

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

   struct FormationAdder
   {
      FormationAdder(DtFormationTable* formations, 
         const DtReaderWriter::SearchPaths& searchPaths, const DtVariableBindingsList& bindings) 
         : myFormations(formations) 
         , mySearchPaths(searchPaths)
         , myBindings(bindings) 
      {

      }

      void operator()(DtReaderWriter* rwObject)
      {
         if (rwObject)
         {
            DtFormationTableEntry* entry = static_cast<DtFormationTableEntry*>(rwObject);
            entry->formationFile().loadFile(mySearchPaths, myBindings);
            myFormations->addFormationEntry(entry);
         }
      }
      DtFormationTable* myFormations;
      const DtReaderWriter::SearchPaths mySearchPaths;
      const DtVariableBindingsList& myBindings;
   };

   DtFormationTable();

   DtFormationTable(const DtString& writeName, 
      DtReaderWriterRegistry* parentRegistry = NULL);
   DtFormationTable(const DtSymbolString& writeName, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   virtual ~DtFormationTable();

   DtFormationTable(const DtString& writeName, const DtFormationTable&
      orig, DtReaderWriterRegistry* parentRegistry = NULL);
   DtFormationTable(const DtSymbolString& writeName, const DtFormationTable&
      orig, DtReaderWriterRegistry* parentRegistry = NULL);
   DtFormationTable(const DtFormationTable& orig, DtReaderWriterRegistry* parentRegistry = NULL);

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

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

   virtual DtFormation* getFormation(const DtString& formationName,
      DtString* actualName = 0) const;

   virtual DtFormation* getDefaultFormation() const;

   virtual DtFormationTableEntry* getDefaultFormationEntry() const;

   virtual void setFormationToDefault(DtFormationTableEntry* entry);

   virtual void addFormation(const DtString& formationName, const DtFormation& formation);

   virtual bool removeFormation(const DtString& formationName);

   virtual void addFormationEntry(DtFormationTableEntry* entry);

   virtual DtFormationTableEntry* getFormationEntry(const DtString& formationName) const;

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

   virtual const char* readerWriterType() const;

   virtual void setAutoLayoutForGui(bool);
   virtual bool autoLayoutForGui() const;

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

   virtual void putData(DtEnvironmentSP, DtEnvValueSP parent) const;
   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;

   static DtString standardFormationName(const DtString& name);
   static void standardizeFormationName(DtString& nameToChange);

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

   void copyTable(const DtFormationTable& other);
   void emptyTable();

protected:
   DtRwBoolean myAutoLayoutForGui;
};