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

TJammerAntiPenetrate Class Reference

TJammerAntiPenetrate represents an anti penetrate jammer for ships. More...

#include <item.h>

Inheritance diagram for TJammerAntiPenetrate:

Inheritance graph
[legend]
Collaboration diagram for TJammerAntiPenetrate:

Collaboration graph
[legend]
List of all members.

Public Methods

 TJammerAntiPenetrate ()
 TJammerAntiPenetrate (const TJammerAntiPenetrate &OldJammerAntiPenetrate)
virtual ~TJammerAntiPenetrate ()
virtual bool load (TDataPackageList *in)
virtual bool save (TDataPackageList *out) const
virtual TJammer::tJammerType getJammerType () const
virtual bool operator== (const TJammerAntiPenetrate &JammerAntiPenetrate) const
virtual TJammerAntiPenetrate & operator= (const TJammerAntiPenetrate &JammerAntiPenetrate)

Detailed Description

TJammerAntiPenetrate represents an anti penetrate 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 TJammerAntiPenetrate 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. An anti penetrate jammer is a jammer which tries to prevent the enemy from "seeing" inside the ship. But the efficiency value and which effects it exactly has is decided by the rule set/battle engine and of no direct concern to the class TJammerAntiPenetrate.


Constructor & Destructor Documentation

TJammerAntiPenetrate::TJammerAntiPenetrate  
 

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

TJammerAntiPenetrate::TJammerAntiPenetrate const TJammerAntiPenetrate &    OldJammerAntiPenetrate
 

This constructor creates also a new anti penetrate jammer, but its attributes are copied from the TJammerAntiPenetrate object given in OldJammerAntiPenetrate. This method is mostly implemented to provide a copy constructor.

Parameters:
OldJammerAntiPenetrate  the anti penetrate jammer to be copied

virtual TJammerAntiPenetrate::~TJammerAntiPenetrate   [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 TJammerAntiPenetrate::getJammerType   const [virtual]
 

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

Returns:
TJammer::ANTIPENETRATE

Reimplemented from TJammer.

virtual bool TJammerAntiPenetrate::load TDataPackageList   in [virtual]
 

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

This is the assignment operator for TJammerAntiPenetrate.

virtual bool TJammerAntiPenetrate::operator== const TJammerAntiPenetrate &    JammerAntiPenetrate const [virtual]
 

This is the compare operator for TJammerAntiPenetrate.

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

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

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