simArtPartDescriptor.h

Go to the documentation of this file.

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



#pragma once

#include <vrfobjparam/rwArtPartState.h>
#include <readerWriter/rwInt.h>
#include <readerWriter/rwReal.h>
#include "readerWriter/rwVector.h"
#include "vrfobjparam/simArtPartParamList.h"
#include <vlpi/disEnums.h>

class DtReaderWriterRegistry;

#include "vrfobjparam/vrfobjparamDefines.h"
class DT_DLL_vrfobjparam DtSimArtPartDescriptor : public DtRwArtPartState
{
protected:
   DtSimArtPartDescriptor();

public:
   DtSimArtPartDescriptor(const DtString& partName, DtReaderWriterRegistry *
      parentRegistry = NULL);

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

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

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

   DtSimArtPartDescriptor(const DtSimArtPartDescriptor& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtSimArtPartDescriptor& operator=(const DtSimArtPartDescriptor & orig);

   virtual ~DtSimArtPartDescriptor();

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

   virtual DtSimArtPartDescriptor* clone(const DtSymbolString& partName, 
      DtReaderWriterRegistry* parentRegistry = NULL) const;
   
   virtual void setParamList(const DtSimArtPartParamList& paramList);
   virtual const DtSimArtPartParamList& paramList() const;
   virtual bool paramListSpecified() const;

   virtual void setPartType(DtArtPartType partType);
   virtual DtArtPartType partType() const;
   virtual bool partTypeSpecified() const;

   virtual void setParentPartType(DtArtPartType partType);
   virtual DtArtPartType parentPartType() const;
   virtual bool parentPartTypeSpecified() const;

   virtual DtReal azimuthNeutralOffset() const;
   virtual void setAzimuthNeutralOffset(DtReal offset);
   virtual bool azimuthNeutralOffsetSpecified() const;

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

   virtual void setAllValuesUnspecified();

   virtual void markMatchingFieldsUnspecified(const DtSimArtPartDescriptor& other);

   virtual void writeOnlySpecifiedParameters();

   virtual void writeOnlyApplicableParameters();

   virtual void prePutSelf();

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

   virtual bool approxEq(const DtSimArtPartDescriptor& rhs, double diff) const;

   static const char* theXmlType();

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

   virtual DtString partTypeSystemParamName() const;

   virtual void setPartTypeSystemParamName(const DtString& paramName);

protected:

   virtual const char* readerWriterType() const;

protected:


   DtRwInt myPartType;

   DtRwInt myParentPartType;
   
   DtSimArtPartParamList myParamList;

   DtRwReal myAzimuthNeutralOffset;

   DtString myPartTypeSystemParamNameOverride;
};