ThreeVecDimensioner Class Reference

#include <VolumeBuildersUnitTypes.hh>

Collaboration diagram for ThreeVecDimensioner:

Public Member Functions
	ThreeVecDimensioner ()=default
	ThreeVecDimensioner (const ThreeVecDimensioner &)=delete
ThreeVecDimensioner &	operator= (const ThreeVecDimensioner &)=delete
	ThreeVecDimensioner (Unit3Vec v)
	ThreeVecDimensioner (G4ThreeVector v, const Length &u)
	ThreeVecDimensioner (double x, double y, double z, const Length &u)
	ThreeVecDimensioner (double x, double y, double z)
	ThreeVecDimensioner (G4ThreeVector v)
G4ThreeVector	apply_units (const Length dflt_unit) const
Unit3Vec	FromNative (const G4ThreeVector &v)
Length	x () const
void	x (const Length &val)
Length	y () const
void	y (const Length &val)
Length	z () const
void	z (const Length &val)
G4ThreeVector	InUnits () const
G4ThreeVector	InUnits (const Length &u) const
G4ThreeVector	Native () const

Public Attributes
double	x
double	y
double	z

Protected Attributes
std::optional< G4ThreeVector >	NativeVec_
Length	default_length_

Detailed Description

A 3D vector that manages unit policy for parameter passing If constructed with a unit, that's it.

If not the user has implicitly requested use of the receiver's units. The receiver is expected to call apply_unit(default) to get the reconciled result.

Stores unit, x, y, z as separate values.

Definition at line 34 of file VolumeBuildersUnitTypes.hh.

Constructor & Destructor Documentation

ThreeVecDimensioner() [1/7]

ThreeVecDimensioner ( )

default

ThreeVecDimensioner() [2/7]

ThreeVecDimensioner ( const ThreeVecDimensioner &  )

delete

ThreeVecDimensioner() [3/7]

ThreeVecDimensioner ( Unit3Vec  v )

inline

Definition at line 43 of file VolumeBuildersUnitTypes.hh.

            : Unit3Vec(v) { Sync(); }

ThreeVecDimensioner() [4/7]

ThreeVecDimensioner ( G4ThreeVector  v, const Length &  u  )

inline

Definition at line 46 of file VolumeBuildersUnitTypes.hh.

            : Unit3Vec(v, u) { Sync(); }

ThreeVecDimensioner() [5/7]

ThreeVecDimensioner ( double  x, double  y, double  z, const Length &  u  )

inline

Definition at line 49 of file VolumeBuildersUnitTypes.hh.

            : Unit3Vec(x, y, z, u) { Sync(); }

ThreeVecDimensioner() [6/7]

ThreeVecDimensioner ( double  x, double  y, double  z  )

inline

Definition at line 52 of file VolumeBuildersUnitTypes.hh.

                                                          {
            NativeVec_ = G4ThreeVector(x, y, z);
            is_dimensioned_ = false;
            Sync();
        }

ThreeVecDimensioner() [7/7]

ThreeVecDimensioner ( G4ThreeVector  v )

inline

Definition at line 58 of file VolumeBuildersUnitTypes.hh.

            : ThreeVecDimensioner(v.x(), v.y(), v.z()) {
        }

Member Function Documentation

apply_units()

G4ThreeVector apply_units ( const Length  dflt_unit ) const

inline

Definition at line 62 of file VolumeBuildersUnitTypes.hh.

                                                                              {
            auto vec = G4ThreeVector(x, y, z);
            if (!is_dimensioned_) {
                vec *= dflt_unit.Native();
            }
            return vec;
        }

FromNative()

Unit3Vec FromNative ( const G4ThreeVector &  v )

inlineinherited

Definition at line 479 of file DLG4Units.hh.

                                                    {
            return Unit3Vec(v, Length::native);
        }

InUnits() [1/2]

G4ThreeVector InUnits ( ) const

inlineinherited

Definition at line 496 of file DLG4Units.hh.

{ return InUnits(default_length_); }

InUnits() [2/2]

G4ThreeVector InUnits ( const Length &  u ) const

inlineinherited

Definition at line 498 of file DLG4Units.hh.

                                                     {
            if (!NativeVec_.has_value()) {
                G4Exception("Unit3Vec::InUnits", "Uninitialized", FatalException,
                        "Attempted to read Unit3Vec before setting it.");
            }
            return (*NativeVec_) / u.Native;
        }

Native()

G4ThreeVector Native ( ) const

inlineinherited

Definition at line 507 of file DLG4Units.hh.

                                     {
            if (!NativeVec_.has_value()) {
                G4Exception("Unit3Vec::GetRaw", "Uninitialized", FatalException,
                        "Attempted to read Unit3Vec before setting it.");
            }
            return *NativeVec_;
        }

operator=()

ThreeVecDimensioner & operator= ( const ThreeVecDimensioner &  )

delete

x() [1/2]

Length x ( ) const

inlineinherited

Definition at line 484 of file DLG4Units.hh.

{ return Length::FromNative(Native().x()); }

x() [2/2]

void x ( const Length &  val )

inlineinherited

Definition at line 488 of file DLG4Units.hh.

{ EnsureInternalVec().setX(val.Native); }

y() [1/2]

Length y ( ) const

inlineinherited

Definition at line 485 of file DLG4Units.hh.

{ return Length::FromNative(Native().y()); }

y() [2/2]

void y ( const Length &  val )

inlineinherited

Definition at line 489 of file DLG4Units.hh.

{ EnsureInternalVec().setY(val.Native); }

z() [1/2]

Length z ( ) const

inlineinherited

Definition at line 486 of file DLG4Units.hh.

{ return Length::FromNative(Native().z()); }

z() [2/2]

void z ( const Length &  val )

inlineinherited

Definition at line 490 of file DLG4Units.hh.

{ EnsureInternalVec().setZ(val.Native); }

Member Data Documentation

default_length_

Length default_length_

protectedinherited

Definition at line 517 of file DLG4Units.hh.

NativeVec_

std::optional<G4ThreeVector> NativeVec_

protectedinherited

Definition at line 516 of file DLG4Units.hh.

x

double x

Definition at line 36 of file VolumeBuildersUnitTypes.hh.

y

double y

Definition at line 36 of file VolumeBuildersUnitTypes.hh.

z

double z

Definition at line 36 of file VolumeBuildersUnitTypes.hh.

---

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

• include/VolumeBuildersUnitTypes.hh