API documentation
TxRxPhase Class Reference
Phase physics super class. More...
#include <TxRxPhase.h>
Inheritance diagram for TxRxPhase:
Public Member Functions | |
| TxRxPhase () | |
| Constructor. | |
| virtual | ~TxRxPhase () |
| Default destructor. | |
| void | SetInitialPhase (double val) |
| Get phase of this pulse. | |
| bool | GetPhaseLock () |
| Get phase lock of this pulse. | |
| void | SetPhaseLock (bool bval) |
| Set phase lock of this pulse. | |
| double | GetInitialPhase () |
| Get initial phase of this pulse. | |
| double | GetFrequency () |
| Get constant frequency for linear phase terms. | |
| void | SetFrequency (double val) |
| Set constant frequency for linear phase terms. | |
Static Public Member Functions | |
| static double | getLinearPhase (Module *mod, double time) |
| A general purpose linear additive phase term. | |
Protected Attributes | |
| double | m_initial_phase |
| Initial Phase of this phase event. | |
| bool | m_phase_lock |
| Phase lock of this phase event. | |
| double | m_frequency |
| A constant frequency to set linear phase terms. | |
Detailed Description
Phase physics super class.
Definition at line 33 of file TxRxPhase.h.
Member Function Documentation
| double TxRxPhase::GetFrequency | ( | ) | [inline] |
Get constant frequency for linear phase terms.
- Returns:
- The frequency of the puls.
Definition at line 82 of file TxRxPhase.h.
References m_frequency.
Referenced by getLinearPhase().
Here is the caller graph for this function:
| double TxRxPhase::getLinearPhase | ( | Module * | mod, | |
| double | time | |||
| ) | [static] |
A general purpose linear additive phase term.
Rx case: A pointer to this function can be added to the list RFPulse::m_GetPhaseFunPtrs .
- Parameters:
-
time The time at which the phase is requested. mod A pointer to a Module.
- Returns:
- The linear phase term.
Definition at line 37 of file TxRxPhase.cpp.
References GetFrequency().
Referenced by RFPulse::Prepare().
Here is the call graph for this function:
Here is the caller graph for this function:
| void TxRxPhase::SetFrequency | ( | double | val | ) | [inline] |
Set constant frequency for linear phase terms.
- Parameters:
-
val The new frequency of the puls.
Definition at line 89 of file TxRxPhase.h.
References m_frequency.
Referenced by TxRxPhase().
Here is the caller graph for this function:
| void TxRxPhase::SetInitialPhase | ( | double | val | ) | [inline] |
Get phase of this pulse.
Set phase of this pulse.
- Parameters:
-
val The phase as double.
Definition at line 57 of file TxRxPhase.h.
References m_initial_phase.
Referenced by TxRxPhase().
Here is the caller graph for this function:
| void TxRxPhase::SetPhaseLock | ( | bool | bval | ) | [inline] |
Set phase lock of this pulse.
- Parameters:
-
bval Set phase lock {true|false}.
Definition at line 69 of file TxRxPhase.h.
References m_phase_lock.
The documentation for this class was generated from the following files:
