Struct ConstrainedStep¶
Defined in File ConstrainedStep.hpp
Struct Documentation¶
-
struct
Acts
::
ConstrainedStep
¶ A constrained step class for the steppers.
Public Types
-
enum
Type
¶ the types of constraints from accuracy - this can vary up and down given a good step estimator from actor - this would be a typical navigation step from aborter - this would be a target condition from user - this is user given for what reason ever
Values:
-
enumerator
accuracy
= 0¶
-
enumerator
actor
= 1¶
-
enumerator
aborter
= 2¶
-
enumerator
user
= 3¶
-
enumerator
Public Functions
-
ConstrainedStep
(double value)¶ constructor from double value is the user given initial value
-
double
max
() const¶ Return the maximum step constraint.
- Return
The max step constraint
-
double
min
() const¶ Return the minimum step constraint.
- Return
The min step constraint
-
operator double
() const¶ Cast operator to double, returning the min/max value depending on the direction.
-
ConstrainedStep &
operator=
(const double &value)¶ The assignment operator from one double.
- Note
this will set only the accuracy, as this is the most exposed to the Propagator, this adapts also the direction
- Parameters
value
: is the new accuracy value
-
void
release
(Type type)¶ release a certain constraint value to the (signed) biggest value available, hence it depends on the direction
- Parameters
type
: is the constraint type to be released
-
std::string
toString
() const¶ return the split value as string for debugging
Public Members
-
NavigationDirection
direction
= forward¶ The Navigation direction.
-
std::array<double, 4>
values
= {{std::numeric_limits<double>::max(), std::numeric_limits<double>::max(), std::numeric_limits<double>::max(), std::numeric_limits<double>::max()}}¶ the step size tuple
-
enum