Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@andiwand
andiwand committed Nov 25, 2024
1 parent 41ed6d4 commit 2468cf5
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 22 deletions.
16 changes: 12 additions & 4 deletions Core/include/Acts/Navigation/DetectorNavigator.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,9 @@ class DetectorNavigator {

void initialize(State& state, const Vector3& position,
const Vector3& direction,
Direction /*propagationDirection*/) const {
Direction propagationDirection) const {
(void)propagationDirection;

ACTS_VERBOSE(volInfo(state) << posInfo(state, position) << "initialize");

if (state.currentDetector == nullptr) {
Expand Down Expand Up @@ -189,14 +191,20 @@ class DetectorNavigator {
candidate.boundaryTolerance);
}

bool checkTargetValid(const State& /*state*/, const Vector3& /*position*/,
const Vector3& /*direction*/) const {
bool checkTargetValid(const State& state, const Vector3& position,
const Vector3& direction) const {
(void)state;
(void)position;
(void)direction;

return true;
}

void handleSurfaceReached(State& state, const Vector3& position,
const Vector3& direction,
const Surface& /*surface*/) const {
const Surface& surface) const {
(void)surface;

ACTS_VERBOSE(volInfo(state) << posInfo(state, position)
<< "Entering navigator::handleSurfaceReached.");

Expand Down
25 changes: 18 additions & 7 deletions Core/include/Acts/Propagator/DirectNavigator.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,12 @@ class DirectNavigator {
/// @param position The start position
/// @param direction The start direction
/// @param propagationDirection The propagation direction
void initialize(State& state, const Vector3& /*position*/,
const Vector3& /*direction*/,
void initialize(State& state, const Vector3& position,
const Vector3& direction,
Direction propagationDirection) const {
(void)position;
(void)direction;

ACTS_VERBOSE("Initialize. Surface sequence for navigation:");
for (const Surface* surface : state.options.surfaces) {
ACTS_VERBOSE(surface->geometryId()
Expand Down Expand Up @@ -267,8 +270,12 @@ class DirectNavigator {
/// @param direction The current direction
///
/// @return True if the target is valid
bool checkTargetValid(const State& /*state*/, const Vector3& /*position*/,
const Vector3& /*direction*/) const {
bool checkTargetValid(const State& state, const Vector3& position,
const Vector3& direction) const {
(void)state;
(void)position;
(void)direction;

return true;
}

Expand All @@ -281,9 +288,13 @@ class DirectNavigator {
/// @param position The current position
/// @param direction The current direction
/// @param surface The surface reached
void handleSurfaceReached(State& state, const Vector3& /*position*/,
const Vector3& /*direction*/,
const Surface& /*surface*/) const {
void handleSurfaceReached(State& state, const Vector3& position,
const Vector3& direction,
const Surface& surface) const {
(void)position;
(void)direction;
(void)surface;

if (state.navigationBreak) {
return;
}
Expand Down
12 changes: 9 additions & 3 deletions Core/include/Acts/Propagator/Navigator.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,9 @@ class Navigator {
/// @param propagationDirection The propagation direction
void initialize(State& state, const Vector3& position,
const Vector3& direction,
Direction /*propagationDirection*/) const {
Direction propagationDirection) const {
(void)propagationDirection;

ACTS_VERBOSE(volInfo(state) << "Initialization.");

// Fast Navigation initialization for start condition:
Expand Down Expand Up @@ -467,8 +469,12 @@ class Navigator {
/// @param direction The current direction
///
/// @return True if the target is valid
bool checkTargetValid(const State& /*state*/, const Vector3& /*position*/,
const Vector3& /*direction*/) const {
bool checkTargetValid(const State& state, const Vector3& position,
const Vector3& direction) const {
(void)state;
(void)position;
(void)direction;

return true;
}

Expand Down
25 changes: 17 additions & 8 deletions Core/include/Acts/Propagator/TryAllNavigator.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,9 @@ class TryAllNavigatorBase {
/// @param propagationDirection The propagation direction
void initialize(State& state, const Vector3& position,
const Vector3& direction,
Direction /*propagationDirection*/) const {
Direction propagationDirection) const {
(void)propagationDirection;

ACTS_VERBOSE("initialize");

const TrackingVolume* startVolume = nullptr;
Expand Down Expand Up @@ -416,8 +418,12 @@ class TryAllNavigator : public TryAllNavigatorBase {
/// @param direction The current direction
///
/// @return True if the target is still valid
bool checkTargetValid(const State& /*state*/, const Vector3& /*position*/,
const Vector3& /*direction*/) const {
bool checkTargetValid(const State& state, const Vector3& position,
const Vector3& direction) const {
(void)state;
(void)position;
(void)direction;

return false;
}

Expand All @@ -429,7 +435,6 @@ class TryAllNavigator : public TryAllNavigatorBase {
/// @param state The navigation state
/// @param position The current position
/// @param direction The current direction
/// @param surface The reached surface
void handleSurfaceReached(State& state, const Vector3& position,
const Vector3& direction,
const Surface& /*surface*/) const {
Expand Down Expand Up @@ -622,7 +627,9 @@ class TryAllOverstepNavigator : public TryAllNavigatorBase {
///
/// @return The next target surface
NavigationTarget estimateNextTarget(State& state, const Vector3& position,
const Vector3& /*direction*/) const {
const Vector3& direction) const {
(void)direction;

if (state.navigationBreak) {
return NavigationTarget::invalid();
}
Expand Down Expand Up @@ -717,8 +724,11 @@ class TryAllOverstepNavigator : public TryAllNavigatorBase {
/// @param direction The current direction
///
/// @return True if the target is still valid
bool checkTargetValid(const State& state, const Vector3& /*position*/,
const Vector3& /*direction*/) const {
bool checkTargetValid(const State& state, const Vector3& position,
const Vector3& direction) const {
(void)position;
(void)direction;

return state.activeCandidateIndex != state.activeCandidates.size();
}

Expand All @@ -730,7 +740,6 @@ class TryAllOverstepNavigator : public TryAllNavigatorBase {
/// @param state The navigation state
/// @param position The current position
/// @param direction The current direction
/// @param surface The reached surface
void handleSurfaceReached(State& state, const Vector3& position,
const Vector3& direction,
const Surface& /*surface*/) const {
Expand Down

0 comments on commit 2468cf5

Please sign in to comment.