Helios++
Helios software for LiDAR simulations
TimedPulse Class Reference

Class representing a time aware laser pulse. More...

#include <TimedPulse.h>

Inheritance diagram for TimedPulse:
Collaboration diagram for TimedPulse:

Public Member Functions

 TimedPulse (glm::dvec3 const &origin, Rotation const &attitude, double const time_ns)
 Time laser pulse constructor. More...
 
double getTime () const
 Obtain the start time of the pulse (in nanoseconds) More...
 
void setTime (double const time_ns)
 Set the start time of the pulse. More...
 
- Public Member Functions inherited from Pulse
 Pulse (glm::dvec3 const &origin, Rotation const &attitude)
 Laser pulse constructor. More...
 
glm::dvec3 getOrigin () const
 Obtain the origin of the pulse. More...
 
glm::dvec3 & getOriginRef ()
 Obtain the origin of the pulse by reference. More...
 
void setOrigin (glm::dvec3 const &origin)
 Set the origin of the pulse. More...
 
Rotation getAttitude () const
 Obtain the attitude of the ray. More...
 
RotationgetAttitudeRef ()
 Obtain the attitude of the ray by reference. More...
 
void setAttitude (Rotation const &attitude)
 Set the attitude of the ray. More...
 
glm::dvec3 computeDirection ()
 Compute the director vector of the ray/beam. More...
 

Protected Attributes

double time_ns
 The start time of the pulse (in nanoseconds). Typically in real world applications it is the GPS time.
 
- Protected Attributes inherited from Pulse
glm::dvec3 origin
 The origin of the pulse, typically named as the point \(o\).
 
Rotation attitude
 The attitude of the ray.
 

Detailed Description

Class representing a time aware laser pulse.

Author
Alberto M. Esmoris Pena
Version
1.0

Constructor & Destructor Documentation

◆ TimedPulse()

TimedPulse::TimedPulse ( glm::dvec3 const &  origin,
Rotation const &  attitude,
double const  time_ns 
)
inline

Time laser pulse constructor.

See also
Pulse
Pulse::origin
Pulse::attitude
TimedPulse::time_ns

Member Function Documentation

◆ getTime()

double TimedPulse::getTime ( ) const
inline

Obtain the start time of the pulse (in nanoseconds)

Returns
The start time of the pulse (in nanoseconds)
See also
TimedPulse::time_ns

◆ setTime()

void TimedPulse::setTime ( double const  time_ns)
inline

Set the start time of the pulse.

Parameters
time_nsThe new start time for the pulse (in nanoseconds)
See also
TimedPulse::time_ns

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