Device.h

Go to the documentation of this file.

//////////////////////////////////////////////////////////////////////////////////////////////////
/*! \file Device.h
*  \brief The Device class is used for setting the Active state of a device.
*  \author $Author: cakinli $
*  \version $Revision: 1.4 $
*  \date    $Date: 2005/02/25 18:40:52 $
*//////////////////////////////////////////////////////////////////////////////////////////////////
/*! 
*/
//////////////////////////////////////////////////////////////////////////////////////////////////


// Device() - Default Constructor
// Device(Device& _rdevDevice) - Copy Constructor
// ~Device() - Default Destructor
// IsActive() - Returns the current value of m_bActiveState
// Initialize() - Sets the value of m_bActiveState to true by calling SetActive(bool)
// Deinitialize() - Sets the value of m_bActiveState to false by calling SetActive(bool)
// SetActive(bool _bActiveState) - Sets the value of m_bActiveState to _bActiveState

#ifndef __SSSL_DEVICE_H__
#define __SSSL_DEVICE_H__

#include <Utils/CfgParse.h>
#include <Utils/Error.h>
#include <matrix/Matrix.h>
#include <string>
using namespace std;

using namespace O_SESSAME;

class Device  
{
public:
        // Constructor/Deconstructor
        Device(Device& _rdevDevice);
        virtual ~Device();

        // Inspectors
        bool IsActive();
        Vector GetLocation() const;
        
        // Mutators
        void SetLocation(const Vector& newDeviceLocation);
        //virtual int Initialize(const string& _sInitString) = 0;
        
        /** a constant bool that is equal to false. Used for setting the active state. */
        static const bool c_bNotActive = false;
        /** a constant bool that is equal to true. Used for setting the active state */
        static const bool c_bActive = true;
   
protected:
        Device();
        virtual int Initialize();
        virtual int Deinitialize();
        char *name;

private:
        // Facilitators
        int SetActive(bool _bActiveState);
        // Data Members
        /** the current state of the device as to whether or not it's been initialized. */
        bool m_bActiveState;
        /** physical location of the device with respect to the whorl body coordinates */
        Vector m_Location;
};

#endif 

// Do not change the comments below - they will be added automatically by CVS
/*****************************************************************************
*       $Log: Device.h,v $
*       Revision 1.4  2005/02/25 18:40:52  cakinli
*       Created Makefiles and organized include directives to reduce the number of
*       include paths.  Reorganized libraries so that there is now one per source
*       directory.  Each directory is self-contained in terms of its Makefile.
*       The local Makefile in each directory includes src/config.mk, which has all
*       the definitions and general and pattern rules.  So at most, to see what
*       goes into building a target, a person needs to examine the Makefile in
*       that directory, and ../config.mk.
*       
*       Revision 1.3  2003/08/13 23:13:41  mavandyk
*       Commented out a pure virtual function to allow code to compile properly.
*       
*       Revision 1.2  2003/07/21 20:16:52  bstreetman
*       updates
*       
*       Revision 1.1  2003/07/04 14:08:05  simpliciter
*       Rearranged directory tree.
*       
*       Revision 1.2  2003/06/30 15:51:57  nicmcp
*       made some changes to the controller files
*       
*       Revision 1.1.1.1  2003/06/06 18:44:15  simpliciter
*       Initial submission.
*       
*       Revision 1.1.1.1  2003/06/06 14:44:15  simpliciter
*       Initial import.
*       
*
******************************************************************************/

---