Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

TScannerNormalPassive Class Reference

TScannerNormalPassive represents a passive normal scanner for ships. More...

#include <item.h>

Inheritance diagram for TScannerNormalPassive:

Inheritance graph
[legend]
Collaboration diagram for TScannerNormalPassive:

Collaboration graph
[legend]
List of all members.

Public Methods

 TScannerNormalPassive ()
 TScannerNormalPassive (const TScannerNormalPassive &OldScannerNormalPassive)
virtual ~TScannerNormalPassive ()
virtual bool load (TDataPackageList *in)
virtual bool save (TDataPackageList *out) const
virtual TScanner::tScannerType getScannerType () const
virtual bool operator== (const TScannerNormalPassive &ScannerNormalPassive) const
virtual TScannerNormalPassive & operator= (const TScannerNormalPassive &ScannerNormalPassive)

Detailed Description

TScannerNormalPassive represents a passive normal scanner for ships.

Author:
Ralf Laue
Version:
Id:
item.h,v 1.34 2002/04/02 22:33:08 prolator Exp
See also:
TScanner
The class TScannerNormalPassive is derived from TScanner and and can therefor be put on a ship. It has a value ScanEfficiency (implemented in TScanner) and get and set methods for it. A passive normal scanner is a scanner which tries to locate the exact position of the enemy ship. Because it is passive it should be less effective than the active version. On the plus side, because of its passive nature, there is no increased risk of being detected. But the exact efficiency value and which effects it exactly has is decided by the rule set/battle engine and of no direct concern to the class TScannerNormalPassive.


Constructor & Destructor Documentation

TScannerNormalPassive::TScannerNormalPassive  
 

This constructor generates a new TScannerNormalPassive object with all properties resetted. This means you have to set all properties like name and mass afterwards with help of the respective set<something> methods.

TScannerNormalPassive::TScannerNormalPassive const TScannerNormalPassive &    OldScannerNormalPassive
 

This constructor creates also a new passive normal scanner, but its attributes are copied from the TScannerNormalPassive object given in OldScannerNormalPassive. This method is mostly implemented to provide a copy constructor.

Parameters:
OldScannerNormalPassive  the normal passive scanner which shall be copied

virtual TScannerNormalPassive::~TScannerNormalPassive   [virtual]
 

Destructs the object. Has nothing else to do, because no memory has to be freed or similar stuff.


Member Function Documentation

virtual TScanner::tScannerType TScannerNormalPassive::getScannerType   const [virtual]
 

With the method getScannerType you can get the type of the scanner, in this case TScanner::NORMAL_PASSIVE.

Returns:
TScanner::NORMAL_PASSIVE

Reimplemented from TScanner.

virtual bool TScannerNormalPassive::load TDataPackageList   in [virtual]
 

The method Load loads a TScannerNormalPassive object from the data packages in the list.

Parameters:
in  the list of data packages
Returns:
true means that everything was loaded correctly, otherwise this method will return false.
See also:
TLinkable

Reimplemented from TScanner.

virtual TScannerNormalPassive& TScannerNormalPassive::operator= const TScannerNormalPassive &    ScannerNormalPassive [virtual]
 

This is the assignment operator for TScannerNormalPassive.

virtual bool TScannerNormalPassive::operator== const TScannerNormalPassive &    ScannerNormalPassive const [virtual]
 

This is the compare operator for TScannerNormalPassive.

Parameters:
ScannerNormalPassive  the TScannerNormalPassive object which shall be compared with "*this"
Returns:
true if the TScannerNormalPassive objects are equal and false if not

virtual bool TScannerNormalPassive::save TDataPackageList   out const [virtual]
 

The method Save saves a TScannerNormalPassive object by adding the data packages to the list.

Parameters:
out  the output stream of data packages
Returns:
true means that everything was saved correctly, otherwise this method will return false.
See also:
TLinkable

Reimplemented from TScanner.


The documentation for this class was generated from the following file:
Generated on Thu Jun 20 18:13:32 2002 for Stellar Legacy by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001