G4IT Class Reference

#include <G4IT.hh>

Inheritance diagram for G4IT:

Public Member Functions
virtual G4bool	diff (const G4IT &right) const =0
virtual G4bool	equal (const G4IT &right) const =0
	G4IT ()
	G4IT (G4Track *)
const G4ITBox *	GetITBox () const
virtual G4ITType	GetITSubType () const
virtual const G4ITType	GetITType () const =0
G4TrackListNode *	GetListNode ()
virtual const G4String &	GetName () const =0
G4IT *	GetNext ()
const G4IT *	GetNext () const
G4KDNode_Base *	GetNode () const
void	GetParentID (int &, int &)
const G4ThreeVector &	GetPosition () const
G4double	GetPreStepGlobalTime () const
G4double	GetPreStepLocalTime () const
const G4ThreeVector &	GetPreStepPosition () const
G4IT *	GetPrevious ()
const G4IT *	GetPrevious () const
G4Track *	GetTrack ()
const G4Track *	GetTrack () const
G4TrackingInformation *	GetTrackingInfo ()
const G4String &	GetType () const
G4bool	operator!= (const G4IT &right) const
G4bool	operator< (const G4IT &right) const
G4bool	operator== (const G4IT &right) const
double	operator[] (int i) const
virtual void	Print () const
void	RecordCurrentPositionNTime ()
void	SetITBox (G4ITBox *)
void	SetListNode (G4TrackListNode *node)
void	SetNext (G4IT *)
void	SetNode (G4KDNode_Base *)
void	SetParentID (int, int)
void	SetPrevious (G4IT *)
void	SetTrack (G4Track *)
void	TakeOutBox ()
virtual	~G4IT ()

Protected Member Functions
	G4IT (const G4IT &)
G4IT &	operator= (const G4IT &)

Protected Attributes
G4Track *	fpTrack
G4String *	pType = nullptr

Private Attributes
int	fParentID_A
int	fParentID_B
G4ITBox *	fpITBox
G4KDNode_Base *	fpKDNode
G4IT *	fpNextIT
G4IT *	fpPreviousIT
G4TrackingInformation *	fpTrackingInformation
G4TrackListNode *	fpTrackNode

Detailed Description

G4IT is a interface which allows the inheriting object to be tracked using G4ITStepProcessor The inheriting class must implement the operator < , == and != in order to enable the sorting out. also the concrete header of MyIT ("MyIt.hh") should contain : ITDef(MyIT) and the source of MyIT.cc : ITImp(MyIT)

Definition at line 87 of file G4IT.hh.

Constructor & Destructor Documentation

G4IT() [1/3]

G4IT::G4IT

(

)

Definition at line 67 of file G4IT.cc.

           :
    G4VUserTrackInformation("G4IT"),
    fpTrack(nullptr),
    fpPreviousIT(nullptr),
    fpNextIT(nullptr),
    fpTrackingInformation(new G4TrackingInformation())
{
  fpITBox = nullptr;
  fpKDNode = nullptr;
  fpTrackNode = nullptr;
  fParentID_A = 0;
  fParentID_B = 0;
}

References fParentID_A, fParentID_B, fpITBox, fpKDNode, and fpTrackNode.

G4IT() [2/3]

G4IT::G4IT

(

G4Track *

aTrack

)

Definition at line 124 of file G4IT.cc.

                           :
    G4VUserTrackInformation("G4IT"),
    fpPreviousIT(0),
    fpNextIT(0),
    fpTrackingInformation(new G4TrackingInformation())
{
  fpITBox = 0;
  fpTrack = aTrack;
  fpKDNode = nullptr;
  fpTrackNode = nullptr;
  fParentID_A = 0;
  fParentID_B = 0;
  RecordCurrentPositionNTime();
}

References fParentID_A, fParentID_B, fpITBox, fpKDNode, fpTrack, fpTrackNode, and RecordCurrentPositionNTime().

~G4IT()

G4IT::~G4IT ( )

virtual

Definition at line 160 of file G4IT.cc.

{
  TakeOutBox();
 
  if(fpTrackingInformation)
  {
    delete fpTrackingInformation;
    fpTrackingInformation = nullptr;
  }
 
// Note :
// G4ITTrackingManager will delete fTrackNode.
// fKDNode will be deleted when the KDTree is rebuilt
}

References fpTrackingInformation, and TakeOutBox().

G4IT() [3/3]

G4IT::G4IT ( const G4IT &  )

protected

Definition at line 82 of file G4IT.cc.

                        :
    G4VUserTrackInformation("G4IT"),
    fpTrack(nullptr),
    fpPreviousIT(nullptr),
    fpNextIT(nullptr),
    fpTrackingInformation(new G4TrackingInformation())
{
  fpITBox = nullptr;
  fpKDNode = nullptr;
  fpTrackNode = nullptr;
  fParentID_A = 0;
  fParentID_B = 0;
}

References fParentID_A, fParentID_B, fpITBox, fpKDNode, and fpTrackNode.

Member Function Documentation

diff()

virtual G4bool G4IT::diff ( const G4IT &  right ) const

pure virtual

Referenced by operator<().

equal()

virtual G4bool G4IT::equal ( const G4IT &  right ) const

pure virtual

Referenced by operator==().

GetITBox()

const G4ITBox * G4IT::GetITBox ( ) const

inline

Definition at line 183 of file G4IT.hh.

{
  return fpITBox;
}

References fpITBox.

GetITSubType()

virtual G4ITType G4IT::GetITSubType ( ) const

inlinevirtual

Reimplemented in G4Molecule.

Definition at line 159 of file G4IT.hh.

  {
    return 0;
  }

Referenced by G4ITTrackHolder::PushDelayed(), and G4ITTrackHolder::PushTo().

GetITType()

virtual const G4ITType G4IT::GetITType ( ) const

pure virtual

Referenced by operator<(), operator==(), and G4AllITFinder::Push().

GetListNode()

G4TrackListNode * G4IT::GetListNode ( )

inline

Definition at line 148 of file G4IT.hh.

  {
    return fpTrackNode;
  }

References fpTrackNode.

GetName()

virtual const G4String & G4IT::GetName ( ) const

pure virtual

Implemented in G4Molecule.

Referenced by G4ITTrackHolder::_PushTrack(), G4ITStepProcessor::ComputeInteractionLength(), G4ITModelProcessor::ComputeTrackReaction(), G4DNABrownianTransportation::Diffusion(), G4ITTrackHolder::KillTracks(), G4DNAScavengerProcess::PostStepDoIt(), G4ITSteppingVerbose::PostStepVerbose(), G4ITSteppingVerbose::PreStepVerbose(), and G4ITSteppingVerbose::TrackingStarted().

GetNext() [1/2]

G4IT * G4IT::GetNext ( )

inline

Definition at line 208 of file G4IT.hh.

{
  return fpNextIT;
}

References fpNextIT.

Referenced by G4ITBox::Extract(), G4ITBox::TransferTo(), and G4ITBox::~G4ITBox().

GetNext() [2/2]

const G4IT * G4IT::GetNext ( ) const

inline

Definition at line 245 of file G4IT.hh.

{
  return fpNextIT;
}

References fpNextIT.

GetNode()

G4KDNode_Base * G4IT::GetNode ( ) const

inline

Definition at line 255 of file G4IT.hh.

{
  return fpKDNode;
}

References fpKDNode.

GetParentID()

void G4IT::GetParentID ( int &  p_a, int &  p_b  )

inline

Definition at line 234 of file G4IT.hh.

{
  p_a = fParentID_A;
  p_b = fParentID_B;
}

References fParentID_A, and fParentID_B.

GetPosition()

const G4ThreeVector & G4IT::GetPosition

(

)

const

Definition at line 214 of file G4IT.cc.

{
  if (fpTrack) return GetTrack()->GetPosition();
  return *(new G4ThreeVector());
}

References fpTrack, G4Track::GetPosition(), and GetTrack().

GetPreStepGlobalTime()

G4double G4IT::GetPreStepGlobalTime

(

)

const

Definition at line 228 of file G4IT.cc.

{
  return fpTrackingInformation->GetPreStepGlobalTime();
}

References fpTrackingInformation, and G4TrackingInformation::GetPreStepGlobalTime().

GetPreStepLocalTime()

G4double G4IT::GetPreStepLocalTime

(

)

const

Definition at line 233 of file G4IT.cc.

{
  return fpTrackingInformation->GetPreStepLocalTime();
}

References fpTrackingInformation, and G4TrackingInformation::GetPreStepLocalTime().

GetPreStepPosition()

const G4ThreeVector & G4IT::GetPreStepPosition

(

)

const

Definition at line 238 of file G4IT.cc.

{
  return fpTrackingInformation->GetPreStepPosition();
}

References fpTrackingInformation, and G4TrackingInformation::GetPreStepPosition().

GetPrevious() [1/2]

G4IT * G4IT::GetPrevious ( )

inline

Definition at line 203 of file G4IT.hh.

{
  return fpPreviousIT;
}

References fpPreviousIT.

Referenced by G4ITBox::Extract(), and G4ITBox::FindIT().

GetPrevious() [2/2]

const G4IT * G4IT::GetPrevious ( ) const

inline

Definition at line 240 of file G4IT.hh.

{
  return fpPreviousIT;
}

References fpPreviousIT.

GetTrack() [1/2]

G4Track * G4IT::GetTrack ( )

inline

Definition at line 218 of file G4IT.hh.

{
  return fpTrack;
}

References fpTrack.

Referenced by G4DNAIRTMoleculeEncounterStepper::CheckAndRecordResults(), G4DNAMoleculeEncounterStepper::CheckAndRecordResults(), G4ITStepProcessor::FindTransportationStep(), and GetPosition().

GetTrack() [2/2]

const G4Track * G4IT::GetTrack ( ) const

inline

Definition at line 223 of file G4IT.hh.

{
  return fpTrack;
}

References fpTrack.

GetTrackingInfo()

G4TrackingInformation * G4IT::GetTrackingInfo ( )

inline

Definition at line 143 of file G4IT.hh.

  {
    return fpTrackingInformation;
  }

References fpTrackingInformation.

Referenced by G4ITTransportation::AlongStepGetPhysicalInteractionLength(), G4DNABrownianTransportation::ComputeGeomLimit(), G4ITStepProcessor::DoDefinePhysicalStepLength(), G4ITStepProcessor::DoStepping(), G4ITStepProcessor::InitDefineStep(), G4ITLeadingTracks::PrepareLeadingTracks(), G4ITLeadingTracks::Reset(), G4ITStepProcessor::SetInitialStep(), G4ITStepProcessor::SetTrack(), G4ITStepProcessor::SetupMembers(), and G4VITProcess::StartTracking().

GetType()

const G4String & G4VUserTrackInformation::GetType ( ) const

inherited

Definition at line 75 of file G4VUserTrackInformation.cc.

{
  static const G4String NOTYPE = "NONE";
  if(pType != nullptr)
    return *pType;
  else
    return NOTYPE;
}

References G4VUserTrackInformation::pType.

Referenced by G4ScintillationTrackInformation::IsScintillationTrackInformation().

operator!=()

G4bool G4IT::operator!=

(

const G4IT &

right

)

const

Definition at line 202 of file G4IT.cc.

{
  return !(this->operator==(right));
}

References operator==().

operator<()

G4bool G4IT::operator<

(

const G4IT &

right

)

const

Definition at line 180 of file G4IT.cc.

{
  if (GetITType() == right.GetITType())
  {
    return (this->diff(right));
  }
  else
  {
    return (GetITType() < right.GetITType());
  }
  return false;
}

References diff(), and GetITType().

operator=()

G4IT & G4IT::operator= ( const G4IT &  right )

protected

Definition at line 97 of file G4IT.cc.

{
  G4ExceptionDescription exceptionDescription;
  exceptionDescription
      << "The assignment operator of G4IT should not be used, "
          "this feature is not supported."
      << "If really needed, please contact the developers.";
  G4Exception("G4IT::operator=(const G4IT& right)",
              "G4IT001",
              FatalException,
              exceptionDescription);
 
  if (this == &right) return *this;
 
  fpTrack = nullptr;
  fpITBox = nullptr;
  fpPreviousIT = nullptr;
  fpNextIT = nullptr;
  fpKDNode = nullptr;
  fParentID_A = 0;
  fParentID_B = 0;
  fpTrackingInformation = nullptr;
  fpTrackNode = nullptr;
 
  return *this;
}

References FatalException, fParentID_A, fParentID_B, fpITBox, fpKDNode, fpNextIT, fpPreviousIT, fpTrack, fpTrackingInformation, fpTrackNode, and G4Exception().

operator==()

G4bool G4IT::operator==

(

const G4IT &

right

)

const

Definition at line 193 of file G4IT.cc.

{
  if (GetITType() == right.GetITType())
  {
    return this->equal(right);
  }
  return false;
}

References equal(), and GetITType().

Referenced by operator!=().

operator[]()

double G4IT::operator[]

(

int

i

)

const

Definition at line 207 of file G4IT.cc.

{
  return fpTrack->GetPosition()[i];
}

References fpTrack, and G4Track::GetPosition().

Print()

virtual void G4IT::Print ( ) const

inlinevirtual

Reimplemented from G4VUserTrackInformation.

Definition at line 97 of file G4IT.hh.

  {
    ;
  }

RecordCurrentPositionNTime()

void G4IT::RecordCurrentPositionNTime

(

)

Definition at line 220 of file G4IT.cc.

{
  if (fpTrack)
  {
    fpTrackingInformation->RecordCurrentPositionNTime(fpTrack);
  }
}

References fpTrack, fpTrackingInformation, and G4TrackingInformation::RecordCurrentPositionNTime().

Referenced by G4IT().

SetITBox()

void G4IT::SetITBox ( G4ITBox *  aITBox )

inline

Definition at line 188 of file G4IT.hh.

{
  fpITBox = aITBox;
}

References fpITBox.

Referenced by G4ITBox::Extract(), and G4ITBox::Push().

SetListNode()

void G4IT::SetListNode ( G4TrackListNode *  node )

inline

Definition at line 152 of file G4IT.hh.

  {
    fpTrackNode = node;
  }

References fpTrackNode.

SetNext()

void G4IT::SetNext ( G4IT *  aIT )

inline

Definition at line 198 of file G4IT.hh.

{
  fpNextIT = aIT;
}

References fpNextIT.

Referenced by G4ITBox::Extract(), and G4ITBox::Push().

SetNode()

void G4IT::SetNode ( G4KDNode_Base *  aNode )

inline

Definition at line 250 of file G4IT.hh.

{
  fpKDNode = aNode;
}

References fpKDNode.

SetParentID()

void G4IT::SetParentID ( int  p_a, int  p_b  )

inline

Definition at line 228 of file G4IT.hh.

{
  fParentID_A = p_a;
  fParentID_B = p_b;
}

References fParentID_A, and fParentID_B.

Referenced by G4ITModelProcessor::ComputeTrackReaction().

SetPrevious()

void G4IT::SetPrevious ( G4IT *  aIT )

inline

Definition at line 193 of file G4IT.hh.

{
  fpPreviousIT = aIT;
}

References fpPreviousIT.

Referenced by G4ITBox::Extract(), and G4ITBox::Push().

SetTrack()

void G4IT::SetTrack ( G4Track *  track )

inline

Definition at line 213 of file G4IT.hh.

{
  fpTrack = track;
}

References fpTrack.

TakeOutBox()

void G4IT::TakeOutBox

(

)

Definition at line 139 of file G4IT.cc.

{
  if(fpITBox)
  {
    fpITBox->Extract(this);
    fpITBox = nullptr;
  }
 
  if(fpTrackNode)
  {
    delete fpTrackNode;
    fpTrackNode = nullptr;
  }
 
  if(fpKDNode)
  {
    InactiveNode(fpKDNode);
    fpKDNode = nullptr;
  }
}

References G4ITBox::Extract(), fpITBox, fpKDNode, fpTrackNode, and InactiveNode().

Referenced by ~G4IT().

Field Documentation

fParentID_A

int G4IT::fParentID_A

private

Definition at line 175 of file G4IT.hh.

Referenced by G4IT(), GetParentID(), operator=(), and SetParentID().

fParentID_B

int G4IT::fParentID_B

private

Definition at line 176 of file G4IT.hh.

Referenced by G4IT(), GetParentID(), operator=(), and SetParentID().

fpITBox

G4ITBox* G4IT::fpITBox

private

Definition at line 170 of file G4IT.hh.

Referenced by G4IT(), GetITBox(), operator=(), SetITBox(), and TakeOutBox().

fpKDNode

G4KDNode_Base* G4IT::fpKDNode

private

Definition at line 173 of file G4IT.hh.

Referenced by G4IT(), GetNode(), operator=(), SetNode(), and TakeOutBox().

fpNextIT

G4IT* G4IT::fpNextIT

private

Definition at line 172 of file G4IT.hh.

Referenced by GetNext(), operator=(), and SetNext().

fpPreviousIT

G4IT* G4IT::fpPreviousIT

private

Definition at line 171 of file G4IT.hh.

Referenced by GetPrevious(), operator=(), and SetPrevious().

fpTrack

G4Track* G4IT::fpTrack

protected

Definition at line 167 of file G4IT.hh.

Referenced by G4Molecule::BuildTrack(), G4IT(), GetPosition(), GetTrack(), operator=(), operator[](), RecordCurrentPositionNTime(), SetTrack(), and G4Molecule::~G4Molecule().

fpTrackingInformation

G4TrackingInformation* G4IT::fpTrackingInformation

private

Definition at line 178 of file G4IT.hh.

Referenced by GetPreStepGlobalTime(), GetPreStepLocalTime(), GetPreStepPosition(), GetTrackingInfo(), operator=(), RecordCurrentPositionNTime(), and ~G4IT().

fpTrackNode

G4TrackListNode* G4IT::fpTrackNode

private

Definition at line 179 of file G4IT.hh.

Referenced by G4IT(), GetListNode(), operator=(), SetListNode(), and TakeOutBox().

pType

G4String* G4VUserTrackInformation::pType = nullptr

protectedinherited

Definition at line 75 of file G4VUserTrackInformation.hh.

Referenced by G4VUserTrackInformation::G4VUserTrackInformation(), G4VUserTrackInformation::GetType(), G4VUserTrackInformation::operator=(), and G4VUserTrackInformation::~G4VUserTrackInformation().

---

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

• source/processes/electromagnetic/dna/management/include/G4IT.hh
• source/processes/electromagnetic/dna/management/src/G4IT.cc