BDSArrayOperatorIndex Class Reference

Interface for modifying by reference array indices. More...

#include <BDSArrayOperatorIndex.hh>

Inheritance diagram for BDSArrayOperatorIndex:

Collaboration diagram for BDSArrayOperatorIndex:

Public Member Functions
	BDSArrayOperatorIndex (const G4String &nameIn="None")
virtual G4String	Name () const
	Supply a name of this operator for feedback to the user in print out.
virtual void	Apply (G4int &, G4int &, G4int &, G4int &) const
virtual void	ApplyX (G4int &) const
virtual void	ApplyY (G4int &) const
virtual void	ApplyZ (G4int &) const
virtual void	ApplyT (G4int &) const
virtual std::array< G4bool, 4 >	OperatesOnXYZT () const
	Return which axes this object operates on overall.
void	Apply (G4int &x) const
void	Apply (G4int &x, G4int &y) const
void	Apply (G4int &x, G4int &y, G4int &z) const
virtual void	TransformLimits (G4double &xMin, G4double &xMax, G4double &yMin, G4double &yMax, G4double &zMin, G4double &zMax, G4double &tMin, G4double &tMax) const =0
void	TransformLimits (G4double &xMin, G4double xMax) const
void	TransformLimits (G4double &xMin, G4double &xMax, G4double &yMin, G4double &yMax) const
void	TransformLimits (G4double &xMin, G4double &xMax, G4double &yMin, G4double &yMax, G4double &zMin, G4double &zMax) const

Protected Attributes
G4String	name
std::array< G4bool, 4 >	operatesOn

Detailed Description

Interface for modifying by reference array indices.

This transforms coordinates in array index space via some mapping.

Apply() method is pure virtual.

Author

Laurie Nevay

Definition at line 35 of file BDSArrayOperatorIndex.hh.

Constructor & Destructor Documentation

BDSArrayOperatorIndex()

BDSArrayOperatorIndex::BDSArrayOperatorIndex ( const G4String &  nameIn = "None" )

inlineexplicit

Definition at line 39 of file BDSArrayOperatorIndex.hh.

~BDSArrayOperatorIndex()

virtual BDSArrayOperatorIndex::~BDSArrayOperatorIndex ( )

inlinevirtual

Definition at line 43 of file BDSArrayOperatorIndex.hh.

Member Function Documentation

Apply() [1/4]

virtual void BDSArrayOperatorIndex::Apply ( G4int &  , G4int &  , G4int &  , G4int &    ) const

inlinevirtual

Operation to modify the coordinates by reference. As we typically have more than one return value, we therefore use references as a way of doing this.

Reimplemented in BDSArrayOperatorIndexFlip, BDSArrayOperatorIndexReflect, and BDSArrayOperatorIndexV.

Definition at line 50 of file BDSArrayOperatorIndex.hh.

Referenced by BDSArray1DCoordsTransformed::ExtractNearest(), BDSArray2DCoordsTransformed::ExtractNearest(), BDSArray3DCoordsTransformed::ExtractNearest(), BDSArray4DCoordsTransformed::ExtractNearest(), BDSArray1DCoordsTransformed::ExtractSection2(), BDSArray2DCoordsTransformed::ExtractSection2x2(), BDSArray3DCoordsTransformed::ExtractSection2x2x2(), BDSArray4DCoordsTransformed::ExtractSection2x2x2x2(), BDSArray1DCoordsTransformed::ExtractSection4(), BDSArray2DCoordsTransformed::ExtractSection4x4(), BDSArray3DCoordsTransformed::ExtractSection4x4x4(), and BDSArray4DCoordsTransformed::ExtractSection4x4x4x4().

Here is the caller graph for this function:

Apply() [2/4]

void BDSArrayOperatorIndex::Apply ( G4int &  x ) const

inline

Definition at line 62 of file BDSArrayOperatorIndex.hh.

Apply() [3/4]

void BDSArrayOperatorIndex::Apply ( G4int &  x, G4int &  y  ) const

inline

Definition at line 68 of file BDSArrayOperatorIndex.hh.

Apply() [4/4]

void BDSArrayOperatorIndex::Apply ( G4int &  x, G4int &  y, G4int &  z  ) const

inline

Definition at line 74 of file BDSArrayOperatorIndex.hh.

ApplyT()

virtual void BDSArrayOperatorIndex::ApplyT ( G4int &  ) const

inlinevirtual

Definition at line 57 of file BDSArrayOperatorIndex.hh.

ApplyX()

virtual void BDSArrayOperatorIndex::ApplyX ( G4int &  ) const

inlinevirtual

Definition at line 54 of file BDSArrayOperatorIndex.hh.

ApplyY()

virtual void BDSArrayOperatorIndex::ApplyY ( G4int &  ) const

inlinevirtual

Definition at line 55 of file BDSArrayOperatorIndex.hh.

ApplyZ()

virtual void BDSArrayOperatorIndex::ApplyZ ( G4int &  ) const

inlinevirtual

Definition at line 56 of file BDSArrayOperatorIndex.hh.

Name()

virtual G4String BDSArrayOperatorIndex::Name ( ) const

inlinevirtual

Supply a name of this operator for feedback to the user in print out.

Reimplemented in BDSArrayOperatorIndexV.

Definition at line 46 of file BDSArrayOperatorIndex.hh.

Referenced by BDSFieldLoader::CreateOperators(), BDSArray1DCoordsTransformed::Print(), BDSArray2DCoordsTransformed::Print(), BDSArray3DCoordsTransformed::Print(), and BDSArray4DCoordsTransformed::Print().

Here is the caller graph for this function:

OperatesOnXYZT()

virtual std::array< G4bool, 4 > BDSArrayOperatorIndex::OperatesOnXYZT ( ) const

inlinevirtual

Return which axes this object operates on overall.

Definition at line 60 of file BDSArrayOperatorIndex.hh.

Referenced by BDSFieldLoader::CreateOperators(), and BDSArrayOperatorIndexV::push_back().

Here is the caller graph for this function:

TransformLimits() [1/3]

void BDSArrayOperatorIndex::TransformLimits ( G4double &  xMin, G4double &  xMax, G4double &  yMin, G4double &  yMax  ) const

inline

Definition at line 90 of file BDSArrayOperatorIndex.hh.

TransformLimits() [2/3]

void BDSArrayOperatorIndex::TransformLimits ( G4double &  xMin, G4double &  xMax, G4double &  yMin, G4double &  yMax, G4double &  zMin, G4double &  zMax  ) const

inline

Definition at line 96 of file BDSArrayOperatorIndex.hh.

TransformLimits() [3/3]

void BDSArrayOperatorIndex::TransformLimits ( G4double &  xMin, G4double  xMax  ) const

inline

Definition at line 85 of file BDSArrayOperatorIndex.hh.

Field Documentation

name

G4String BDSArrayOperatorIndex::name

protected

Definition at line 105 of file BDSArrayOperatorIndex.hh.

operatesOn

std::array<G4bool, 4> BDSArrayOperatorIndex::operatesOn

protected

Definition at line 106 of file BDSArrayOperatorIndex.hh.

---

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

• /__w/bdsim/bdsim/include/BDSArrayOperatorIndex.hh