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

TScannerAntiDisguisePassive Class Reference

TScannerAntiDisguise represents a passive anti disguise scanner. More...

#include <item.h>

Inheritance diagram for TScannerAntiDisguisePassive:

Inheritance graph
[legend]
Collaboration diagram for TScannerAntiDisguisePassive:

Collaboration graph
[legend]
List of all members.

Public Methods

 TScannerAntiDisguisePassive ()
 TScannerAntiDisguisePassive (const TScannerAntiDisguisePassive &OldScannerAntiDisguisePassive)
virtual ~TScannerAntiDisguisePassive ()
virtual bool load (TDataPackageList *in)
virtual bool save (TDataPackageList *out) const
virtual TScanner::tScannerType getScannerType () const
virtual bool operator== (const TScannerAntiDisguisePassive &ScannerAntiDisguisePassive) const
virtual TScannerAntiDisguisePassive & operator= (const TScannerAntiDisguisePassive &ScannerAntiDisguisePassive)

Detailed Description

TScannerAntiDisguise represents a passive anti disguise scanner.

Author:
Ralf Laue
Version:
Id:
item.h,v 1.34 2002/04/02 22:33:08 prolator Exp
See also:
TScanner
The class TScannerAntiDisguisePassive 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 disguise scanner is a scanner which tries to indentify the true type/shape of an enemy ship, to prevent that a small ship is perceived as a huge battleship (or vice versa). 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 TScannerAntiDisguisePassive.


Constructor & Destructor Documentation

TScannerAntiDisguisePassive::TScannerAntiDisguisePassive  
 

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

TScannerAntiDisguisePassive::TScannerAntiDisguisePassive const TScannerAntiDisguisePassive &    OldScannerAntiDisguisePassive
 

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

Parameters:
OldScannerAntiDisguisePassive  the normal passive scanner which shall be copied

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

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

Returns:
TScanner::ANTIDISGUISE_PASSIVE

Reimplemented from TScanner.

virtual bool TScannerAntiDisguisePassive::load TDataPackageList   in [virtual]
 

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

This is the assignment operator for TScannerAntiDisguisePassive.

virtual bool TScannerAntiDisguisePassive::operator== const TScannerAntiDisguisePassive &    ScannerAntiDisguisePassive const [virtual]
 

This is the compare operator for TScannerAntiDisguisePassive.

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

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

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