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

TScannerPenetrateActive Class Reference

TScannerPenetrateActive represents a active penetrate scanner. More...

#include <item.h>

Inheritance diagram for TScannerPenetrateActive:

Inheritance graph
[legend]
Collaboration diagram for TScannerPenetrateActive:

Collaboration graph
[legend]
List of all members.

Public Methods

 TScannerPenetrateActive ()
 TScannerPenetrateActive (const TScannerPenetrateActive &OldScannerPenetrateActive)
virtual ~TScannerPenetrateActive ()
virtual bool load (TDataPackageList *in)
virtual bool save (TDataPackageList *out) const
virtual TScanner::tScannerType getScannerType () const
virtual bool operator== (const TScannerPenetrateActive &ScannerPenetrateActive) const
virtual TScannerPenetrateActive & operator= (const TScannerPenetrateActive &ScannerPenetrateActive)

Detailed Description

TScannerPenetrateActive represents a active 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 TScannerPenetrateActive 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 active penetrate scanner is a scanner which tries to "see" inside an (enemy) ship. Because it is active it should be more effective than the passive version. On the down side, because it's active nature it also increases the risk of being dectected. 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 TScannerPenetrateActive.


Constructor & Destructor Documentation

TScannerPenetrateActive::TScannerPenetrateActive  
 

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

TScannerPenetrateActive::TScannerPenetrateActive const TScannerPenetrateActive &    OldScannerPenetrateActive
 

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

Parameters:
OldScannerPenetrateActive  the penetrate active scanner which shall be copied

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

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

Returns:
TScanner::PENETRATE_ACTIVE

Reimplemented from TScanner.

virtual bool TScannerPenetrateActive::load TDataPackageList   in [virtual]
 

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

This is the assignment operator for TScannerPenetrateActive.

virtual bool TScannerPenetrateActive::operator== const TScannerPenetrateActive &    ScannerPenetrateActive const [virtual]
 

This is the compare operator for TScannerPenetrateActive.

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

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

The method Save saves a TScannerPenetrateActive 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