Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

OSCAR::Sensor< Type > Class Template Reference
[Device]

Base class for all Sensors. Each Sensor should be derived from this class and should support all the methods. More...

#include <Sensor.h>

Inheritance diagram for OSCAR::Sensor< Type >:

Inheritance graph
[legend]
List of all members.

Public Methods

 Sensor (const String &name=String(), OSCARError &err=OSCARError(noError))
 Sensor (const Sensor< Type > &sensor)
Sensor< Type > & operator= (const Sensor< Type > &sensor)
virtual ~Sensor ()
virtual bool Read (const Type &data)

Detailed Description

template<class Type>
class OSCAR::Sensor< Type >

Author:
Chetan Kapoor

Constructor & Destructor Documentation

template<class Type>
OSCAR::Sensor< Type >::Sensor (  const String &    name = String(),
OSCARError &    err = OSCARError(noError)
) 
 

Constructor for Sensor Use this to construct a Sensor object in which no Sensor frame is specified.

Parameters:
name Name you want to assign to object. Default is " ".
err An OSCARError object that on return will hold the value of the error code that was generated when the constructor was called. If this error was not 'noError' you can call GetError() to get the details of the error code.

template<class Type>
OSCAR::Sensor< Type >::Sensor (  const Sensor< Type > &    sensor ) 
 

template<class Type>
virtual OSCAR::Sensor< Type >::~Sensor (    )  [inline, virtual]
 

Destructor for Sensor.

Member Function Documentation

template<class Type>
Sensor<Type>& OSCAR::Sensor< Type >::operator= (  const Sensor< Type > &    sensor ) 
 

template<class Type>
virtual bool OSCAR::Sensor< Type >::Read (  const Type &    data )  [virtual]
 

Method to read one packet of information from the sensor. This should be overriden in derived classes. For Sensor class, this method checks to see if the Sensor has been initialized by a call to the Initialize() method. Derived classes should call Sensor::Read(const Type& data) before executing specific reading commands for their sensor.

Returns:
true or false. If false, call GetError() for detailed information
Parameters:
data On return, data will hold the information that is read from the sensor
Exceptions:
notInitialize notInitialized

The documentation for this class was generated from the following file:
RRG Homepage OSCAR Overview OSCAR Tutorials Simulations