Device.cpp

Go to the documentation of this file.

/*************************************************/
/*! \file Device.cpp
*  \brief Implementation of the Device superclass.
*  \@author $@author: nilspace $
*  \version $Revision: 1.1 $
*  \date    $@date 2003/03/26 16:38:58 $
**************************************************/
/*! 
*/

#include "Device.h"

/***********************************
* Construction/Destruction
***********************************/

/** @brief Create an object of type Device.
* @author Andrew Turner
* @date March 25, 1999
* This constructor is called to create an object of type Device and sets
*       the initial state to c_bNotActive
* Assumptions: The default state of a device is c_bNotActive
*/
Device::Device()
{
        SetActive(c_bNotActive);
}

/** @brief Create a copy of object type Device.
* @author Andrew Turner
* @date March 25, 1999
* This constructor copies the m_bActiveState
* External Methods Called: SetActive(bool)
* Assumptions: None
*/
Device::Device(Device& _rdevDevice)
{
        SetActive(_rdevDevice.IsActive());
}

/** @brief Uninitializes and removes Device from memory.
* @author Andrew Turner
* @date March 25, 1999
* This constructor calls Device::Deinitialize
* Assumptions: None
*/
Device::~Device()
{
    Deinitialize();
}

/** @brief Returns the current state of m_bActiveState.
    * @author Andrew Turner
    * @date March 25, 1999
    * This member function is used to inspect the state of the device
    * External Methods Called: None
    * Assumptions: None
    */
bool Device::IsActive()
{
        return m_bActiveState;
}

/** @brief Specify the physical location of the device with respect to whorl body coordinates.
    * @param newDeviceLocation Physical center of the device [x,y,z]^T (meters).
    */
void Device::SetLocation(const Vector& newDeviceLocation)
{
    m_Location = newDeviceLocation;
}

/** @brief Returns the physical location of the device with respect to whorl body coordinates.
    * @return Physical center of the device [x,y,z]^T (meters).
    */
Vector Device::GetLocation() const
{
    return m_Location;
}

/** @brief Sets the value of m_bActiveState to _bActiveState.
    * @author Andrew Turner
    * @date March 25, 1999
    * This member function is used to set the current state of the device
    * External Methods Called: None
    * Assumptions: None
    */
int Device::SetActive(bool _bActiveState)
{
        m_bActiveState = _bActiveState;
        return NO_ERROR;
}

/** @brief Initializes the device for use.
    * @author Andrew Turner
    * @date March 25, 1999
    * Allows the device to be used now that it is Active
    * External Methods Called: SetActive(bool)
    * Assumptions: None
    */
int Device::Initialize()
{
        SetActive(c_bActive);
        return NO_ERROR;
}

/** @brief Deinitializes the device from further use.
* @author Andrew Turner
* @date March 25, 1999
* Prevents the device from being used.
* External Methods Called: SetActive(bool)
* Assumptions: None
*/
int Device::Deinitialize()
{
        SetActive(c_bNotActive);
        return NO_ERROR;
}


// Do not change the comments below - they will be added automatically by CVS
/*****************************************************************************
*       $Log: Device.cpp,v $
*       Revision 1.1  2003/07/04 14:08:05  simpliciter
*       Rearranged directory tree.
*       
*       Revision 1.1.1.1  2003/06/06 18:44:15  simpliciter
*       Initial submission.
*       
*       Revision 1.2  2003/06/06 17:45:30  simpliciter
*       Removed spurious @detail tags.
*       
*       Revision 1.1.1.1  2003/06/06 14:44:14  simpliciter
*       Initial import.
*       
*
******************************************************************************/

---