Base class (vish scale) for time-dependent objects Synopsis: Derive the VObject from this base class to get a time parameter that is consistent with other usages.
More...
#include </home/werner/origo/vish/ocean/shrimp/TimeDependent.hpp>
List of all members.
Public Member Functions
- double adjustTimeRange (const RefPtr< ValuePool > &Context, TypedSlot< double > &TimeLength) const
- Set the min/max range of the specified slot to the maxium of the current time range, so the slot can be used to select any value between zero and the maximally allowed time range.
-
double getMaxTime () const
-
double getMinTime () const
-
double getTime (const RefPtr< ValuePool > &VP) const
- Get the time value for the current selection from the value pool.
-
double getTimeIncrement () const
-
const TypedSlot< VTime > & getTimeSlot () const
- Get the time slot stored here, which may well be useful to inspect properties of this timeslot.
-
void setMaxTime (double T)
-
void setMinTime (double T)
-
void setTimeIncrement (double T)
-
void setupTime (const VObject::CreationSlots_t &CreationSlots)
-
TimeDependent (VObject *what, const char *timename="time", const char *timescalename="timescale")
- Constructor.
-
~TimeDependent ()
- Destructor.
Protected Attributes
Detailed Description
Base class (vish scale) for time-dependent objects Synopsis: Derive the VObject from this base class to get a time parameter that is consistent with other usages.
Member Function Documentation
| double Wizt::TimeDependent::adjustTimeRange |
( |
const RefPtr< ValuePool > & |
Context, |
|
|
TypedSlot< double > & |
TimeLength |
|
) |
| const |
Set the min/max range of the specified slot to the maxium of the current time range, so the slot can be used to select any value between zero and the maximally allowed time range.
This is quite a specific convenience function, will not be very common in application code.
- Returns:
- Provides the current value of the respective slot.
The documentation for this class was generated from the following files:
- ocean/shrimp/TimeDependent.hpp
- ocean/shrimp/TimeDependent.cpp
