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

TScannerNormalActive Class Reference

TScannerNormalActive represents a active normal scanner for ships. More...

#include <item.h>

Inheritance diagram for TScannerNormalActive:

Inheritance graph
[legend]
Collaboration diagram for TScannerNormalActive:

Collaboration graph
[legend]
List of all members.

Public Methods

 TScannerNormalActive ()
 TScannerNormalActive (const TScannerNormalActive &OldScannerNormalActive)
virtual ~TScannerNormalActive ()
virtual bool load (TDataPackageList *in)
virtual bool save (TDataPackageList *out) const
virtual TScanner::tScannerType getScannerType () const
virtual bool operator== (const TScannerNormalActive &ScannerNormalActive) const
virtual TScannerNormalActive & operator= (const TScannerNormalActive &ScannerNormalActive)

Detailed Description

TScannerNormalActive represents a active 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 TScannerNormalActive 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 normal scanner is a scanner which tries to locate the exact position of the 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 TScannerNormalActive.


Constructor & Destructor Documentation

TScannerNormalActive::TScannerNormalActive  
 

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

TScannerNormalActive::TScannerNormalActive const TScannerNormalActive &    OldScannerNormalActive
 

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

Parameters:
OldScannerNormalActive  the normal active scanner which shall be copied

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

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

Returns:
TScanner::NORMAL_ACTIVE

Reimplemented from TScanner.

virtual bool TScannerNormalActive::load TDataPackageList   in [virtual]
 

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

This is the assignment operator for TScannerNormalActive.

virtual bool TScannerNormalActive::operator== const TScannerNormalActive &    ScannerNormalActive const [virtual]
 

This is the compare operator for TScannerNormalActive.

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

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

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