msl::Synchronization Class Reference

Detailed Description

Run a synchronization event.

#include <Synchronization.h>

Public Member Functions
	Synchronization ()
	Synchronization (Synchronization const &)=default
	Synchronization (Synchronization &&)=default
Synchronization &	operator= (Synchronization const &)=default
Synchronization &	operator= (Synchronization &&)=default
virtual	~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 ()
	RealTimeEvents (RealTimeEvents const &)=default
	RealTimeEvents (RealTimeEvents &&)=default
RealTimeEvents &	operator= (RealTimeEvents const &)=default
RealTimeEvents &	operator= (RealTimeEvents &&)=default
virtual	~RealTimeEvents ()=default
sSLICE_POS const &	slice () const
	Return the slice used in prepare and run.
virtual RealTimeEvents &	setSlice (sSLICE_POS const &slice)
	Set the slice used in prepare and run.

Constructor & Destructor Documentation

Synchronization() [1/3]

msl::Synchronization::Synchronization

(

)

Synchronization() [2/3]

msl::Synchronization::Synchronization ( Synchronization const &  )

default

Synchronization() [3/3]

msl::Synchronization::Synchronization ( Synchronization &&  )

default

~Synchronization()

virtual msl::Synchronization::~Synchronization ( )

virtualdefault

Member Function Documentation

operator=() [1/2]

Synchronization & msl::Synchronization::operator= ( Synchronization const &  )

default

operator=() [2/2]

Synchronization & msl::Synchronization::operator= ( Synchronization &&  )

default

event()

eSYNCCODE msl::Synchronization::event

(

)

const

Return the code of the synchronization event.

setEvent()

Synchronization & msl::Synchronization::setEvent

(

eSYNCCODE

event

)

Set the code of the synchronization event.

duration()

long msl::Synchronization::duration

(

)

Return the duration of the synchronization event (µs)

setDuration()

Synchronization & msl::Synchronization::setDuration

(

long

duration

)

Set the duration of the synchronization event (µs)

startTime()

long msl::Synchronization::startTime ( ) const

overridevirtual

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

Implements msl::RealTimeEvents.

setStartTime()

Synchronization & msl::Synchronization::setStartTime

(

long

startTime

)

Set the start time of the synchronization event (µs)

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:

• msl/Synchronization.h