BDSModulatorInfo Class Reference

Holder class for all information required to describe a modulator. More...

#include <BDSModulatorInfo.hh>

Collaboration diagram for BDSModulatorInfo:

Public Member Functions
	BDSModulatorInfo ()=delete
	Deleted default constructor to ensure one of supplied constructors is used.
	BDSModulatorInfo (BDSModulatorType modulatorTypeIn, G4double frequencyIn, G4double phaseIn=0, G4double tOffsetIn=0, G4double scaleIn=1.0, G4double amplitudeOffsetIn=0, G4double T0In=0, G4double T1In=0)
	extra constructor to assign all members at once.

Data Fields
G4String	nameOfParserDefinition
BDSModulatorType	modulatorType
	Public member for direct access.
G4double	frequency
	Public member for direct access.
G4double	phase
	Public member for direct access.
G4double	tOffset
	Public member for direct access.
G4double	scale
	Public member for direct access.
G4double	amplitudeOffset
	Public member for direct access.
G4double	T0
	Public member for direct access.
G4double	T1
	Public member for direct access.

Friends
std::ostream &	operator<< (std::ostream &out, BDSModulatorInfo const &info)
	output stream

Detailed Description

Holder class for all information required to describe a modulator.

Author

Laurie Nevay

Definition at line 32 of file BDSModulatorInfo.hh.

Constructor & Destructor Documentation

BDSModulatorInfo()

BDSModulatorInfo::BDSModulatorInfo	(	BDSModulatorType	modulatorTypeIn,
		G4double	frequencyIn,
		G4double	phaseIn = 0,
		G4double	tOffsetIn = 0,
		G4double	scaleIn = 1.0,
		G4double	amplitudeOffsetIn = 0,
		G4double	T0In = 0,
		G4double	T1In = 0
	)

extra constructor to assign all members at once.

Definition at line 26 of file BDSModulatorInfo.cc.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  out, BDSModulatorInfo const &  info  )

friend

output stream

Definition at line 45 of file BDSModulatorInfo.cc.

Field Documentation

amplitudeOffset

G4double BDSModulatorInfo::amplitudeOffset

Public member for direct access.

Definition at line 58 of file BDSModulatorInfo.hh.

Referenced by BDSFieldFactory::CreateModulator().

frequency

G4double BDSModulatorInfo::frequency

Public member for direct access.

Definition at line 54 of file BDSModulatorInfo.hh.

Referenced by BDSFieldFactory::CreateModulator().

modulatorType

BDSModulatorType BDSModulatorInfo::modulatorType

Public member for direct access.

Definition at line 53 of file BDSModulatorInfo.hh.

Referenced by BDSFieldFactory::CreateModulator().

nameOfParserDefinition

G4String BDSModulatorInfo::nameOfParserDefinition

Definition at line 63 of file BDSModulatorInfo.hh.

phase

G4double BDSModulatorInfo::phase

Public member for direct access.

Definition at line 55 of file BDSModulatorInfo.hh.

Referenced by BDSFieldFactory::CreateModulator().

scale

G4double BDSModulatorInfo::scale

Public member for direct access.

Definition at line 57 of file BDSModulatorInfo.hh.

Referenced by BDSFieldFactory::CreateModulator().

T0

G4double BDSModulatorInfo::T0

Public member for direct access.

Definition at line 59 of file BDSModulatorInfo.hh.

Referenced by BDSFieldFactory::CreateModulator().

T1

G4double BDSModulatorInfo::T1

Public member for direct access.

Definition at line 60 of file BDSModulatorInfo.hh.

Referenced by BDSFieldFactory::CreateModulator().

tOffset

G4double BDSModulatorInfo::tOffset

Public member for direct access.

Definition at line 56 of file BDSModulatorInfo.hh.

---

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

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