VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Attributes
DtIfIndirectArtilleryData Class Reference

Data container for Indirect Artillery. More...

Inheritance diagram for DtIfIndirectArtilleryData:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtIfIndirectArtilleryData ()
 DtIfIndirectArtilleryData (const DtIfIndirectArtilleryData &)
const DtIfIndirectArtilleryDataoperator= (const DtIfIndirectArtilleryData &)
virtual bool update (const DtIfIndirectArtilleryData &)
 like operator =, except return true if the contents were actually modified, false if they were unchanged by the assignment.
virtual ~DtIfIndirectArtilleryData ()
bool modifyColor () const
bool modifyAttachedTo () const
bool modifyParent () const
bool modifyUserData () const
virtual void setName (const DtString &)
 Set the parent name of this overlay object.
virtual const DtStringname () const
 Set the parent name of this overlay object.
virtual const DtList & vertices () const
 Set and return vertices.
virtual void setVertices (const DtList &)
 Set and return vertices.
virtual void setUserData (const char *userData, int iLen)
 Set and return user Data.
virtual const char * userData () const
 Set and return user Data.
virtual int userDataLen () const
 Set and return user Data.
virtual const DtEntityIdentifier & objectIdentifier () const
 Set and return the object identifier.
virtual void setObjectIdentifier (const DtEntityIdentifier &objectIdentifier)
 Set and return the object identifier.
virtual void setParentName (const DtString &parentName)
 Set the parent name of this overlay object.
virtual const DtStringparentName () const
 Set the parent name of this overlay object.
virtual void setLabel (const DtString &label)
 Set the parent name of this overlay object.
virtual const DtStringlabel () const
 Set the parent name of this overlay object.
virtual void setForce (const DtForceType &forceType)
 Set the parent name of this overlay object.
virtual const DtForceType force () const
 Set the parent name of this overlay object.
virtual void setAppearance (const DtAppearance &appearance)
 Set the parent name of this overlay object.
virtual const DtAppearance & appearance () const
 Set the parent name of this overlay object.
virtual void setAttachmentName (const DtString &attachName)
 Set the attachment name of this overlay object.
virtual const DtStringattachmentName () const
 Set the attachment name of this overlay object.
virtual void setKeepExistingAttachment (bool keepExisting)
 Set the keep attachment flag.
virtual bool keepExistingAttachment () const
 Set the keep attachment flag.
virtual void setColor (int color)
 Set the color of the object.
virtual int color () const
 Set the color of the object.
virtual void setStartTimeImmediate (bool value)
 If true, then the artillery start time will be treated as the same time that the object is created.
virtual bool startTimeImmediate () const
 If true, then the artillery start time will be treated as the same time that the object is created.
virtual void setStartTime (int)
 Set and return the time the first salvo will arrive.
virtual int startTime () const
 Set and return the time the first salvo will arrive.
virtual void setTimeBetweenSalvos (int)
 Set and return the time between salvos.
virtual int timeBetweenSalvos () const
 Set and return the time between salvos.
virtual void setScatterTime (double)
 Set and return the time over which an individual salvo will arrive.
virtual double scatterTime () const
 Set and return the time over which an individual salvo will arrive.
virtual void setNumberOfSalvos (int)
 Set and return the number of salvos to deliver.
virtual int numberOfSalvos () const
 Set and return the number of salvos to deliver.
virtual void setRoundsPerSalvo (int)
 Set and return the number of rounds per salvo.
virtual int roundsPerSalvo () const
 Set and return the number of rounds per salvo.
virtual void setAltitudeAboveTerrain (double)
 Set and return the altitude above the terrain (in meters) to detonate the salvo.
virtual double altitudeAboveTerrain () const
 Set and return the altitude above the terrain (in meters) to detonate the salvo.
virtual void setWindDirection (double)
 Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.
virtual double windDirection () const
 Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.
virtual void setWindDistance (int)
 Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.
virtual int windDistance () const
 Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.
virtual void setMunitionType (const DtEntityType &)
 Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.
virtual void setMunitionType (const DtString &)
 Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.
virtual const DtEntityType & munitionType () const
 Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.
virtual size_t size () const
 Encode/decode to a buffer.
virtual char * encode (char *buffer) const
 Encode/decode to a buffer.
virtual const char * decode (const char *buffer)
 Encode/decode to a buffer.

Protected Attributes

DtEntityIdentifier myObjectIdentifier
DtForceType myForceType
bool myKeepExistingAttachment
int myColor
DtAppearance myAppearance
int myUserDataLen
int myModificationFlags
bool myStartTimeImmediate
int myStartTime
int myTimeBetweenSalvos
double myScatterTime
int myNumberOfSalvos
int myRoundsPerSalvo
double myWindDirection
int myWindDistance
DtEntityType myMunitionType
const char * myUserData
DtString myName
DtString myParentName
DtString myAttachmentName
DtString myLabel
DtList myVertices
double myAltitudeAboveTerrain

Detailed Description

Data container for Indirect Artillery.

Should contain nothing but mutators, accessors and data. Use this as a muliply inherited mix in for entities that need indirect artillery data


Constructor & Destructor Documentation


Member Function Documentation

const DtIfIndirectArtilleryData& DtIfIndirectArtilleryData::operator= ( const DtIfIndirectArtilleryData )

like operator =, except return true if the contents were actually modified, false if they were unchanged by the assignment.

virtual void DtIfIndirectArtilleryData::setName ( const DtString ) [virtual]

Set the parent name of this overlay object.

virtual const DtString& DtIfIndirectArtilleryData::name ( ) const [virtual]

Set the parent name of this overlay object.

virtual const DtList& DtIfIndirectArtilleryData::vertices ( ) const [virtual]

Set and return vertices.

virtual void DtIfIndirectArtilleryData::setVertices ( const DtList &  ) [virtual]

Set and return vertices.

virtual void DtIfIndirectArtilleryData::setUserData ( const char *  userData,
int  iLen 
) [virtual]

Set and return user Data.

Class will make a shallow copy of user data. Caller is responsible for managing ptr which is passed in!

virtual const char* DtIfIndirectArtilleryData::userData ( ) const [virtual]

Set and return user Data.

Class will make a shallow copy of user data. Caller is responsible for managing ptr which is passed in!

virtual int DtIfIndirectArtilleryData::userDataLen ( ) const [virtual]

Set and return user Data.

Class will make a shallow copy of user data. Caller is responsible for managing ptr which is passed in!

virtual const DtEntityIdentifier& DtIfIndirectArtilleryData::objectIdentifier ( ) const [virtual]

Set and return the object identifier.

virtual void DtIfIndirectArtilleryData::setObjectIdentifier ( const DtEntityIdentifier &  objectIdentifier) [virtual]

Set and return the object identifier.

virtual void DtIfIndirectArtilleryData::setParentName ( const DtString parentName) [virtual]

Set the parent name of this overlay object.

virtual const DtString& DtIfIndirectArtilleryData::parentName ( ) const [virtual]

Set the parent name of this overlay object.

virtual void DtIfIndirectArtilleryData::setLabel ( const DtString label) [virtual]

Set the parent name of this overlay object.

virtual const DtString& DtIfIndirectArtilleryData::label ( ) const [virtual]

Set the parent name of this overlay object.

virtual void DtIfIndirectArtilleryData::setForce ( const DtForceType &  forceType) [virtual]

Set the parent name of this overlay object.

virtual const DtForceType DtIfIndirectArtilleryData::force ( ) const [virtual]

Set the parent name of this overlay object.

virtual void DtIfIndirectArtilleryData::setAppearance ( const DtAppearance &  appearance) [virtual]

Set the parent name of this overlay object.

virtual const DtAppearance& DtIfIndirectArtilleryData::appearance ( ) const [virtual]

Set the parent name of this overlay object.

virtual void DtIfIndirectArtilleryData::setAttachmentName ( const DtString attachName) [virtual]

Set the attachment name of this overlay object.

virtual const DtString& DtIfIndirectArtilleryData::attachmentName ( ) const [virtual]

Set the attachment name of this overlay object.

virtual void DtIfIndirectArtilleryData::setKeepExistingAttachment ( bool  keepExisting) [virtual]

Set the keep attachment flag.

Set the keep attachment flag.

virtual void DtIfIndirectArtilleryData::setColor ( int  color) [virtual]

Set the color of the object.

virtual int DtIfIndirectArtilleryData::color ( ) const [virtual]

Set the color of the object.

virtual void DtIfIndirectArtilleryData::setStartTimeImmediate ( bool  value) [virtual]

If true, then the artillery start time will be treated as the same time that the object is created.

If true, then the artillery start time will be treated as the same time that the object is created.

virtual void DtIfIndirectArtilleryData::setStartTime ( int  ) [virtual]

Set and return the time the first salvo will arrive.

virtual int DtIfIndirectArtilleryData::startTime ( ) const [virtual]

Set and return the time the first salvo will arrive.

virtual void DtIfIndirectArtilleryData::setTimeBetweenSalvos ( int  ) [virtual]

Set and return the time between salvos.

virtual int DtIfIndirectArtilleryData::timeBetweenSalvos ( ) const [virtual]

Set and return the time between salvos.

virtual void DtIfIndirectArtilleryData::setScatterTime ( double  ) [virtual]

Set and return the time over which an individual salvo will arrive.

virtual double DtIfIndirectArtilleryData::scatterTime ( ) const [virtual]

Set and return the time over which an individual salvo will arrive.

virtual void DtIfIndirectArtilleryData::setNumberOfSalvos ( int  ) [virtual]

Set and return the number of salvos to deliver.

virtual int DtIfIndirectArtilleryData::numberOfSalvos ( ) const [virtual]

Set and return the number of salvos to deliver.

virtual void DtIfIndirectArtilleryData::setRoundsPerSalvo ( int  ) [virtual]

Set and return the number of rounds per salvo.

virtual int DtIfIndirectArtilleryData::roundsPerSalvo ( ) const [virtual]

Set and return the number of rounds per salvo.

virtual void DtIfIndirectArtilleryData::setAltitudeAboveTerrain ( double  ) [virtual]

Set and return the altitude above the terrain (in meters) to detonate the salvo.

virtual double DtIfIndirectArtilleryData::altitudeAboveTerrain ( ) const [virtual]

Set and return the altitude above the terrain (in meters) to detonate the salvo.

virtual void DtIfIndirectArtilleryData::setWindDirection ( double  ) [virtual]

Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.

virtual double DtIfIndirectArtilleryData::windDirection ( ) const [virtual]

Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.

virtual void DtIfIndirectArtilleryData::setWindDistance ( int  ) [virtual]

Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.

virtual int DtIfIndirectArtilleryData::windDistance ( ) const [virtual]

Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.

virtual void DtIfIndirectArtilleryData::setMunitionType ( const DtEntityType &  ) [virtual]

Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.

virtual void DtIfIndirectArtilleryData::setMunitionType ( const DtString ) [virtual]

Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.

virtual const DtEntityType& DtIfIndirectArtilleryData::munitionType ( ) const [virtual]

Set and return the direction of the windage offset. The direction from indicated centroid to impact centroid.

virtual size_t DtIfIndirectArtilleryData::size ( ) const [virtual]

Encode/decode to a buffer.

virtual char* DtIfIndirectArtilleryData::encode ( char *  buffer) const [virtual]

Encode/decode to a buffer.

virtual const char* DtIfIndirectArtilleryData::decode ( const char *  buffer) [virtual]

Encode/decode to a buffer.

References DtModifyOverlayColor.

References DtModifyOverlayParent.


Member Data Documentation

DtEntityIdentifier DtIfIndirectArtilleryData::myObjectIdentifier [protected]
DtForceType DtIfIndirectArtilleryData::myForceType [protected]
DtAppearance DtIfIndirectArtilleryData::myAppearance [protected]
const char* DtIfIndirectArtilleryData::myUserData [protected]

The documentation for this class was generated from the following file:

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)