PHFieldConfigv1 implements field configuration information for input a field map file. More...

#include <fun4all_coresoftware/blob/master/offline/packages/PHField/PHFieldConfigv1.h>

Inheritance diagram for PHFieldConfigv1:

Collaboration diagram for PHFieldConfigv1:

Public Member Functions
	PHFieldConfigv1 (FieldConfigTypes field_config, const std::string &filename, double magfield_rescale=1.)

	PHFieldConfigv1 ()
	default constructor for ROOT file IO

	~PHFieldConfigv1 () override

PHObject *	CloneMe () const override
	Virtual copy constructor.

void	identify (std::ostream &os=std::cout) const override

void	Reset () override
	Clear Content.

int	isValid () const override
	isValid returns non zero if object contains vailid data

FieldConfigTypes	get_field_config () const override

void	set_field_config (FieldConfigTypes fieldConfig) override

const std::string &	get_filename () const override

void	set_filename (const std::string &filename) override

double	get_magfield_rescale () const override

void	set_magfield_rescale (double magfieldRescale) override

Public Member Functions inherited from PHFieldConfig
	~PHFieldConfig () override

std::string	get_field_config_description () const

virtual double	get_field_mag_x () const
	field value in Tesla for uniform field model ONLY for PHFieldConfig_v2

virtual void	set_field_mag_x (double)
	field value in Tesla for uniform field model ONLY for PHFieldConfig_v2

virtual double	get_field_mag_y () const
	field value in Tesla for uniform field model ONLY for PHFieldConfig_v2

virtual void	set_field_mag_y (double)
	field value in Tesla for uniform field model ONLY for PHFieldConfig_v2

virtual double	get_field_mag_z () const
	field value in Tesla for uniform field model ONLY for PHFieldConfig_v2

virtual void	set_field_mag_z (double)
	field value in Tesla for uniform field model ONLY for PHFieldConfig_v2

Public Member Functions inherited from PHObject
	PHObject ()
	ctor

	~PHObject () override
	dtor

virtual PHObject *	clone () const final

PHObject *	Clone (const char *newname="") const final

void	Copy (TObject &object) const final

virtual int	isValid (const float) const

virtual int	isValid (const double) const

virtual int	isValid (const int) const

virtual int	isValid (const unsigned int) const

virtual int	isImplemented (const float f) const

virtual int	isImplemented (const double f) const

virtual int	isImplemented (const int i) const

virtual int	isImplemented (const unsigned int i) const

virtual int	Integrate () const

virtual int	Integrate (PHObject *)

virtual void	CopyFrom (const PHObject *obj)

Protected Attributes
FieldConfigTypes	field_config_

std::string	filename_

double	magfield_rescale_

Additional Inherited Members
Public Types inherited from PHFieldConfig
enum	FieldConfigTypes { kFieldUniform = 0, kField2D = 2, kField3DCylindrical = 3, kFieldBeast = 4, kFieldCleo = 5, Field3DCartesian = 1, kFieldInvalid = 9999 }

Protected Member Functions inherited from PHFieldConfig
	PHFieldConfig ()
	pure virtual interface class. not for direct use

Static Protected Attributes inherited from PHFieldConfig
static const std::string	kInvalid_FileName

Detailed Description

PHFieldConfigv1 implements field configuration information for input a field map file.

Definition at line 23 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 23 of file PHFieldConfigv1.h

Constructor & Destructor Documentation

PHFieldConfigv1::PHFieldConfigv1	(	FieldConfigTypes	field_config,
		const std::string &	filename,
		double	magfield_rescale = `1.`
	)

Definition at line 15 of file PHFieldConfigv1.cc.

View newest version in sPHENIX GitHub at line 15 of file PHFieldConfigv1.cc

PHFieldConfigv1::PHFieldConfigv1 ( )

inline

default constructor for ROOT file IO

Definition at line 32 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 32 of file PHFieldConfigv1.h

Referenced by CloneMe().

Here is the caller graph for this function:

PHFieldConfigv1::~PHFieldConfigv1 ( )

inlineoverride

Definition at line 37 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 37 of file PHFieldConfigv1.h

Member Function Documentation

PHObject* PHFieldConfigv1::CloneMe ( ) const

inlineoverridevirtual

Virtual copy constructor.

Reimplemented from PHObject.

Definition at line 40 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 40 of file PHFieldConfigv1.h

References PHFieldConfigv1().

Here is the call graph for this function:

FieldConfigTypes PHFieldConfigv1::get_field_config ( ) const

inlineoverridevirtual

Reimplemented from PHFieldConfig.

Definition at line 55 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 55 of file PHFieldConfigv1.h

References field_config_.

const std::string& PHFieldConfigv1::get_filename ( ) const

inlineoverridevirtual

Reimplemented from PHFieldConfig.

Definition at line 64 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 64 of file PHFieldConfigv1.h

References filename_.

Referenced by identify().

Here is the caller graph for this function:

double PHFieldConfigv1::get_magfield_rescale ( ) const

inlineoverridevirtual

Reimplemented from PHFieldConfig.

Definition at line 74 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 74 of file PHFieldConfigv1.h

References magfield_rescale_.

Referenced by identify().

Here is the caller graph for this function:

void PHFieldConfigv1::identify ( std::ostream & os = std::cout ) const

overridevirtual

identify Function from PHObject

Parameters

os	Output Stream

Reimplemented from PHFieldConfig.

Definition at line 27 of file PHFieldConfigv1.cc.

View newest version in sPHENIX GitHub at line 27 of file PHFieldConfigv1.cc

References PHFieldConfig::get_field_config_description(), get_filename(), get_magfield_rescale(), and isValid().

Here is the call graph for this function:

int PHFieldConfigv1::isValid ( ) const

overridevirtual

isValid returns non zero if object contains vailid data

isValid returns non zero if object contains valid data

Reimplemented from PHObject.

Definition at line 44 of file PHFieldConfigv1.cc.

View newest version in sPHENIX GitHub at line 44 of file PHFieldConfigv1.cc

References filename_.

Referenced by identify().

Here is the caller graph for this function:

void PHFieldConfigv1::Reset ( )

inlineoverridevirtual

Clear Content.

Reimplemented from PHObject.

Definition at line 49 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 49 of file PHFieldConfigv1.h

void PHFieldConfigv1::set_field_config ( FieldConfigTypes fieldConfig )

inlineoverridevirtual

Reimplemented from PHFieldConfig.

Definition at line 59 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 59 of file PHFieldConfigv1.h

References field_config_.

void PHFieldConfigv1::set_filename ( const std::string & filename )

inlineoverridevirtual

Reimplemented from PHFieldConfig.

Definition at line 69 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 69 of file PHFieldConfigv1.h

References INPUTHEPMC::filename, and filename_.

void PHFieldConfigv1::set_magfield_rescale ( double magfieldRescale )

inlineoverridevirtual

Reimplemented from PHFieldConfig.

Definition at line 79 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 79 of file PHFieldConfigv1.h

References magfield_rescale_.

Member Data Documentation

FieldConfigTypes PHFieldConfigv1::field_config_

protected

Definition at line 85 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 85 of file PHFieldConfigv1.h

Referenced by get_field_config(), and set_field_config().

std::string PHFieldConfigv1::filename_

protected

Definition at line 86 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 86 of file PHFieldConfigv1.h

Referenced by get_filename(), isValid(), and set_filename().

double PHFieldConfigv1::magfield_rescale_

protected

Definition at line 87 of file PHFieldConfigv1.h.

View newest version in sPHENIX GitHub at line 87 of file PHFieldConfigv1.h

Referenced by get_magfield_rescale(), and set_magfield_rescale().

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

fun4all_coresoftware/blob/master/offline/packages/PHField/PHFieldConfigv1.h
fun4all_coresoftware/blob/master/offline/packages/PHField/PHFieldConfigv1.cc

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation