G4ITBox Class Reference

#include <G4ITBox.hh>

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

Private Member Functions
const G4ITBox &	operator= (const G4ITBox &right)

Private Attributes
G4int	fNbIT
G4IT *	fpFirstIT
G4IT *	fpLastIT
G4ITBox *	fpNextBox
G4ITBox *	fpPreviousBox

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

(

)

Definition at line 37 of file G4ITBox.cc.

                 : fNbIT(0), fpFirstIT(0), fpLastIT(0), fpPreviousBox(0), fpNextBox(0)
{;}

~G4ITBox()

G4ITBox::~G4ITBox

(

)

Definition at line 40 of file G4ITBox.cc.

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

References fNbIT, fpFirstIT, fpNextBox, fpPreviousBox, G4IT::GetNext(), SetNextBox(), and SetPreviousBox().

Member Function Documentation

Empty()

G4bool G4ITBox::Empty ( ) const

inline

Definition at line 106 of file G4ITBox.hh.

{
  return (fNbIT <= 0);
}

References fNbIT.

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())
        aStackedIT->GetNext()->SetPrevious(aStackedIT->GetPrevious());
    if( aStackedIT->GetPrevious())
        aStackedIT->GetPrevious()->SetNext(aStackedIT->GetNext());
 
    aStackedIT->SetNext(0);
    aStackedIT->SetPrevious(0);
    aStackedIT->SetITBox(0);
    fNbIT--;
}

References fNbIT, fpFirstIT, fpLastIT, G4IT::GetNext(), G4IT::GetPrevious(), G4IT::SetITBox(), G4IT::SetNext(), and G4IT::SetPrevious().

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 0;
 
    G4IT * temp = fpLastIT;
    G4bool find = false;
 
    while(find == false && temp != 0)
    {
        if(temp-> GetTrack() == &track)
        {
            find = true;
            break;
        }
        temp = temp->GetPrevious();
    }
 
    return temp;
}

References fNbIT, fpLastIT, and G4IT::GetPrevious().

FindIT() [2/2]

const G4IT * G4ITBox::FindIT

(

const G4Track &

track

)

const

Definition at line 129 of file G4ITBox.cc.

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

References fNbIT, fpLastIT, and G4IT::GetPrevious().

GetFirstIT() [1/2]

G4IT * G4ITBox::GetFirstIT ( )

inline

Definition at line 115 of file G4ITBox.hh.

{
  return fpFirstIT;
}

References fpFirstIT.

GetFirstIT() [2/2]

const G4IT * G4ITBox::GetFirstIT ( ) const

inline

Definition at line 124 of file G4ITBox.hh.

{
  return fpFirstIT;
}

References fpFirstIT.

GetLastIT() [1/2]

G4IT * G4ITBox::GetLastIT ( )

inline

Definition at line 119 of file G4ITBox.hh.

{
  return fpLastIT;
}

References fpLastIT.

GetLastIT() [2/2]

const G4IT * G4ITBox::GetLastIT ( ) const

inline

Definition at line 128 of file G4ITBox.hh.

{
  return fpLastIT;
}

References fpLastIT.

GetNextBox() [1/2]

G4ITBox * G4ITBox::GetNextBox ( )

inline

Definition at line 138 of file G4ITBox.hh.

{
  return fpNextBox;
}

References 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;
}

References fNbIT.

GetPreviousBox() [1/2]

G4ITBox * G4ITBox::GetPreviousBox ( )

inline

Definition at line 148 of file G4ITBox.hh.

{
  return fpPreviousBox;
}

References fpPreviousBox.

GetPreviousBox() [2/2]

const G4ITBox * G4ITBox::GetPreviousBox ( ) const

inline

operator=()

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

private

Definition at line 59 of file G4ITBox.cc.

{
    fNbIT = right.fNbIT;
    fpFirstIT = right.fpFirstIT;
    fpLastIT = right.fpLastIT;
    fpPreviousBox = 0;
    fpNextBox = 0;
    return *this;
}

References fNbIT, fpFirstIT, fpLastIT, fpNextBox, and fpPreviousBox.

Push()

void G4ITBox::Push

(

G4IT *

aIT

)

Definition at line 69 of file G4ITBox.cc.

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

References fNbIT, fpFirstIT, fpLastIT, G4IT::SetITBox(), G4IT::SetNext(), and G4IT::SetPrevious().

Referenced by TransferTo().

ResetStack()

void G4ITBox::ResetStack

(

)

SetNextBox()

void G4ITBox::SetNextBox ( G4ITBox *  box )

inline

Definition at line 133 of file G4ITBox.hh.

{
  fpNextBox = box;
}

References fpNextBox.

Referenced by ~G4ITBox().

SetPreviousBox()

void G4ITBox::SetPreviousBox ( G4ITBox *  box )

inline

Definition at line 143 of file G4ITBox.hh.

{
  fpPreviousBox = box;
}

References fpPreviousBox.

Referenced by ~G4ITBox().

TransferTo()

void G4ITBox::TransferTo

(

G4ITBox *

aStack

)

Definition at line 149 of file G4ITBox.cc.

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

References Extract(), fNbIT, fpFirstIT, G4IT::GetNext(), and Push().

Field Documentation

fNbIT

G4int G4ITBox::fNbIT

private

Definition at line 98 of file G4ITBox.hh.

Referenced by Empty(), Extract(), FindIT(), GetNTrack(), operator=(), Push(), TransferTo(), and ~G4ITBox().

fpFirstIT

G4IT* G4ITBox::fpFirstIT

private

Definition at line 99 of file G4ITBox.hh.

Referenced by Extract(), GetFirstIT(), operator=(), Push(), TransferTo(), and ~G4ITBox().

fpLastIT

G4IT* G4ITBox::fpLastIT

private

Definition at line 100 of file G4ITBox.hh.

Referenced by Extract(), FindIT(), GetLastIT(), operator=(), and Push().

fpNextBox

G4ITBox* G4ITBox::fpNextBox

private

Definition at line 103 of file G4ITBox.hh.

Referenced by GetNextBox(), operator=(), SetNextBox(), and ~G4ITBox().

fpPreviousBox

G4ITBox* G4ITBox::fpPreviousBox

private

Definition at line 102 of file G4ITBox.hh.

Referenced by GetPreviousBox(), operator=(), SetPreviousBox(), and ~G4ITBox().

---

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

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