rwArtPartState.h

Go to the documentation of this file.

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



#pragma once

#include <vrfutil/vrfutilDefines.h>
#include <readerWriter/readerWriter.h>
#include <readerWriter/rwBoolean.h>
#include <readerWriter/rwReal.h>
#include <readerWriter/rwVector.h>
#include <readerWriter/rwString.h>
#include <set>

class DtReaderWriterRegistry;

#include "vrfobjparam/vrfobjparamDefines.h"
class DT_DLL_vrfutil DtRwArtPartState : public DtReaderWriter
{
public:

   enum MergeRule
   {
      AllSpecifiedValues,           
      OnlyIfMyValueIsUnspecified,   
      AllSpecifiedValuesExceptRates 
   };

   DtRwArtPartState();

   DtRwArtPartState(const DtString& partName, DtReaderWriterRegistry *
      parentRegistry = NULL);

   DtRwArtPartState(const DtSymbolString& partName,
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtRwArtPartState(const DtRwArtPartState& orig, 
      const DtString& partName,
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtRwArtPartState(const DtRwArtPartState& orig, 
      const DtSymbolString& partName,
      DtReaderWriterRegistry * parentRegistry = NULL);

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

   virtual ~DtRwArtPartState() override;

   virtual DtRwArtPartState* clone(const DtString& partName,
      DtReaderWriterRegistry* parentRegistry = NULL) const;

   virtual DtRwArtPartState* clone(const DtSymbolString& partName,
      DtReaderWriterRegistry* parentRegistry = NULL) const;

   virtual bool mergeSpecifiedParameters(const DtRwArtPartState& other,
      MergeRule rule = AllSpecifiedValues);

   virtual void markMatchingFieldsUnspecified(const DtRwArtPartState& other);

   virtual void setAttachPoint(const DtVector& attachPoint, bool isSpecified = true);
   virtual DtVector attachPoint() const;
   virtual bool attachPointSpecified() const;

   virtual DtVector endPoint() const;
   virtual void setEndPoint(const DtVector& loc, bool isSpecified = true);
   virtual bool endPointSpecified() const;

   virtual double position() const;
   virtual void setPosition(double val, bool isSpecified = true);
   virtual bool positionSpecified() const;

   virtual double positionRate() const;
   virtual void setPositionRate(double val, bool isSpecified = true);
   virtual bool positionRateSpecified() const;

   virtual double maxPositionRate() const;
   virtual void setMaxPositionRate(double val, bool isSpecified = true);
   virtual bool maxPositionRateSpecified() const;

   virtual double extension() const;
   virtual void setExtension(double val, bool isSpecified = true);
   virtual bool extensionSpecified() const;

   virtual double maxExtension() const;
   virtual void setMaxExtension(double val, bool isSpecified = true);
   virtual bool maxExtensionSpecified() const;

   virtual double extensionRate() const;
   virtual void setExtensionRate(double val, bool isSpecified = true);
   virtual bool extensionRateSpecified() const;

   virtual double maxExtensionRate() const;
   virtual void setMaxExtensionRate(double val, bool isSpecified = true);
   virtual bool maxExtensionRateSpecified() const;

   virtual DtVector translation() const;
   virtual void setTranslation(const DtVector& val, bool isSpecified = true);
   virtual bool translationSpecified() const;

   virtual DtVector minTranslation() const;
   virtual void setMinTranslation(const DtVector& val, bool isSpecified = true);
   virtual bool minTranslationSpecified() const;

   virtual DtVector maxTranslation() const;
   virtual void setMaxTranslation(const DtVector& val, bool isSpecified = true);
   virtual bool maxTranslationSpecified() const;

   virtual DtVector translationRate() const;
   virtual void setTranslationRate(const DtVector& val, bool isSpecified = true);
   virtual bool translationRateSpecified() const;

   virtual DtVector maxTranslationRate() const;
   virtual void setMaxTranslationRate(const DtVector& val, bool isSpecified = true);
   virtual bool maxTranslationRateSpecified() const;


   virtual double azimuth() const;
   virtual void setAzimuth(double angle, bool isSpecified = true);
   virtual bool azimuthSpecified() const;


   virtual double minAzimuth() const;
   virtual void setMinAzimuth(double angle, bool isSpecified = true);
   virtual bool minAzimuthSpecified() const;


   virtual double maxAzimuth() const;
   virtual void setMaxAzimuth(double angle, bool isSpecified = true);
   virtual bool maxAzimuthSpecified() const;


   virtual double azimuthRate() const;
   virtual void setAzimuthRate(double rate, bool isSpecified = true);
   virtual bool azimuthRateSpecified() const;


   virtual double maxAzimuthRate() const;
   virtual void setMaxAzimuthRate(double rate, bool isSpecified = true);
   virtual bool maxAzimuthRateSpecified() const;

   virtual bool fullAzimuthRotation() const;


   virtual double elevation() const;
   virtual void setElevation(double angle, bool isSpecified = true);
   virtual bool elevationSpecified() const;


   virtual double minElevation() const;
   virtual void setMinElevation(double angle, bool isSpecified = true);
   virtual bool minElevationSpecified() const;


   virtual double maxElevation() const;
   virtual void setMaxElevation(double angle, bool isSpecified = true);
   virtual bool maxElevationSpecified() const;


   virtual double elevationRate() const;
   virtual void setElevationRate(double rate, bool isSpecified = true);
   virtual bool elevationRateSpecified() const;


   virtual double maxElevationRate() const;
   virtual void setMaxElevationRate(double rate, bool isSpecified = true);
   virtual bool maxElevationRateSpecified() const;


   virtual double rotation() const;
   virtual void setRotation(double angle, bool isSpecified = true);
   virtual bool rotationSpecified() const;


   virtual double minRotation() const;
   virtual void setMinRotation(double angle, bool isSpecified = true);
   virtual bool minRotationSpecified() const;


   virtual double maxRotation() const;
   virtual void setMaxRotation(double angle, bool isSpecified = true);
   virtual bool maxRotationSpecified() const;


   virtual double rotationRate() const;
   virtual void setRotationRate(double rate, bool isSpecified = true);
   virtual bool rotationRateSpecified() const;


   virtual double maxRotationRate() const;
   virtual void setMaxRotationRate(double rate, bool isSpecified = true);
   virtual bool maxRotationRateSpecified() const;


   virtual const DtString& associatedComponent() const;
   virtual void setAssociatedComponent(const DtString& component, bool isSpecified = true);
   virtual bool associatedComponentSpecified() const;


   virtual const DtString& comment() const;
   virtual void setComment(const DtString& component, bool isSpecified = true);
   virtual bool commentSpecified() const;


   virtual const std::set<DtString>& configSources() const;
   virtual void setConfigSources(const std::set<DtString>& srcs);
   virtual void addConfigSource(const DtString& src);

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


   static double defaultRotationRate();
   static void setDefaultRotationRate(double rate);


   static double defaultTranslationRate();
   static void setDefaultTranslationRate(double rate);

protected:


   DtRwOffsetVector myAttachPoint;

   DtRwOffsetVector myEndPoint;

   DtRwVector myTranslation;

   DtRwVector myMinTranslation;

   DtRwVector myMaxTranslation;

   DtRwVector myTranslationRate;

   DtRwVector myMaxTranslationRate;

   DtRwReal myPosition;

   DtRwReal myPositionRate;

   DtRwReal myMaxPositionRate;

   DtRwReal myExtension;

   DtRwReal myMaxExtension;

   DtRwReal myExtensionRate;

   DtRwReal myMaxExtensionRate;

   DtRwReal myAzimuth;

   DtRwReal myMinAzimuth;

   DtRwReal myMaxAzimuth;

   DtRwReal myAzimuthRate;

   DtRwReal myMaxAzimuthRate;

   DtRwReal myElevation;

   DtRwReal myMinElevation;

   DtRwReal myMaxElevation;

   DtRwReal myElevationRate;

   DtRwReal myMaxElevationRate;

   DtRwReal myRotation;

   DtRwReal myMinRotation;

   DtRwReal myMaxRotation;

   DtRwReal myRotationRate;

   DtRwReal myMaxRotationRate;

   DtRwString myAssociatedComponent;

   DtRwString myComment;

   std::set<DtString> myConfigSources;

   static double theDefaultRotationRate;
   static double theDefaultTranslationRate;
};