G4ITBox Class Reference

#include <G4ITBox.hh>

Public Member Functions
	G4ITBox ()
	~G4ITBox ()
void	ResetStack ()
void	Push (G4IT *)
void	Extract (G4IT *)
G4IT *	FindIT (const G4Track &)
const G4IT *	FindIT (const G4Track &) const
void	TransferTo (G4ITBox *)
G4bool	Empty () const
G4int	GetNTrack () const
G4IT *	GetFirstIT ()
G4IT *	GetLastIT ()
const G4IT *	GetFirstIT () const
const G4IT *	GetLastIT () const
void	SetNextBox (G4ITBox *box)
G4ITBox *	GetNextBox ()
const G4ITBox *	GetNextBox () const
void	SetPreviousBox (G4ITBox *box)
G4ITBox *	GetPreviousBox ()
const G4ITBox *	GetPreviousBox () const

Detailed Description

G4ITBox behaves just like a stack for G4IT. You can search for specific tracks. Each G4IT knows to which G4ITBox it belongs and its corresponding node. This makes the deletion of an element very fast. The drawback is that a G4IT can only belong to one G4ITBox. If you are not looking for this feature, please use std::list.

Definition at line 60 of file G4ITBox.hh.

Constructor & Destructor Documentation

G4ITBox()

G4ITBox::G4ITBox ( )

default

~G4ITBox()

G4ITBox::~G4ITBox

(

)

Definition at line 40 of file G4ITBox.cc.

{
    if( fNbIT != 0 )
    {
        G4IT * aIT = fpFirstIT;
        G4IT * nextIT;
 
        while( aIT != nullptr )
        {
            nextIT = aIT->GetNext();
            delete aIT;
            aIT = nextIT;
        }
    }
 
    if(fpPreviousBox != nullptr)    fpPreviousBox->SetNextBox(fpNextBox) ;
    if(fpNextBox != nullptr)        fpNextBox->SetPreviousBox(fpPreviousBox);
}

Member Function Documentation

Empty()

G4bool G4ITBox::Empty ( ) const

inline

Definition at line 106 of file G4ITBox.hh.

{
  return (fNbIT <= 0);
}

Extract()

void G4ITBox::Extract

(

G4IT *

aStackedIT

)

Definition at line 86 of file G4ITBox.cc.

{
    if( aStackedIT == fpFirstIT )
    {
        fpFirstIT = aStackedIT->GetNext();
    }
    else  if( aStackedIT == fpLastIT )
    {
        fpLastIT = aStackedIT->GetPrevious();
 
    }
 
    if( aStackedIT->GetNext() != nullptr)
        aStackedIT->GetNext()->SetPrevious(aStackedIT->GetPrevious());
    if( aStackedIT->GetPrevious() != nullptr)
        aStackedIT->GetPrevious()->SetNext(aStackedIT->GetNext());
 
    aStackedIT->SetNext(nullptr);
    aStackedIT->SetPrevious(nullptr);
    aStackedIT->SetITBox(nullptr);
    fNbIT--;
}

Referenced by G4IT::TakeOutBox(), and TransferTo().

FindIT() [1/2]

G4IT * G4ITBox::FindIT

(

const G4Track &

track

)

The FindIT methods are used for check only. Those methods are not effective due to the linear search. It is better to use GetIT(track) in order to retrieve the IT and GetIT(track)->GetBox() in order to check which is the box pointer.

Definition at line 109 of file G4ITBox.cc.

{
    if( fNbIT == 0 ) return nullptr;
 
    G4IT * temp = fpLastIT;
    G4bool find = false;
 
    while(!find && temp != nullptr)
    {
        if(temp-> GetTrack() == &track)
        {
            find = true;
            break;
        }
        temp = temp->GetPrevious();
    }
 
    return temp;
}

FindIT() [2/2]

const G4IT * G4ITBox::FindIT

(

const G4Track &

track

)

const

Definition at line 129 of file G4ITBox.cc.

{
    if( fNbIT == 0 ) return nullptr;
 
    const G4IT * temp = fpLastIT;
    G4bool find = false;
 
    while(!find && temp != nullptr)
    {
        if(temp-> GetTrack() == &track)
        {
            find = true;
            break;
        }
        temp = temp->GetPrevious();
    }
 
    return temp;
}

GetFirstIT() [1/2]

G4IT * G4ITBox::GetFirstIT ( )

inline

Definition at line 115 of file G4ITBox.hh.

{
  return fpFirstIT;
}

GetFirstIT() [2/2]

const G4IT * G4ITBox::GetFirstIT ( ) const

inline

Definition at line 124 of file G4ITBox.hh.

{
  return fpFirstIT;
}

GetLastIT() [1/2]

G4IT * G4ITBox::GetLastIT ( )

inline

Definition at line 119 of file G4ITBox.hh.

{
  return fpLastIT;
}

GetLastIT() [2/2]

const G4IT * G4ITBox::GetLastIT ( ) const

inline

Definition at line 128 of file G4ITBox.hh.

{
  return fpLastIT;
}

GetNextBox() [1/2]

G4ITBox * G4ITBox::GetNextBox ( )

inline

Definition at line 138 of file G4ITBox.hh.

{
  return fpNextBox;
}

GetNextBox() [2/2]

const G4ITBox * G4ITBox::GetNextBox ( ) const

inline

GetNTrack()

G4int G4ITBox::GetNTrack ( ) const

inline

Definition at line 111 of file G4ITBox.hh.

{
  return fNbIT;
}

GetPreviousBox() [1/2]

G4ITBox * G4ITBox::GetPreviousBox ( )

inline

Definition at line 148 of file G4ITBox.hh.

{
  return fpPreviousBox;
}

GetPreviousBox() [2/2]

const G4ITBox * G4ITBox::GetPreviousBox ( ) const

inline

Push()

void G4ITBox::Push

(

G4IT *

aIT

)

Definition at line 69 of file G4ITBox.cc.

{
    if( fNbIT == 0 )
    {
        aIT->SetPrevious( nullptr );
        fpFirstIT = aIT;
    }
    else
    {
        fpLastIT->SetNext( aIT );
        aIT->SetPrevious( fpLastIT );
    }
    fpLastIT = aIT;
    fNbIT++;
    aIT->SetITBox(this);
}

Referenced by TransferTo().

ResetStack()

void G4ITBox::ResetStack

(

)

SetNextBox()

void G4ITBox::SetNextBox ( G4ITBox * box )

inline

Definition at line 133 of file G4ITBox.hh.

{
  fpNextBox = box;
}

Referenced by ~G4ITBox().

SetPreviousBox()

void G4ITBox::SetPreviousBox ( G4ITBox * box )

inline

Definition at line 143 of file G4ITBox.hh.

{
  fpPreviousBox = box;
}

Referenced by ~G4ITBox().

TransferTo()

void G4ITBox::TransferTo

(

G4ITBox *

aStack

)

Definition at line 149 of file G4ITBox.cc.

{
    G4IT * ITToTransfer = fpFirstIT;
    while(fNbIT != 0)
    {
        Extract(ITToTransfer);
        aStack->Push(ITToTransfer);
        ITToTransfer = ITToTransfer->GetNext();
    }
}

---

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

• G4ITBox.hh
• G4ITBox.cc