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

TJammerNormal Class Reference

TJammerNormal represents a normal jammer for ships. More...

#include <item.h>

Inheritance diagram for TJammerNormal:

Inheritance graph
[legend]
Collaboration diagram for TJammerNormal:

Collaboration graph
[legend]
List of all members.

Public Methods

 TJammerNormal ()
 TJammerNormal (const TJammerNormal &OldJammerNormal)
virtual ~TJammerNormal ()
virtual bool load (TDataPackageList *in)
virtual bool save (TDataPackageList *out) const
virtual TJammer::tJammerType getJammerType () const
virtual bool operator== (const TJammerNormal &JammerNormal) const
virtual TJammerNormal & operator= (const TJammerNormal &JammerNormal)

Detailed Description

TJammerNormal represents a normal jammer for ships.

Author:
Ralf Laue
Version:
Id:
item.h,v 1.34 2002/04/02 22:33:08 prolator Exp
See also:
TJammer
The class TJammerNormal is derived from TJammer and and can therefor be put on a ship. It has a value JamEfficiency (implemented in TJammer) and get and set methods for it. A normal jammer is a jammer which tries to prevent the real ship location from 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 TJammerNormal.


Constructor & Destructor Documentation

TJammerNormal::TJammerNormal  
 

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

TJammerNormal::TJammerNormal const TJammerNormal &    OldJammerNormal
 

This constructor creates also a new normal jammer, but its attributes are copied from the TJammerNormal object given in OldJammerNormal. This method is mostly implemented to provide a copy constructor.

Parameters:
OldJammerNormal  the normal jammer which shall be copied

virtual TJammerNormal::~TJammerNormal   [virtual]
 

Destructs the object. Has nothing else to do, because no memory has to be freed or similar stuff.


Member Function Documentation

virtual TJammer::tJammerType TJammerNormal::getJammerType   const [virtual]
 

With the method getJammerType you can get the type of the jammer, in this case TJammer::NORMAL.

Returns:
TJammer::NORMAL

Reimplemented from TJammer.

virtual bool TJammerNormal::load TDataPackageList   in [virtual]
 

The method Load loads a TJammerNormal 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 TJammer.

virtual TJammerNormal& TJammerNormal::operator= const TJammerNormal &    JammerNormal [virtual]
 

This is the assignment operator for TJammerNormal.

virtual bool TJammerNormal::operator== const TJammerNormal &    JammerNormal const [virtual]
 

This is the compare operator for TJammerNormal.

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

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

The method Save saves a TJammerNormal 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 TJammer.


The documentation for this class was generated from the following file:
Generated on Thu Jun 20 18:13:25 2002 for Stellar Legacy by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001