include/vrfobjparam/convoyDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: convoyDescriptor.h,v $ $Revision: 1.0 $ $State: Exp $
*******************************************************************************/



#ifndef DtConvoyDescriptor_H_
#define DtConvoyDescriptor_H_


#include "vrfobjparam/compDesc.h"
#include "vrfutil/rwReal.h"
#include "vrfutil/rwBoolean.h"
#include "vrfobjparam/railPathControllerDescriptor.h"

class DtReaderWriterRegistry;

#include "vrfobjparam/vrfobjparamDefines.h"
class DT_DLL_vrfobjparam DtConvoyDescriptor : public DtRailPathControllerDescriptor
{
public:
   DtConvoyDescriptor(const DtString& name, DtReaderWriterRegistry *
      parentRegistry = 0);
   
   DtConvoyDescriptor(const DtConvoyDescriptor & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);
   
   DtConvoyDescriptor & operator=(const 
      DtConvoyDescriptor & orig);
   
   virtual ~DtConvoyDescriptor();

   virtual DtString type() const;

   virtual void setSeparationDistance(DtReal distance);
   virtual DtReal separationDistance() const;

   virtual void setSeparationTolerance(DtReal tolerancePercent);
   virtual DtReal separationTolerance() const;

   virtual DtComponentDescriptor * clone(DtReaderWriterRegistry * parentRegistry
       = 0) const;

   static DtComponentDescriptor * creator();

protected:
   DtConvoyDescriptor();

protected:

   DtRwReal mySeparationDistance;
   DtRwReal mySeparationTolerance;
};

#endif