VR-Forces 4.0.4 Class Documentation: include/vrfobjparam/spotReportGeneratorDesc.h Source File

Go to the documentation of this file.
00001 /*******************************************************************************
00002 ** Copyright (c) 2005 MAK Technologies, Inc.
00003 ** All rights reserved.
00004 *******************************************************************************/
00005 /*******************************************************************************
00006 ** $RCSfile: spotReportGeneratorDesc.h,v $ $Revision: 1.10 $ $State: Exp $
00007 *******************************************************************************/
00008 
00011 
00014 
00015 #ifndef spotReportGeneratorDesc_H_
00016 #define spotReportGeneratorDesc_H_
00017 
00018 #include "vrfobjparam/compDesc.h"
00019 #include "vrfutil/rwReal.h"
00020 #include "vrfutil/rwBoolean.h"
00021 #include "vrfutil/rwObjectTypeList.h"
00022 
00025 #include "vrfobjparam/vrfobjparamDefines.h"
00026 class DT_DLL_vrfobjparam DtSpotReportGeneratorControllerDescriptor : public DtComponentDescriptor
00027 {
00028 public:
00030    DtSpotReportGeneratorControllerDescriptor(
00031       const DtString& rwName = DtString::nullString(), 
00032       DtReaderWriterRegistry*  parentRegistry = 0);
00033 
00035    DtSpotReportGeneratorControllerDescriptor(
00036       const DtSpotReportGeneratorControllerDescriptor& orig,
00037       DtReaderWriterRegistry*  parentRegistry = 0);
00038 
00040    DtSpotReportGeneratorControllerDescriptor& operator=(
00041       const DtSpotReportGeneratorControllerDescriptor& orig);
00042 
00044    virtual ~DtSpotReportGeneratorControllerDescriptor();
00045 
00047    virtual DtComponentDescriptor* clone(
00048       DtReaderWriterRegistry*  parentRegistry = 0) const;
00049 
00052    virtual DtString type() const;
00053 
00055    static DtComponentDescriptor* creator();
00056 
00059    virtual bool forwardSubordinateReports() const;
00060    virtual void setForwardSubordinateReports(const bool& newValue);
00062 
00065    virtual const DtRwObjectTypeList & objTypesToSpot() const;
00066    virtual void setObjTypesToSpot(const DtRwObjectTypeList & list);
00068 
00071    virtual bool reportOnOwnForce() const;
00072    virtual void setReportOnOwnForce(bool newVal);
00074 
00076 
00077    virtual bool reportOnHostileForces() const;
00078    virtual void setReportOnHostileForces(bool newVal);
00080 
00082 
00083    virtual bool reportOnNeutralForces() const;
00084    virtual void setReportOnNeutralForces(bool newVal);
00086 
00089    virtual double reportResendPeriod() const;
00090    virtual void setReportResendPeriod(const double& newValue);
00092 
00094 
00095    virtual DtString radioName() const;
00096    virtual void setRadioName(const DtString& name);
00098 
00100    static const DtString theDefaultRadioName;
00101 
00102 protected:
00106    
00111    DtRwBoolean myForwardSubordinateReports;
00112 
00118    DtRwReal myReportResendPeriod;
00119 
00123    DtRwObjectTypeList myObjTypesToSpot;
00124 
00129    DtRwBoolean mySendReportsOnOwnForce;
00130 
00135    DtRwBoolean mySendReportsOnHostileForces;
00136 
00142    DtRwBoolean mySendReportsOnNeutralForces;
00143 
00149    DtRwString myRadioName;
00151 };
00152 #endif