prbStepFunction.h

Go to the documentation of this file.

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



#pragma once

#include <readerWriter/readerWriter.h>
#include <vlutil/vlMachineTypes.h>
#include <readerWriter/rwList.h>
#include <readerWriter/rwBoolean.h>

class DtString;
class DtReaderWriterRegistry;
class DtPrbValueList;


#include "vrfobjparam/vrfobjparamDefines.h"
class DT_DLL_vrfobjparam DtPrbStepFunction : public DtRwList
{
public:

   DtPrbStepFunction();

   DtPrbStepFunction(const DtString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);
   DtPrbStepFunction(const DtSymbolString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtPrbStepFunction(const DtString& name, const 
      DtPrbStepFunction& orig, DtReaderWriterRegistry* 
      parentRegistry = NULL);
   DtPrbStepFunction(const DtSymbolString& name, const 
      DtPrbStepFunction& orig, DtReaderWriterRegistry* 
      parentRegistry = NULL);

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

   virtual ~DtPrbStepFunction() override;

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

   virtual int addTableEntry(const DtPrbValueList& tableEntry);

   virtual bool getProbabilities(DtReal value, DtPrbValueList* entry) const;

   virtual double minInputValue() const;

   virtual double maxInputValue() const;

   virtual double solveForMaximum() const;

   virtual bool isValid() const;

   bool operator==(const DtPrbStepFunction&) const;
   bool operator!=(const DtPrbStepFunction& rhs) const
   {
      return !(*this == rhs);
   }

   virtual bool removeValue(double);

   virtual double value(int index) const;

   virtual DtPrbValueList* changeValue(double oldValue, double newValue, int* newColumn = 0);

   virtual DtPrbValueList* changeValueForColumn(int col, double newRange, int* newColumn = 0);

   virtual DtListItem* lookupValue(double value) const;

   virtual int indexOfValue(double) const;

   virtual void setRoundDown(bool);
   bool roundDown() const
   {
      return myRoundDown;
   }

   virtual DtPrbValueList* changeValue(DtListItem* item, double newValue, int* newColumn = 0);
   
   void emptyList();

   void copyList(const DtPrbStepFunction & orig);

   virtual int addTableEntry(DtPrbValueList * tableEntry);

   virtual const char* readerWriterType() const override;

   static const char* theXmlType();

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

protected:
   virtual void prePutSelf() override;
   virtual void postPutSelf() override;

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

protected:
   bool myRoundDown;
};