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

TScannerPenetratePassive Class Reference

TScannerPenetratePassive represents a passive penetrate scanner. More...

#include <item.h>

Inheritance diagram for TScannerPenetratePassive:

Inheritance graph
[legend]
Collaboration diagram for TScannerPenetratePassive:

Collaboration graph
[legend]
List of all members.

Public Methods

 TScannerPenetratePassive ()
 TScannerPenetratePassive (const TScannerPenetratePassive &OldScannerPenetratePassive)
virtual ~TScannerPenetratePassive ()
virtual bool load (TDataPackageList *in)
virtual bool save (TDataPackageList *out) const
virtual TScanner::tScannerType getScannerType () const
virtual bool operator== (const TScannerPenetratePassive &ScannerPenetratePassive) const
virtual TScannerPenetratePassive & operator= (const TScannerPenetratePassive &ScannerPenetratePassive)

Detailed Description

TScannerPenetratePassive represents a passive penetrate scanner.

Author:
Ralf Laue
Version:
Id:
item.h,v 1.34 2002/04/02 22:33:08 prolator Exp
See also:
TScanner
The class TScannerPenetratePassive 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 penetrate scanner is a scanner which tries to "see" inside an (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 TScannerPenetratePassive.


Constructor & Destructor Documentation

TScannerPenetratePassive::TScannerPenetratePassive  
 

This constructor generates a new TScannerPenetratePassive 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.

TScannerPenetratePassive::TScannerPenetratePassive const TScannerPenetratePassive &    OldScannerPenetratePassive
 

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

Parameters:
OldScannerPenetratePassive  the penetrate passive scanner which shall be copied

virtual TScannerPenetratePassive::~TScannerPenetratePassive   [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 TScannerPenetratePassive::getScannerType   const [virtual]
 

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

Returns:
TScanner::PENETRATE_PASSIVE

Reimplemented from TScanner.

virtual bool TScannerPenetratePassive::load TDataPackageList   in [virtual]
 

The method Load loads a TScannerPenetratePassive 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 TScannerPenetratePassive& TScannerPenetratePassive::operator= const TScannerPenetratePassive &    ScannerPenetratePassive [virtual]
 

This is the assignment operator for TScannerPenetratePassive.

virtual bool TScannerPenetratePassive::operator== const TScannerPenetratePassive &    ScannerPenetratePassive const [virtual]
 

This is the compare operator for TScannerPenetratePassive.

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

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

The method Save saves a TScannerPenetratePassive 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:33 2002 for Stellar Legacy by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001