API documentation
IdealCoil Class Reference
Prototype of an ideal coil. More...
#include <IdealCoil.h>
Inheritance diagram for IdealCoil:
Collaboration diagram for IdealCoil:Public Member Functions | |
| IdealCoil () | |
| Default constructor. | |
| ~IdealCoil () | |
| Default destructor. | |
| virtual IdealCoil * | Clone () const |
| Clone an ideal coil. | |
| virtual double | GetSensitivity (double *position) |
| Get sensitivity. | |
Detailed Description
Prototype of an ideal coil.
Definition at line 32 of file IdealCoil.h.
Constructor & Destructor Documentation
| IdealCoil::~IdealCoil | ( | ) | [inline] |
Member Function Documentation
| virtual IdealCoil* IdealCoil::Clone | ( | ) | const [inline, virtual] |
Clone an ideal coil.
- Returns:
- Cloned ideal coil
Implements Coil.
Definition at line 53 of file IdealCoil.h.
References IdealCoil().
Here is the call graph for this function:| virtual double IdealCoil::GetSensitivity | ( | double * | position | ) | [inline, virtual] |
Get sensitivity.
- Parameters:
-
position Spin position.
- Returns:
- Ideal coil delivers 1.0 at every point.
Implements Coil.
Definition at line 61 of file IdealCoil.h.
The documentation for this class was generated from the following file:



