rwVisualMetaData.h

Go to the documentation of this file.

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

#pragma once

#include "vrfutil/vrfutilDefines.h"
#include <readerWriter/readerWriter.h>
#include "vrfutil/rwVisualMetaDataEntry.h"
#include <readerWriter/rwString.h>
#include "vrfutil/rwTemplatedList.h"

class DT_DLL_vrfutil DtRwVisualMetaData : public DtReaderWriter
{
public:
   typedef DtRwTemplatedListPtr<DtRwVisualMetaDataEntry, true> VisualMetaDataList;
   typedef std::map<DtString, DtRwVisualMetaDataEntry*> VisualMetaDataMap;

   DtRwVisualMetaData(const DtString& name, DtReaderWriterRegistry* 
      parentRegistry = 0);
   DtRwVisualMetaData(const DtSymbolString& name, DtReaderWriterRegistry* 
      parentRegistry = 0);

   DtRwVisualMetaData(const DtRwVisualMetaData& orig,
      DtReaderWriterRegistry* parentRegistry = 0);

   DtRwVisualMetaData(const DtString& name, const DtRwVisualMetaData& orig,
      DtReaderWriterRegistry*  parentRegistry = 0);

   DtRwVisualMetaData(const DtSymbolString& name, const DtRwVisualMetaData& orig,
      DtReaderWriterRegistry*  parentRegistry = 0);

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

   bool operator==(const DtRwVisualMetaData& orig) const;
   bool operator!=(const DtRwVisualMetaData& orig) const
   {
      return !(*this == orig);
   }

   virtual ~DtRwVisualMetaData();

   virtual const char* readerWriterType() const;

   static const char* theXmlType();

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


   virtual void clear();

   virtual void setVisualMetaDataFilename(const DtString&);
   const DtString& visualMetaDataFilename() const
   {
      return myVisualMetaDataFilename;
   }

   const VisualMetaDataList& visualMetaData() const
   {
      return myVisualMetaDataList;
   }

   virtual void postGetSelf();

   virtual bool removeVisualMetaData(const DtString&);

   virtual DtRwVisualMetaDataEntry* addVisualMetaData(const DtRwVisualMetaDataEntry&);

   virtual bool hasVisualMetaData(const DtString&) const;

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

   virtual void setSelectionMethodology(const DtString& marking, DtRwVisualMetaDataEntry::SelectionMethodology);
   virtual DtRwVisualMetaDataEntry::SelectionMethodology selectionMethodology(const DtString&) const;

   virtual void clearSelections(const DtString&);

   virtual void setSelection(const DtString&, const DtString&);

   virtual void setSelections(const DtString&, const DtRwNLengthStringVector&);

   virtual DtRwNLengthStringVector selections(const DtString&) const;

   virtual void setTopWeightedPercent(const DtString&, double);
   virtual double topWeightedPercent(const DtString&) const;

   virtual void setTopWeightedRandomChance(const DtString&, double);
   virtual double topWeightedRandomChance(const DtString&) const;

protected:
   DtRwString  myVisualMetaDataFilename;

   VisualMetaDataList myVisualMetaDataList;

   VisualMetaDataMap myVisualMetaDataMap;
};