G4ITBox Class Reference

#include <G4ITBox.hh>

Collaboration diagram for G4ITBox:

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

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

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

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 61 of file G4ITBox.hh.

Constructor & Destructor Documentation

G4ITBox()

G4ITBox::G4ITBox

(

)

Definition at line 38 of file G4ITBox.cc.

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

~G4ITBox()

G4ITBox::~G4ITBox

(

)

Definition at line 41 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);
}

Here is the call graph for this function:

Member Function Documentation

Empty()

G4bool G4ITBox::Empty ( ) const

inline

Definition at line 107 of file G4ITBox.hh.

{
  return (fNbIT <= 0);
}

Extract()

void G4ITBox::Extract

(

G4IT *

aStackedIT

)

Definition at line 87 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--;
}

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the call graph for this function:

FindIT() [2/2]

const G4IT * G4ITBox::FindIT

(

const G4Track &

track

)

const

Definition at line 130 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;
}

Here is the call graph for this function:

GetFirstIT() [1/2]

G4IT * G4ITBox::GetFirstIT ( )

inline

Definition at line 116 of file G4ITBox.hh.

{
  return fpFirstIT;
}

GetFirstIT() [2/2]

const G4IT * G4ITBox::GetFirstIT ( ) const

inline

Definition at line 125 of file G4ITBox.hh.

{
  return fpFirstIT;
}

GetLastIT() [1/2]

G4IT * G4ITBox::GetLastIT ( )

inline

Definition at line 120 of file G4ITBox.hh.

{
  return fpLastIT;
}

GetLastIT() [2/2]

const G4IT * G4ITBox::GetLastIT ( ) const

inline

Definition at line 129 of file G4ITBox.hh.

{
  return fpLastIT;
}

GetNextBox() [1/2]

G4ITBox * G4ITBox::GetNextBox ( )

inline

Definition at line 139 of file G4ITBox.hh.

{
  return fpNextBox;
}

GetNextBox() [2/2]

const G4ITBox* G4ITBox::GetNextBox ( ) const

inline

GetNTrack()

G4int G4ITBox::GetNTrack ( ) const

inline

Definition at line 112 of file G4ITBox.hh.

{
  return fNbIT;
}

GetPreviousBox() [1/2]

G4ITBox * G4ITBox::GetPreviousBox ( )

inline

Definition at line 149 of file G4ITBox.hh.

{
  return fpPreviousBox;
}

GetPreviousBox() [2/2]

const G4ITBox* G4ITBox::GetPreviousBox ( ) const

inline

operator=()

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

private

Definition at line 60 of file G4ITBox.cc.

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

Push()

void G4ITBox::Push

(

G4IT *

aIT

)

Definition at line 70 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);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ResetStack()

void G4ITBox::ResetStack

(

)

SetNextBox()

void G4ITBox::SetNextBox ( G4ITBox *  box )

inline

Definition at line 134 of file G4ITBox.hh.

{
  fpNextBox = box;
}

Here is the caller graph for this function:

SetPreviousBox()

void G4ITBox::SetPreviousBox ( G4ITBox *  box )

inline

Definition at line 144 of file G4ITBox.hh.

{
  fpPreviousBox = box;
}

Here is the caller graph for this function:

TransferTo()

void G4ITBox::TransferTo

(

G4ITBox *

aStack

)

Definition at line 150 of file G4ITBox.cc.

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

Here is the call graph for this function:

Member Data Documentation

fNbIT

G4int G4ITBox::fNbIT

private

Definition at line 99 of file G4ITBox.hh.

fpFirstIT

G4IT* G4ITBox::fpFirstIT

private

Definition at line 100 of file G4ITBox.hh.

fpLastIT

G4IT* G4ITBox::fpLastIT

private

Definition at line 101 of file G4ITBox.hh.

fpNextBox

G4ITBox* G4ITBox::fpNextBox

private

Definition at line 104 of file G4ITBox.hh.

fpPreviousBox

G4ITBox* G4ITBox::fpPreviousBox

private

Definition at line 103 of file G4ITBox.hh.

---

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

• G4ITBox.hh
• G4ITBox.cc