TimeVaryingVolumetricGrid< T, V, S, P > Class Template Reference
A grid with interpolation where time can be varied. This class has no implementation to allow for different strategies. More...
#include <TimeVaryingVolumetricGrid.hh>
Public Member Functions | |
| std::pair< Vector3< V >, Vector3< V > > | Bounds (const S &_session) const |
| Get the spatial bounds of this grid field at given time. More... | |
| S | CreateSession () const |
| Creates a session. Call this before querying the interface. More... | |
| S | CreateSession (const T &_time) const |
| Creates a session at a given time. Call this before querying the interface. More... | |
| bool | IsValid (const S &_session) const |
| Returns true if a session is valid. False if invalid,. More... | |
| std::optional< V > | LookUp (const S &_session, const Vector3< P > &_pos) const |
| Looks up a value at a given point in time. More... | |
| std::optional< S > | StepTo (const S &_session, const T &_time) const |
| Steps the session to a fixed time step. More... | |
Detailed Description
template<typename T, typename V, typename S, typename P>
class gz::math::TimeVaryingVolumetricGrid< T, V, S, P >
A grid with interpolation where time can be varied. This class has no implementation to allow for different strategies.
- See also
- InMemoryTimeVaryingVolumetricGrid for an example specialization that loads all data into memory. To use this class you should use
CreateSessionso you can step through time.
Member Function Documentation
◆ Bounds()
Get the spatial bounds of this grid field at given time.
- Returns
- A pair of vectors. All zeros if session is invalid.
◆ CreateSession() [1/2]
| S CreateSession | ( | ) | const |
Creates a session. Call this before querying the interface.
◆ CreateSession() [2/2]
| S CreateSession | ( | const T & | _time | ) | const |
Creates a session at a given time. Call this before querying the interface.
- Parameters
-
[in] _time - The time at which to create the session.
◆ IsValid()
| bool IsValid | ( | const S & | _session | ) | const |
Returns true if a session is valid. False if invalid,.
◆ LookUp()
| std::optional<V> LookUp | ( | const S & | _session, |
| const Vector3< P > & | _pos | ||
| ) | const |
Looks up a value at a given point in time.
- Parameters
-
[in] _session - The session with the time stamp to be looked up. [in] _pos - The position of the point we want to query
◆ StepTo()
| std::optional<S> StepTo | ( | const S & | _session, |
| const T & | _time | ||
| ) | const |
Steps the session to a fixed time step.
- Parameters
-
[in] _session - The session to be stepped [in] _time - The time at which the session should be set.
- Returns
- the session cursor if the step was successful. If there was no more data return nullopt.
The documentation for this class was generated from the following file: