MotorData.h

Go to the documentation of this file.
00001 /*************************************************************************
00002  *                                                                       *
00003  * Open Physics Abstraction Layer                                        *
00004  * Copyright (C) 2004-2005                                               *
00005  * Alan Fischer  alan.fischer@gmail.com                                  *
00006  * Andres Reinot  andres@reinot.com                                      *
00007  * Tyler Streeter  tylerstreeter@gmail.com                               *
00008  * All rights reserved.                                                  *
00009  * Web: opal.sourceforge.net                                             *
00010  *                                                                       *
00011  * This library is free software; you can redistribute it and/or         *
00012  * modify it under the terms of EITHER:                                  *
00013  *   (1) The GNU Lesser General Public License as published by the Free  *
00014  *       Software Foundation; either version 2.1 of the License, or (at  *
00015  *       your option) any later version. The text of the GNU Lesser      *
00016  *       General Public License is included with this library in the     *
00017  *       file license-LGPL.txt.                                          *
00018  *   (2) The BSD-style license that is included with this library in     *
00019  *       the file license-BSD.txt.                                       *
00020  *                                                                       *
00021  * This library is distributed in the hope that it will be useful,       *
00022  * but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00023  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the files    *
00024  * license-LGPL.txt and license-BSD.txt for more details.                *
00025  *                                                                       *
00026  *************************************************************************/
00027 
00028 #ifndef OPAL_MOTOR_DATA_H
00029 #define OPAL_MOTOR_DATA_H
00030 
00031 #include "Defines.h"
00032 
00033 namespace opal
00034 {
00036         enum MotorType
00037         {
00038                 ATTRACTOR_MOTOR,
00039                 GEARED_MOTOR,
00040                 SERVO_MOTOR,
00041                 SPRING_MOTOR,
00042                 THRUSTER_MOTOR,
00043         VELOCITY_MOTOR
00044         };
00045 
00047         class MotorData
00048         {
00049         public:
00050                 OPAL_DECL MotorData()
00051                 {
00052                         // The initial type doesn't matter since the abstract base 
00053                         // class will never be instantiated.
00054                         mType = ATTRACTOR_MOTOR;
00055                         enabled = defaults::motor::enabled;
00056                         name = "";
00057                 }
00058 
00059                 OPAL_DECL virtual ~MotorData()
00060                 {
00061                 }
00062 
00064                 OPAL_DECL virtual MotorType OPAL_CALL getType()const
00065                 {
00066                         return mType;
00067                 }
00068 
00070                 bool enabled;
00071 
00073                 std::string name;
00074 
00075         protected:
00077                 MotorType mType;
00078 
00079         private:
00080         };
00081 }
00082 
00083 #endif

Generated on Tue May 16 17:49:51 2006 for OPAL by  doxygen 1.4.6-NO