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

Go to the documentation of this file.
00001 /*******************************************************************************
00002 ** Copyright (c) 2009 MAK Technologies, Inc.
00003 ** All rights reserved.
00004 *******************************************************************************/
00005 /*******************************************************************************
00006 ** $RCSfile: globalEnvironmentActuatorDescriptor.h,v $ $Revision: 1.1 $ $State: Exp $
00007 *******************************************************************************/
00008 
00011 
00013 
00014 #ifndef globalEnvironmentActuatorDescriptor_h
00015 #define globalEnvironmentActuatorDescriptor_h
00016 
00017 #include "vrfobjparam/actCompDesc.h"
00018 #include "vrfutil/rwReal.h"
00019 #include "vrfobjparam/vrfobjparamDefines.h"
00020 
00023 class DT_DLL_vrfobjparam DtGlobalEnvironmentActuatorDescriptor : public DtActuatorComponentDescriptor
00024 {
00025 public:
00027    DtGlobalEnvironmentActuatorDescriptor(const DtString& componentName, 
00028       DtReaderWriterRegistry* parentRegistry = 0);
00029 
00031    DtGlobalEnvironmentActuatorDescriptor(const DtGlobalEnvironmentActuatorDescriptor& orig,
00032       DtReaderWriterRegistry* parentRegistry = 0);
00033 
00034    virtual ~DtGlobalEnvironmentActuatorDescriptor();
00035 
00037    DtGlobalEnvironmentActuatorDescriptor & operator=(
00038       const DtGlobalEnvironmentActuatorDescriptor & orig);
00039 
00042    virtual DtString type() const;
00043 
00044    virtual DtComponentDescriptor* clone(
00045       DtReaderWriterRegistry* parentRegistry = 0) const;
00046 
00048    static DtComponentDescriptor* creator();
00049 
00051 
00052    virtual void setSunriseTime(double value);
00053    virtual double sunriseTime() const;
00055 
00057 
00058    virtual void setSunsetTime(double value);
00059    virtual double sunsetTime() const;
00061 
00063 
00064    virtual void setDaylightIllumination(double value);
00065    virtual double daylightIllumination() const;
00067 
00069 
00070    virtual void setNightIllumination(double value);
00071    virtual double nightIllumination() const;
00073 
00075 
00076    virtual void setDayNightTransitionTime(double value);
00077    virtual double dayNightTransitionTime() const;
00079 
00083 
00084    virtual double sunriseStartTime() const;
00085    virtual double sunriseEndTime() const;
00087 
00088 
00089 
00090 
00091    virtual double sunsetStartTime() const;
00092    virtual double sunsetEndTime() const;
00094    
00095 protected:
00097    DtGlobalEnvironmentActuatorDescriptor();
00098 
00099 protected:
00103 
00109    DtRwReal mySunriseTime;   
00115    DtRwReal mySunsetTime;
00116 
00122    DtRwReal myDaylightIllumination;
00123 
00129    DtRwReal myNightIllumination;
00130 
00139    DtRwReal myDayNightTransitionTime;
00141 };     
00142 
00143 #endif