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

TScannerAntiCloakPassive Class Reference

TScannerAntiCloak represents a passive anti cloak scanner. More...

#include <item.h>

Inheritance diagram for TScannerAntiCloakPassive:

Inheritance graph
[legend]
Collaboration diagram for TScannerAntiCloakPassive:

Collaboration graph
[legend]
List of all members.

Public Methods

 TScannerAntiCloakPassive ()
 TScannerAntiCloakPassive (const TScannerAntiCloakPassive &OldScannerAntiCloakPassive)
virtual ~TScannerAntiCloakPassive ()
virtual bool load (TDataPackageList *in)
virtual bool save (TDataPackageList *out) const
virtual TScanner::tScannerType getScannerType () const
virtual bool operator== (const TScannerAntiCloakPassive &ScannerAntiCloakPassive) const
virtual TScannerAntiCloakPassive & operator= (const TScannerAntiCloakPassive &ScannerAntiCloakPassive)

Detailed Description

TScannerAntiCloak represents a passive anti cloak scanner.

Author:
Ralf Laue
Version:
Id:
item.h,v 1.34 2002/04/02 22:33:08 prolator Exp
See also:
TScanner
The class TScannerAntiCloakPassive 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 anti cloak scanner is a scanner which tries to detect cloaked ships. 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 TScannerAntiCloakPassive.


Constructor & Destructor Documentation

TScannerAntiCloakPassive::TScannerAntiCloakPassive  
 

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

TScannerAntiCloakPassive::TScannerAntiCloakPassive const TScannerAntiCloakPassive &    OldScannerAntiCloakPassive
 

This constructor creates also a new passive anti cloak scanner, but its attributes are copied from the TScannerAntiCloakPassive object given in OldScannerAntiCloakPassive. This method is mostly implemented to provide a copy constructor.

Parameters:
OldScannerAntiCloakPassive  the normal passive scanner which shall be copied

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

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

Returns:
TScanner::ANTICLOAK_PASSIVE

Reimplemented from TScanner.

virtual bool TScannerAntiCloakPassive::load TDataPackageList   in [virtual]
 

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

This is the assignment operator for TScannerAntiCloakPassive.

virtual bool TScannerAntiCloakPassive::operator== const TScannerAntiCloakPassive &    ScannerAntiCloakPassive const [virtual]
 

This is the compare operator for TScannerAntiCloakPassive.

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

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

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