Trk::ExtrapolationCode Class Reference

#include <ExtrapolationCell.h>

Collaboration diagram for Trk::ExtrapolationCode:

Public Types
enum	eCode {   Unset = 0 , InProgress = 1 , SuccessDestination = 2 , SuccessBoundaryReached ,   SuccessPathLimit , SuccessMaterialLimit , Recovered = 6 , FailureDestination = 7 ,   FailureLoop = 8 , FailureNavigation = 9 , FailureUpdateKill = 10 , FailureConfiguration = 11 ,   LeftKnownWorld = 12 }

Public Member Functions
	ExtrapolationCode (eCode c)
ExtrapolationCode &	operator= (const eCode &ec)
	assigment operator - because we can
bool	operator== (const eCode &ec) const
	== operator to eCode
bool	operator!= (const eCode &ec) const
	!= operator to eCode
bool	inProgress () const
	return inProgress
bool	isSuccess () const
	return success
bool	isSuccessBeforeDestination () const
	return sucess other than destination reached
bool	isSuccessOrRecovered () const
	return success or recovered
bool	isFailure () const
	return failure
bool	isFailureOrRecovered () const
	return failure or recovered
const std::string &	toString () const
	toString

Public Attributes
eCode	code
	the actual code

Static Private Attributes
static const std::vector< std::string >	s_ecodeNames

Detailed Description

Author

Andreas.Salzburger -at- cern.ch

Definition at line 104 of file ExtrapolationCell.h.

Member Enumeration Documentation

eCode

enum Trk::ExtrapolationCode::eCode

Enumerator
Unset
InProgress
SuccessDestination
SuccessBoundaryReached
SuccessPathLimit
SuccessMaterialLimit
Recovered
FailureDestination
FailureLoop
FailureNavigation
FailureUpdateKill
FailureConfiguration
LeftKnownWorld

Definition at line 108 of file ExtrapolationCell.h.

  {
    Unset = 0,              // no code set yet
    InProgress = 1,         // successful : extrapolation in process
    SuccessDestination = 2, // successful : destination reached
    SuccessBoundaryReached =
      3, // successful : boundary reached & configured to do so
    SuccessPathLimit =
      4, // successful : path limit reached & configured to do so
    SuccessMaterialLimit =
      5,           // successful : material limit reached & configured to do so
    Recovered = 6, // successful : recovered & configured to do so
    FailureDestination = 7, // failure    : could not reach destination
    FailureLoop = 8,        // failure    : loop or oscillation between volumes
    FailureNavigation = 9,  // failure    : general navigation failure
    FailureUpdateKill = 10, // failure    : updated track under threshold
    FailureConfiguration = 11, // failure    : general configuration failure
    LeftKnownWorld = 12        // successful ? failure ? if we just knew ...
  };

Constructor & Destructor Documentation

ExtrapolationCode()

Trk::ExtrapolationCode::ExtrapolationCode ( eCode c )

inline

Definition at line 132 of file ExtrapolationCell.h.

    : code(c)
  {}

Member Function Documentation

inProgress()

bool Trk::ExtrapolationCode::inProgress ( ) const

inline

return inProgress

Definition at line 150 of file ExtrapolationCell.h.

{ return (code == InProgress); }

isFailure()

bool Trk::ExtrapolationCode::isFailure ( ) const

inline

return failure

Definition at line 168 of file ExtrapolationCell.h.

{ return (code > Recovered); }

isFailureOrRecovered()

bool Trk::ExtrapolationCode::isFailureOrRecovered ( ) const

inline

return failure or recovered

Definition at line 171 of file ExtrapolationCell.h.

{ return (code > SuccessMaterialLimit); };

isSuccess()

bool Trk::ExtrapolationCode::isSuccess ( ) const

inline

return success

Definition at line 153 of file ExtrapolationCell.h.

{ return (code > InProgress && code < Recovered); }

isSuccessBeforeDestination()

bool Trk::ExtrapolationCode::isSuccessBeforeDestination ( ) const

inline

return sucess other than destination reached

Definition at line 156 of file ExtrapolationCell.h.

  {
    return (code > SuccessDestination && code < Recovered);
  }

isSuccessOrRecovered()

bool Trk::ExtrapolationCode::isSuccessOrRecovered ( ) const

inline

return success or recovered

Definition at line 162 of file ExtrapolationCell.h.

  {
    return (code > InProgress && code <= FailureDestination);
  }

operator!=()

bool Trk::ExtrapolationCode::operator!= ( const eCode & ec ) const

inline

!= operator to eCode

Definition at line 147 of file ExtrapolationCell.h.

{ return (ec != code); }

operator=()

ExtrapolationCode & Trk::ExtrapolationCode::operator= ( const eCode & ec )

inline

assigment operator - because we can

Definition at line 137 of file ExtrapolationCell.h.

  {
    code = ec;
    return (*this);
  }

operator==()

bool Trk::ExtrapolationCode::operator== ( const eCode & ec ) const

inline

== operator to eCode

Definition at line 144 of file ExtrapolationCell.h.

{ return (ec == code); }

toString()

const std::string & Trk::ExtrapolationCode::toString ( ) const

inline

toString

Definition at line 174 of file ExtrapolationCell.h.

{ return s_ecodeNames[code]; }

Member Data Documentation

code

eCode Trk::ExtrapolationCode::code

the actual code

Definition at line 129 of file ExtrapolationCell.h.

s_ecodeNames

const std::vector< std::string > Trk::ExtrapolationCode::s_ecodeNames

staticprivate

Initial value:

= {
  "Unset",
  "InProgress",
  "SuccessDestination",
  "SuccessBoundaryReached",
  "SuccessPathLimit",
  "SuccessMaterialLimit",
  "Recovered",
  "FailureDestination",
  "FailureLoop",
  "FailureNavigation",
  "FailureUpdateKill",
  "FailureConfiguration",
  "LeftKnownWorld"
}

Definition at line 11 of file ExtrapolationCell.h.

---

The documentation for this class was generated from the following files:

• ExtrapolationCell.h
• ExtrapolationCell.cxx