Mantid
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Mantid::Geometry::Link Struct Reference

For a leg of a track. More...

#include <Track.h>

Public Member Functions

 Link (const Kernel::V3D &entry, const Kernel::V3D &exit, const double totalDistance, const IObject &obj, const ComponentID compID=nullptr)
 Constuctor. More...
 
bool operator< (const double &other) const
 Less than operator. More...
 
bool operator< (const Link &other) const
 Less than operator. More...
 
bool operator== (const Link &other) const
 

Public Attributes

Attributes.
Kernel::V3D entryPoint
 Entry point. More...
 
Kernel::V3D exitPoint
 Exit point. More...
 
double distFromStart
 Total distance from track beginning. More...
 
double distInsideObject
 Total distance covered inside object. More...
 
const IObjectobject
 The object that was intersected. More...
 
ComponentID componentID
 ComponentID of the intersected component. More...
 

Detailed Description

For a leg of a track.

Author
S. Ansell
M. Gigg, Tessella plc

Definition at line 39 of file Track.h.

Constructor & Destructor Documentation

◆ Link()

Mantid::Geometry::Link::Link ( const Kernel::V3D entry,
const Kernel::V3D exit,
const double  totalDistance,
const IObject obj,
const ComponentID  compID = nullptr 
)
inline

Constuctor.

Parameters
entry:: Kernel::V3D point to start
exit:: Kernel::V3D point to end track
totalDistance:: Total distance from start of track
obj:: A reference to the object that was intersected
compID:: An optional component identifier for the physical object hit. (Default=NULL)

Definition at line 49 of file Track.h.

Member Function Documentation

◆ operator<() [1/2]

bool Mantid::Geometry::Link::operator< ( const double &  other) const
inline

Less than operator.

Definition at line 56 of file Track.h.

◆ operator<() [2/2]

bool Mantid::Geometry::Link::operator< ( const Link other) const
inline

Less than operator.

Definition at line 54 of file Track.h.

◆ operator==()

bool Mantid::Geometry::Link::operator== ( const Link other) const
inline

Definition at line 58 of file Track.h.

References tolerance.

Member Data Documentation

◆ componentID

ComponentID Mantid::Geometry::Link::componentID

ComponentID of the intersected component.

Definition at line 85 of file Track.h.

◆ distFromStart

double Mantid::Geometry::Link::distFromStart

Total distance from track beginning.

Definition at line 82 of file Track.h.

◆ distInsideObject

double Mantid::Geometry::Link::distInsideObject

Total distance covered inside object.

Definition at line 83 of file Track.h.

◆ entryPoint

Kernel::V3D Mantid::Geometry::Link::entryPoint

Entry point.

Definition at line 80 of file Track.h.

◆ exitPoint

Kernel::V3D Mantid::Geometry::Link::exitPoint

Exit point.

Definition at line 81 of file Track.h.

◆ object

const IObject* Mantid::Geometry::Link::object

The object that was intersected.

Definition at line 84 of file Track.h.


The documentation for this struct was generated from the following file: