rwVisualMetaDataEntry.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/rwNLengthStringVector.h"
#include <readerWriter/rwInt.h>
#include <readerWriter/rwReal.h>

class DT_DLL_vrfutil DtRwVisualMetaDataEntry : public DtReaderWriter
{
public:
   enum SelectionMethodology
   {
      Default = 0,
      Specific = 1,
      Weighted = 2,
      Random = 3,
      WeightedExponential = 4
   };

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

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

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

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

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

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

   virtual ~DtRwVisualMetaDataEntry();

   virtual const char* readerWriterType() const;

   static const char* theXmlType();

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


   virtual void clear();

   virtual void setSelectionMethodology(SelectionMethodology);
   SelectionMethodology selectionMethodology() const
   {
      return (SelectionMethodology)mySelectionMethodology.value();
   }

   const DtRwNLengthStringVector& selections() const
   {
      return mySelections;
   }

   virtual void setSelections(const DtRwNLengthStringVector&);

   DtRwNLengthStringVector& selections()
   {
      return mySelections;
   }

   virtual void setTopWeightedPercent(double);
   virtual double topWeightedPercent() const;

   virtual void setTopWeightedRandomChance(double);
   virtual double topWeightedRandomChance() const;

protected:
   DtRwInt mySelectionMethodology;

   DtRwNLengthStringVector mySelections;

   DtRwReal myTopWeightedPercent;

   DtRwReal myTopWeightedRandomChance;
};