BDSFieldQueryInfo Class Reference

Holder class for all information required for a field query. More...

#include <BDSFieldQueryInfo.hh>

Collaboration diagram for BDSFieldQueryInfo:

Data Structures
struct	QueryDimensionInfo

Public Member Functions
	BDSFieldQueryInfo (const G4String &nameIn, const G4String &outfileMagneticIn, const G4String &outfileElectricIn, G4bool queryMagneticIn, G4bool queryElectricIn, QueryDimensionInfo xInfoIn, QueryDimensionInfo yInfoIn, QueryDimensionInfo zInfoIn, QueryDimensionInfo tInfoIn, const G4AffineTransform &globalTransformIn=G4AffineTransform(), G4bool overwriteExistingFilesIn=false, const G4String &fieldObjectIn="", G4bool printTransformIn=false, G4bool checkParametersIn=true, G4bool drawArrowsIn=true, G4bool drawZeroValuePointsIn=true, G4bool drawBoxesIn=true, G4double boxAlphaIn=0.2)
	Usual constructor with number of points to query in each dimension.
	BDSFieldQueryInfo (const G4String &nameIn, const G4String &outfileMagneticIn, const G4String &outfileElectricIn, G4bool queryMagneticIn, G4bool queryElectricIn, const std::vector< BDSFourVector< G4double > > &pointsToQueryIn, const std::vector< G4String > &pointsColumnNamesIn, G4bool overwriteExistingFilesIn=false, const G4String &fieldObjectIn="", G4bool checkParametersIn=true, G4bool drawArrowsIn=true, G4bool drawZeroValuePointsIn=true, G4bool drawBoxesIn=true, G4double boxAlphaIn=0.2)
	Alternative constructor with list of exact points to query.
G4bool	SpecificPoints () const
	Whether to query a specific set of points.

Data Fields
G4String	name
G4String	outfileMagnetic
G4String	outfileElectric
G4bool	queryMagnetic
G4bool	queryElectric
QueryDimensionInfo	xInfo
QueryDimensionInfo	yInfo
QueryDimensionInfo	zInfo
QueryDimensionInfo	tInfo
std::vector< BDSFourVector< G4double > >	pointsToQuery
std::vector< G4String >	pointsColumnNames
G4AffineTransform	globalTransform
G4bool	overwriteExistingFiles
G4bool	printTransform
G4String	fieldObject
	Optional for use in interpolator.
G4bool	checkParameters
	For internal testing use only.
G4bool	drawArrows
G4bool	drawZeroValuePoints
G4bool	drawBoxes
G4double	boxAlpha

Detailed Description

Holder class for all information required for a field query.

Author

Laurie Nevay

Definition at line 36 of file BDSFieldQueryInfo.hh.

Constructor & Destructor Documentation

BDSFieldQueryInfo() [1/2]

BDSFieldQueryInfo::BDSFieldQueryInfo	(	const G4String &	nameIn,
		const G4String &	outfileMagneticIn,
		const G4String &	outfileElectricIn,
		G4bool	queryMagneticIn,
		G4bool	queryElectricIn,
		QueryDimensionInfo	xInfoIn,
		QueryDimensionInfo	yInfoIn,
		QueryDimensionInfo	zInfoIn,
		QueryDimensionInfo	tInfoIn,
		const G4AffineTransform &	globalTransformIn = G4AffineTransform(),
		G4bool	overwriteExistingFilesIn = false,
		const G4String &	fieldObjectIn = "",
		G4bool	printTransformIn = false,
		G4bool	checkParametersIn = true,
		G4bool	drawArrowsIn = true,
		G4bool	drawZeroValuePointsIn = true,
		G4bool	drawBoxesIn = true,
		G4double	boxAlphaIn = 0.2
	)

Usual constructor with number of points to query in each dimension.

Definition at line 21 of file BDSFieldQueryInfo.cc.

BDSFieldQueryInfo() [2/2]

BDSFieldQueryInfo::BDSFieldQueryInfo	(	const G4String &	nameIn,
		const G4String &	outfileMagneticIn,
		const G4String &	outfileElectricIn,
		G4bool	queryMagneticIn,
		G4bool	queryElectricIn,
		const std::vector< BDSFourVector< G4double > > &	pointsToQueryIn,
		const std::vector< G4String > &	pointsColumnNamesIn,
		G4bool	overwriteExistingFilesIn = false,
		const G4String &	fieldObjectIn = "",
		G4bool	checkParametersIn = true,
		G4bool	drawArrowsIn = true,
		G4bool	drawZeroValuePointsIn = true,
		G4bool	drawBoxesIn = true,
		G4double	boxAlphaIn = 0.2
	)

Alternative constructor with list of exact points to query.

Definition at line 59 of file BDSFieldQueryInfo.cc.

~BDSFieldQueryInfo()

BDSFieldQueryInfo::~BDSFieldQueryInfo

(

)

Definition at line 90 of file BDSFieldQueryInfo.cc.

Member Function Documentation

SpecificPoints()

G4bool BDSFieldQueryInfo::SpecificPoints ( ) const

inline

Whether to query a specific set of points.

Definition at line 118 of file BDSFieldQueryInfo.hh.

Referenced by BDSFieldQuery::QueryField().

Here is the caller graph for this function:

Field Documentation

boxAlpha

G4double BDSFieldQueryInfo::boxAlpha

Definition at line 115 of file BDSFieldQueryInfo.hh.

checkParameters

G4bool BDSFieldQueryInfo::checkParameters

For internal testing use only.

Definition at line 110 of file BDSFieldQueryInfo.hh.

Referenced by BDSFieldQuery::QueryField().

drawArrows

G4bool BDSFieldQueryInfo::drawArrows

Definition at line 112 of file BDSFieldQueryInfo.hh.

drawBoxes

G4bool BDSFieldQueryInfo::drawBoxes

Definition at line 114 of file BDSFieldQueryInfo.hh.

drawZeroValuePoints

G4bool BDSFieldQueryInfo::drawZeroValuePoints

Definition at line 113 of file BDSFieldQueryInfo.hh.

fieldObject

G4String BDSFieldQueryInfo::fieldObject

Optional for use in interpolator.

Definition at line 108 of file BDSFieldQueryInfo.hh.

Referenced by BDSFieldQuery::CheckIfFieldObjectSpecified(), and BDSFieldQueryRaw::CheckIfFieldObjectSpecified().

globalTransform

G4AffineTransform BDSFieldQueryInfo::globalTransform

Definition at line 103 of file BDSFieldQueryInfo.hh.

name

G4String BDSFieldQueryInfo::name

Definition at line 90 of file BDSFieldQueryInfo.hh.

outfileElectric

G4String BDSFieldQueryInfo::outfileElectric

Definition at line 92 of file BDSFieldQueryInfo.hh.

outfileMagnetic

G4String BDSFieldQueryInfo::outfileMagnetic

Definition at line 91 of file BDSFieldQueryInfo.hh.

overwriteExistingFiles

G4bool BDSFieldQueryInfo::overwriteExistingFiles

Definition at line 105 of file BDSFieldQueryInfo.hh.

pointsColumnNames

std::vector<G4String> BDSFieldQueryInfo::pointsColumnNames

Definition at line 101 of file BDSFieldQueryInfo.hh.

pointsToQuery

std::vector<BDSFourVector<G4double> > BDSFieldQueryInfo::pointsToQuery

Definition at line 100 of file BDSFieldQueryInfo.hh.

printTransform

G4bool BDSFieldQueryInfo::printTransform

Definition at line 106 of file BDSFieldQueryInfo.hh.

queryElectric

G4bool BDSFieldQueryInfo::queryElectric

Definition at line 94 of file BDSFieldQueryInfo.hh.

queryMagnetic

G4bool BDSFieldQueryInfo::queryMagnetic

Definition at line 93 of file BDSFieldQueryInfo.hh.

tInfo

QueryDimensionInfo BDSFieldQueryInfo::tInfo

Definition at line 98 of file BDSFieldQueryInfo.hh.

xInfo

QueryDimensionInfo BDSFieldQueryInfo::xInfo

Definition at line 95 of file BDSFieldQueryInfo.hh.

yInfo

QueryDimensionInfo BDSFieldQueryInfo::yInfo

Definition at line 96 of file BDSFieldQueryInfo.hh.

zInfo

QueryDimensionInfo BDSFieldQueryInfo::zInfo

Definition at line 97 of file BDSFieldQueryInfo.hh.

---

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

• /__w/bdsim/bdsim/include/BDSFieldQueryInfo.hh
• /__w/bdsim/bdsim/src/BDSFieldQueryInfo.cc