PndFieldPar Class Reference

#include <PndFieldPar.h>

Inheritance diagram for PndFieldPar:

Public Member Functions
	PndFieldPar (const char *name, const char *title, const char *context)
	PndFieldPar ()
	~PndFieldPar ()
virtual void	putParams (FairParamList *list)
virtual Bool_t	getParams (FairParamList *list)
void	SetParameters (FairField *field)
Int_t	GetType () const
Double_t	GetXmin () const
Double_t	GetXmax () const
Double_t	GetYmin () const
Double_t	GetYmax () const
Double_t	GetZmin () const
Double_t	GetZmax () const
Double_t	GetBx () const
Double_t	GetBy () const
Double_t	GetBz () const
void	MapName (TString &name)
Double_t	GetPositionX () const
Double_t	GetPositionY () const
Double_t	GetPositionZ () const
Double_t	GetScale () const

Private Member Functions
	ClassDef (PndFieldPar, 1)

Private Attributes
Int_t	fType
Double_t	fXmin
Double_t	fXmax
Double_t	fYmin
Double_t	fYmax
Double_t	fZmin
Double_t	fZmax
Double_t	fBx
Double_t	fBy
Double_t	fBz
TString	fMapName
Double_t	fPosX
Double_t	fPosY
Double_t	fPosZ
Double_t	fScale

Detailed Description

Definition at line 14 of file PndFieldPar.h.

Constructor & Destructor Documentation

PndFieldPar::PndFieldPar	(	const char *	name,
		const char *	title,
		const char *	context
	)

Standard constructor

Definition at line 12 of file PndFieldPar.cxx.

  : FairParGenericSet(name, title, context), 
    fType(-1),
    fXmin(0), 
    fXmax(0),
    fYmin(0), 
    fYmax(0),
    fZmin(0), 
    fZmax(0),
    fBx(0), 
    fBy(0), 
    fBz(0),
    fMapName(TString("")),
    fPosX(0), 
    fPosY(0), 
    fPosZ(0),
    fScale(0)

{
}

PndFieldPar::PndFieldPar

(

)

default constructor

Definition at line 35 of file PndFieldPar.cxx.

  :fType(-1),
  fXmin(0), 
  fXmax(0),
  fYmin(0), 
  fYmax(0),
  fZmin(0), 
  fZmax(0),
  fBx(0), 
  fBy(0), 
  fBz(0),
  fMapName(TString("")),
  fPosX(0), 
  fPosY(0), 
  fPosZ(0),
  fScale(0)
{
}

PndFieldPar::~PndFieldPar

(

)

Destructor

Definition at line 56 of file PndFieldPar.cxx.

{ }

Member Function Documentation

PndFieldPar::ClassDef ( PndFieldPar  , 1    )

private

Double_t PndFieldPar::GetBx ( ) const

inline

Definition at line 44 of file PndFieldPar.h.

References fBx.

{ return fBx; }

Double_t PndFieldPar::GetBy ( ) const

inline

Definition at line 45 of file PndFieldPar.h.

References fBy.

{ return fBy; }

Double_t PndFieldPar::GetBz ( ) const

inline

Definition at line 46 of file PndFieldPar.h.

References fBz.

{ return fBz; }

Bool_t PndFieldPar::getParams ( FairParamList *  list )

virtual

Get parameters

Definition at line 95 of file PndFieldPar.cxx.

References fBx, fBy, fBz, fMapName, fPosX, fPosY, fPosZ, fScale, fType, fXmax, fXmin, fYmax, fYmin, fZmax, and fZmin.

                                                 {

  if ( ! list ) return kFALSE;

  if ( ! list->fill("Field Type", &fType) ) return kFALSE;

  if ( fType == 0 ) {                    // constant field
    if ( ! list->fill("Field min x", &fXmin) ) return kFALSE;
    if ( ! list->fill("Field max x", &fXmax) ) return kFALSE;
    if ( ! list->fill("Field min y", &fYmin) ) return kFALSE;
    if ( ! list->fill("Field max y", &fYmax) ) return kFALSE;
    if ( ! list->fill("Field min z", &fZmin) ) return kFALSE;
    if ( ! list->fill("Field max z", &fZmax) ) return kFALSE;
    if ( ! list->fill("Field Bx", &fBx) ) return kFALSE;
    if ( ! list->fill("Field By", &fBy) ) return kFALSE;
    if ( ! list->fill("Field Bz", &fBz) ) return kFALSE;
  }

  else if (fType >=1 && fType <= 4) {    // field map
    Text_t mapName[80];
    if ( ! list->fill("Field map name", mapName, 80) ) return kFALSE;
    fMapName = mapName;
    if ( ! list->fill("Field x position", &fPosX) )  return kFALSE;
    if ( ! list->fill("Field y position", &fPosY) )  return kFALSE;
    if ( ! list->fill("Field z position", &fPosZ) )  return kFALSE;
    if ( ! list->fill("Field scaling factor", &fScale) ) return kFALSE;
  }
  return kTRUE;

}

Double_t PndFieldPar::GetPositionX ( ) const

inline

Definition at line 48 of file PndFieldPar.h.

References fPosX.

Referenced by PndFieldMap::PndFieldMap().

{ return fPosX; }

Double_t PndFieldPar::GetPositionY ( ) const

inline

Definition at line 49 of file PndFieldPar.h.

References fPosY.

Referenced by PndFieldMap::PndFieldMap().

{ return fPosY; }

Double_t PndFieldPar::GetPositionZ ( ) const

inline

Definition at line 50 of file PndFieldPar.h.

References fPosZ.

Referenced by PndFieldMap::PndFieldMap().

{ return fPosZ; }

Double_t PndFieldPar::GetScale ( ) const

inline

Definition at line 51 of file PndFieldPar.h.

References fScale.

Referenced by PndFieldMap::PndFieldMap().

{ return fScale; }

Int_t PndFieldPar::GetType ( ) const

inline

Accessors

Definition at line 37 of file PndFieldPar.h.

References fType.

Referenced by PndFieldCreator::createFairField(), and PndFieldMap::PndFieldMap().

{ return fType; }

Double_t PndFieldPar::GetXmax ( ) const

inline

Definition at line 39 of file PndFieldPar.h.

References fXmax.

{ return fXmax; }

Double_t PndFieldPar::GetXmin ( ) const

inline

Definition at line 38 of file PndFieldPar.h.

References fXmin.

{ return fXmin; }

Double_t PndFieldPar::GetYmax ( ) const

inline

Definition at line 41 of file PndFieldPar.h.

References fYmax.

{ return fYmax; }

Double_t PndFieldPar::GetYmin ( ) const

inline

Definition at line 40 of file PndFieldPar.h.

References fYmin.

{ return fYmin; }

Double_t PndFieldPar::GetZmax ( ) const

inline

Definition at line 43 of file PndFieldPar.h.

References fZmax.

{ return fZmax; }

Double_t PndFieldPar::GetZmin ( ) const

inline

Definition at line 42 of file PndFieldPar.h.

References fZmin.

{ return fZmin; }

void PndFieldPar::MapName ( TString &  name )

inline

Definition at line 47 of file PndFieldPar.h.

References fMapName.

Referenced by PndFieldMap::PndFieldMap().

{ name = fMapName; }

void PndFieldPar::putParams ( FairParamList *  list )

virtual

Put parameters

Definition at line 62 of file PndFieldPar.cxx.

References fBx, fBy, fBz, fMapName, fPosX, fPosY, fPosZ, fScale, fType, fXmax, fXmin, fYmax, fYmin, fZmax, and fZmin.

                                               {

  if ( ! list ) return;

  list->add("Field Type", fType);

  if ( fType == 0 ) {                    // constant field
    list->add("Field min x", fXmin);
    list->add("Field max x", fXmax);
    list->add("Field min y", fYmin);
    list->add("Field max y", fYmax);
    list->add("Field min z", fZmin);
    list->add("Field max z", fZmax);
    list->add("Field Bx", fBx);
    list->add("Field By", fBy);
    list->add("Field Bz", fBz);
  }

  else if (fType >=1 && fType <= 4) {    // field map
    list->add("Field map name", fMapName);
    list->add("Field x position", fPosX);
    list->add("Field y position", fPosY);
    list->add("Field z position", fPosZ);
    list->add("Field scaling factor", fScale);

  }

}

void PndFieldPar::SetParameters

(

FairField *

field

)

Set parameters from FairField

Definition at line 130 of file PndFieldPar.cxx.

References fBx, fBy, fBz, fi, fMapName, fPosX, fPosY, fPosZ, fScale, fType, fXmax, fXmin, fYmax, fYmin, fZmax, fZmin, PndConstField::GetBx(), PndConstField::GetBy(), PndConstField::GetBz(), PndMultiField::GetFieldList(), PndFieldMap::GetPositionX(), PndFieldMap::GetPositionY(), PndFieldMap::GetPositionZ(), PndFieldMap::GetScale(), PndConstField::GetXmax(), PndConstField::GetXmin(), PndConstField::GetYmax(), PndConstField::GetYmin(), PndConstField::GetZmax(), and PndConstField::GetZmin().

                                                {

  if ( ! field ) {
    cerr << "-W- PndFieldPar::SetParameters: Empty field pointer!" << endl;
    return;
  }

  fType = field->GetType();
 
  if ( fType == 0 ) {                                 // constant field
    PndConstField* fieldConst = (PndConstField*) field;
    fBx = fieldConst->GetBx();
    fBy = fieldConst->GetBy();
    fBz = fieldConst->GetBz();
    fXmin = fieldConst->GetXmin();
    fXmax = fieldConst->GetXmax();
    fYmin = fieldConst->GetYmin();
    fYmax = fieldConst->GetYmax();
    fZmin = fieldConst->GetZmin();
    fZmax = fieldConst->GetZmax();
    fMapName = "";
    fPosX = fPosY = fPosZ = fScale = 0.;
  }

  else if ( fType >=1 && fType <= 4 ) {              // field map
    PndFieldMap* fieldMap = (PndFieldMap*) field;
    fBx = fBy = fBz = 0.;
    fXmin = fXmax = fYmin = fYmax = fZmin = fZmax = 0.;
    
    fMapName = field->GetName();
    fPosX   = fieldMap->GetPositionX();
    fPosY   = fieldMap->GetPositionY();
    fPosZ   = fieldMap->GetPositionZ();
    fScale  = fieldMap->GetScale();
  } else if (fType ==5) {
    
    PndMultiField *fMulti=(PndMultiField *)field;
    TObjArray *fieldlist = fMulti->GetFieldList();
    TIterator* FieldIter = fieldlist->MakeIterator();
    FieldIter->Reset();
    FairField *fi=0;
    while( (fi = (FairField*)FieldIter->Next() ) ) {
         SetParameters(fi);
    }
   
   delete  FieldIter;
  }else {
    cerr << "-W- PndFieldPar::SetParameters: Unknown field type "
         << fType << "!" << endl;
    fBx = fBy = fBz = 0.;
    fXmin = fXmax = fYmin = fYmax = fZmin = fZmax = 0.;
    fMapName = "";
    fPosX = fPosY = fPosZ = fScale = 0.;
  }
  
  return;

}

Member Data Documentation

Double_t PndFieldPar::fBx

private

Field values in case of constant field [kG]

Definition at line 69 of file PndFieldPar.h.

Referenced by GetBx(), getParams(), putParams(), and SetParameters().

Double_t PndFieldPar::fBy

private

Definition at line 69 of file PndFieldPar.h.

Referenced by GetBy(), getParams(), putParams(), and SetParameters().

Double_t PndFieldPar::fBz

private

Definition at line 69 of file PndFieldPar.h.

Referenced by GetBz(), getParams(), putParams(), and SetParameters().

TString PndFieldPar::fMapName

private

Field map name in case of field map

Definition at line 72 of file PndFieldPar.h.

Referenced by getParams(), MapName(), putParams(), and SetParameters().

Double_t PndFieldPar::fPosX

private

Field centre position for field map

Definition at line 75 of file PndFieldPar.h.

Referenced by getParams(), GetPositionX(), putParams(), and SetParameters().

Double_t PndFieldPar::fPosY

private

Definition at line 75 of file PndFieldPar.h.

Referenced by getParams(), GetPositionY(), putParams(), and SetParameters().

Double_t PndFieldPar::fPosZ

private

Definition at line 75 of file PndFieldPar.h.

Referenced by getParams(), GetPositionZ(), putParams(), and SetParameters().

Double_t PndFieldPar::fScale

private

Scaling factor for field map

Definition at line 78 of file PndFieldPar.h.

Referenced by getParams(), GetScale(), putParams(), and SetParameters().

Int_t PndFieldPar::fType

private

Field type 0 = constant field 1 = field map 2 = field map sym2 (symmetries in x and y) 3 = field map sym3 (symmetries in x, y and z)

Definition at line 61 of file PndFieldPar.h.

Referenced by getParams(), GetType(), putParams(), and SetParameters().

Double_t PndFieldPar::fXmax

private

Definition at line 64 of file PndFieldPar.h.

Referenced by getParams(), GetXmax(), putParams(), and SetParameters().

Double_t PndFieldPar::fXmin

private

Field limits in case of constant field

Definition at line 64 of file PndFieldPar.h.

Referenced by getParams(), GetXmin(), putParams(), and SetParameters().

Double_t PndFieldPar::fYmax

private

Definition at line 65 of file PndFieldPar.h.

Referenced by getParams(), GetYmax(), putParams(), and SetParameters().

Double_t PndFieldPar::fYmin

private

Definition at line 65 of file PndFieldPar.h.

Referenced by getParams(), GetYmin(), putParams(), and SetParameters().

Double_t PndFieldPar::fZmax

private

Definition at line 66 of file PndFieldPar.h.

Referenced by getParams(), GetZmax(), putParams(), and SetParameters().

Double_t PndFieldPar::fZmin

private

Definition at line 66 of file PndFieldPar.h.

Referenced by getParams(), GetZmin(), putParams(), and SetParameters().

---

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

• PndFieldPar.h
• PndFieldPar.cxx