kynapseDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2009 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
* Copyright 2009 Autodesk, Inc.  All rights reserved.
* Use of this software is subject to the terms of the Autodesk license 
* agreement provided at the time of installation or download, or which otherwise
* accompanies this software in either electronic or hard copy form.
*******************************************************************************/


#ifndef KYNAPSE_DESCRIPTOR_H
#define KYNAPSE_DESCRIPTOR_H

#include <vrfobjparam/componentDescriptor.h>
#include <vrfutil/rwString.h>
#include "bhaveMsgs/bhaveMsgsDefines.h"
#include "bhaveMsgs/pathSoilFactor.h"

class DtReaderWriterRegistry;

namespace BHAVE
{
const char KynapseDescriptorType[] = "kynapse-descriptor";

class DT_DLL_bhaveMsgs KynapseDescriptor : public DtComponentDescriptor
{
public:
   KynapseDescriptor(const DtString& name, 
      DtReaderWriterRegistry * parentRegistry = 0);
   
   KynapseDescriptor(const KynapseDescriptor & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);
   
   KynapseDescriptor & operator=(const 
      KynapseDescriptor & orig);
   
   virtual DtComponentDescriptor * clone(DtReaderWriterRegistry * 
      parentRegistry = 0) const;

   virtual ~KynapseDescriptor();
   

   virtual DtString type() const;
   
   static DtComponentDescriptor * creator();

   
   virtual void setPublishDebugRoutes(bool val);
   virtual bool publishDebugRoutes() const;

   //{@
   virtual void setInitialMovementMode(const DtString& val);
   virtual const DtString initalMovementMode() const;


   virtual void setNearDistance(DtReal nearDistance);
   virtual DtReal nearDistance() const;

   virtual void setApproachSpeed(DtReal approachSpeed);
   virtual DtReal approachSpeed() const;

   virtual void setAtDistance(DtReal atDistance);
   virtual DtReal atDistance() const;

   virtual void setBotClass(DtRwString botclass);
   virtual DtRwString botClass() const;

   virtual DtPathSoilFactorList& pathSoilFactorList();
   virtual const DtPathSoilFactorList& pathSoilFactorList() const;

   virtual void getSelf(DtlObjPtr args, const SearchPaths& searchPaths);

protected:
   DtRwBoolean myPublishDebugRoutes;

   DtRwString myInitialMovementMode;

   DtRwReal myNearDistance;

   DtRwReal myAtDistance;

   DtRwReal myApproachSpeed;

   DtRwString myBotClass;

   DtPathSoilFactorList myPathSoilFactorList;
};

#endif 

}