Internal data class shared by all handles of a given type. More...

#include <Fields.h>

Inheritance diagram for dd4hep::CartesianField::Object:

Public Types
typedef std::vector< double >	Coefficents
	Utility definition for concrete implementations. More...

Public Member Functions
	Object ()
	Default constructor. More...

virtual	~Object ()
	Default destructor. More...

virtual void	fieldComponents (const double pos, double field)=0

Public Member Functions inherited from dd4hep::CartesianField::TypedObject
	NamedObject (const char nam, const char typ="")
	Default constructor. More...

	NamedObject (const std::string &nam)
	Default constructor. More...

	NamedObject (const std::string &nam, const std::string &typ)
	Default constructor. More...

	NamedObject ()=default
	Default constructor. More...

	NamedObject (const NamedObject &c)=default
	Default constructor. More...

	NamedObject (NamedObject &&c)=default
	Default constructor. More...

Public Member Functions inherited from dd4hep::NamedObject
	NamedObject (const char nam, const char typ="")
	Initializing constructor. More...

	NamedObject (const std::string &nam)
	Initializing constructor. More...

	NamedObject (const std::string &nam, const std::string &typ)
	Initializing constructor. More...

	NamedObject ()=default
	Standard constructor. More...

	NamedObject (const NamedObject &c)=default
	Copy constructor. More...

	NamedObject (NamedObject &&c)=default
	Move constructor. More...

virtual	~NamedObject ()=default
	Default destructor. More...

NamedObject &	operator= (const NamedObject &c)=default
	Assignment operator. More...

NamedObject &	operator= (NamedObject &&c)=default
	Move assignment operator. More...

const char *	GetName () const
	Access name. More...

void	SetName (const char *nam)
	Set name (used by Handle) More...

void	SetTitle (const char *tit)
	Set Title (used by Handle) More...

const char *	GetTitle () const
	Get name (used by Handle) More...

Public Attributes
Properties	properties
	Field extensions. More...

Public Attributes inherited from dd4hep::CartesianField::TypedObject
int	field_type { UNKNOWN }
	Field type. More...

Public Attributes inherited from dd4hep::NamedObject
std::string	name
	The object name. More...

std::string	type
	The object type. More...

Detailed Description

Internal data class shared by all handles of a given type.

Author: M.Frank

Version: 1.0

Definition at line 67 of file Fields.h.

Member Typedef Documentation

◆ Coefficents

typedef std::vector<double> dd4hep::CartesianField::Object::Coefficents

Utility definition for concrete implementations.

Definition at line 70 of file Fields.h.

Constructor & Destructor Documentation

◆ Object()

CartesianField::Object::Object ( )

Default constructor.

Definition at line 34 of file Fields.cpp.

◆ ~Object()

CartesianField::Object::~Object ( )

virtual

Default destructor.

Definition at line 41 of file Fields.cpp.

Member Function Documentation

◆ fieldComponents()

virtual void dd4hep::CartesianField::Object::fieldComponents	(	const double *	pos,
		double *	field
	)

pure virtual

Overwrite to compute the field components at a given location - NB: The field components have to be added to the provided field vector in order to allow for superposition of the fields.

Implemented in dd4hep::MultipoleField, dd4hep::DipoleField, dd4hep::SolenoidField, and dd4hep::ConstantField.

Member Data Documentation

◆ properties

Properties dd4hep::CartesianField::Object::properties

Field extensions.

Definition at line 72 of file Fields.h.

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

DDCore/include/DD4hep/Fields.h
DDCore/src/Fields.cpp

Public Types

Public Member Functions

Public Attributes