Marine systems simulation
Loading...
Searching...
No Matches
Ship::ThrusterCurrentField Class Reference
+ Inheritance diagram for Ship::ThrusterCurrentField:
+ Collaboration diagram for Ship::ThrusterCurrentField:

Public Member Functions

void setThruster (Thruster *thruster)
 
virtual marenv::Status GetCurrent (double time, const double position[3], double currentVelocity[3])
 
- Public Member Functions inherited from marenv::current::CurrentField
virtual ~CurrentField ()=default
 Virtual destructor.
 

Member Function Documentation

◆ GetCurrent()

virtual marenv::Status Ship::ThrusterCurrentField::GetCurrent ( double  time,
const double  position[3],
double  currentVelocity[3] 
)
virtual

Return the ocean current velocity in a given position and time.

Parameters
[in]timeTime stamp in simulation time.
[in]positionThe position to query for.
[out]currentVelocityThe velocity of the ocean current in the given time and position.
Returns
marenv::Status::OK on success. See marenv::Status for other values.

Implements marenv::current::CurrentField.


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