WSF
WsfPathList::PauseSegment Class Reference

#include <WsfPathList.hpp>

Inheritance diagram for WsfPathList::PauseSegment:
Collaboration diagram for WsfPathList::PauseSegment:

Public Member Functions

SegmentClone () const override
 Returns a copy of the segment.
void ComputeState (double aRelativeSimTime, WsfPathState &aState) override
void Print (ut::log::MessageStream &aStream) override
 Appends data as notes to aStream.
Public Member Functions inherited from WsfPathList::Segment
 Segment ()
virtual ~Segment ()=default
void Initialize (double aDuration, const WsfPathState &aState)
 Initialize the basic members of the segment.
void SetRollRate (double aRollRate)
const WsfPathStateGetInitialState () const
 Returns the state at the start of the segment.
double GetDuration () const
 Returns the length of time to complete this segment.
void SetDuration (double aDuration)
 Sets the length of time to complete this segment.

Additional Inherited Members

Public Attributes inherited from WsfPathList::Segment
WsfPathState mInitialState
 The initial state of the segment. This should be equivalent to ComputeState(0.0).
double mDuration
 The length of simulation time this duration takes to complete.
double mRollRate
 The roll rate used when changing roll angle.
bool mIsApproximation
 Indicates this segment is an approximation.

Detailed Description

Represents a length of time where the entity is not moving. Duration may be zero to designate a new position.

Member Function Documentation

◆ Clone()

Segment * WsfPathList::PauseSegment::Clone ( ) const
inlineoverridevirtual

Returns a copy of the segment.

Implements WsfPathList::Segment.

References WsfPathList::Segment::Segment().

◆ ComputeState()

void WsfPathList::PauseSegment::ComputeState ( double aRelativeSimTime,
WsfPathState & aState )
inlineoverridevirtual

Computes a state along this segment

Parameters
aRelativeSimTimeThe length of simulation-time after the segment started
aStateThe state at aRelativeSimTime along this segment

Implements WsfPathList::Segment.

References WsfPathList::Segment::mInitialState.

◆ Print()

void WsfPathList::PauseSegment::Print ( ut::log::MessageStream & aStream)
overridevirtual

Appends data as notes to aStream.

Reimplemented from WsfPathList::Segment.

References WsfPathList::Segment::Print().


The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved