msl 1.3.0
Loading...
Searching...
No Matches
msl::Synchronization Class Reference

Detailed Description

Run a synchronization event.

#include <Synchronization.h>

Public Member Functions

 Synchronization (Synchronization const &)=default
 Synchronization (Synchronization &&)=default
Synchronization & operator= (Synchronization const &)=default
Synchronization & operator= (Synchronization &&)=default
eSYNCCODE event () const
 Return the code of the synchronization event.
Synchronization & setEvent (eSYNCCODE event)
 Set the code of the synchronization event.
long duration ()
 Return the duration of the synchronization event (µs).
Synchronization & setDuration (long duration)
 Set the duration of the synchronization event (µs).
long startTime () const override
 Return the start time of the synchronization event (µs).
Synchronization & setStartTime (long startTime)
 Set the start time of the synchronization event (µs).
long endTime () const override
 Return the end time of the synchronization event (µs).
NLSStatus prepare (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
 Prepare the synchronization event.
NLSStatus run (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
 Run the synchronization event.
MrProtocolData::SeqExpoRFInfo rfInfo () const override
 Return the RF information for SAR computation.
Public Member Functions inherited from msl::RealTimeEvents
 RealTimeEvents ()
 No-op constructor.
 RealTimeEvents (RealTimeEvents const &)=default
 RealTimeEvents (RealTimeEvents &&)=default
RealTimeEventsoperator= (RealTimeEvents const &)=default
RealTimeEventsoperator= (RealTimeEvents &&)=default
sSLICE_POS const & slice () const
 Return the slice used in prepare and run.
virtual RealTimeEventssetSlice (sSLICE_POS const &slice)
 Set the slice used in prepare and run.

Additional Inherited Members

Protected Attributes inherited from msl::RealTimeEvents
sSLICE_POS _slice
 Slice specifications attached to this real time object.

Member Function Documentation

◆ startTime()

long msl::Synchronization::startTime ( ) const
overridevirtual

Return the start time of the synchronization event (µs).

Implements msl::RealTimeEvents.

◆ endTime()

long msl::Synchronization::endTime ( ) const
overridevirtual

Return the end time of the synchronization event (µs).

Implements msl::RealTimeEvents.

◆ prepare()

NLSStatus msl::Synchronization::prepare ( MrProt & protocol,
SeqLim & limits,
SeqExpo & exports )
overridevirtual

Prepare the synchronization event.

Implements msl::RealTimeEvents.

◆ run()

NLSStatus msl::Synchronization::run ( MrProt & protocol,
SeqLim & limits,
SeqExpo & exports )
overridevirtual

Run the synchronization event.

Implements msl::RealTimeEvents.

◆ rfInfo()

MrProtocolData::SeqExpoRFInfo msl::Synchronization::rfInfo ( ) const
overridevirtual

Return the RF information for SAR computation.

Implements msl::RealTimeEvents.


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