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 (Length3Vec 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
Length	x () const
void	x (const Length &val)
Length	y () const
void	y (const Length &val)
Length	z () const
void	z (const Length &val)
void	CheckValue (const G4String &context) const
void	CheckUnit (const G4String &context) const

Static Public Member Functions
static Length3Vec	FromNative (const G4ThreeVector &v)
static Length3Vec	FromNative (G4ThreeVector native_value)
static Length3Vec	GetGlobalDefault ()

Public Attributes
double	x
double	y
double	z
NativeVectorProxy	Native {*this}
ScalableProxy< Length >	InUnits {*this}
DefaultUnitsProxy	InDefaultUnits

Static Public Attributes
static Length3Vec	native

Protected Attributes
Length	default_length_ {Length::native}
std::optional< G4ThreeVector >	NativeValue_

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 ( Length3Vec  v )

inline

Definition at line 43 of file VolumeBuildersUnitTypes.hh.

            : Length3Vec(v) { Sync(); }

ThreeVecDimensioner() [4/7]

ThreeVecDimensioner ( G4ThreeVector  v, const Length &  u  )

inline

Definition at line 46 of file VolumeBuildersUnitTypes.hh.

            : Length3Vec(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.

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

ThreeVecDimensioner() [6/7]

ThreeVecDimensioner ( double  x, double  y, double  z  )

inline

Definition at line 52 of file VolumeBuildersUnitTypes.hh.

                                                         : Length3Vec(x,y,z,DLG4::Units::Length::native) {
            is_dimensioned_ = false;
            Sync();
        }

ThreeVecDimensioner() [7/7]

ThreeVecDimensioner ( G4ThreeVector  v )

inline

Definition at line 57 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 61 of file VolumeBuildersUnitTypes.hh.

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

CheckUnit()

void CheckUnit ( const G4String &  context ) const

inlineinherited

Definition at line 271 of file DLG4Units.hh.

                                                      {
            CheckValue(context);
            if (!(NativeValue_ > 0.0)) {
                G4Exception(context, "InvalidScale", FatalException,
                        "\n Attempted to apply a negative Unit\n");
                exit(1);
            }
        }

CheckValue()

void CheckValue ( const G4String &  context ) const

inlineinherited

Definition at line 260 of file DLG4Units.hh.

                                                       {
            // volatile may help with debugging dangling references.
            volatile bool engagement_flag = NativeValue_.has_value();
            if (!engagement_flag) {
                //if (!NativeValue_.has_value()) {
                G4Exception(context, "InvalidScale", FatalException,
                        "\n Attempted to use a Unit (or measure) before setting it;\n");
                exit(1);
            }
        }

FromNative() [1/2]

static Length3Vec FromNative ( const G4ThreeVector &  v )

inlinestaticinherited

Definition at line 515 of file DLG4Units.hh.

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

FromNative() [2/2]

static Length3Vec FromNative ( G4ThreeVector  native_value )

inlinestaticinherited

Definition at line 232 of file DLG4Units.hh.

{ return T(native_value); }

GetGlobalDefault()

static Length3Vec GetGlobalDefault ( )

inlinestaticinherited

Definition at line 258 of file DLG4Units.hh.

{ return T(global_default_unit<T>); }

operator=()

ThreeVecDimensioner & operator= ( const ThreeVecDimensioner &  )

delete

x() [1/2]

Length x ( ) const

inlineinherited

Definition at line 521 of file DLG4Units.hh.

                         {
            CheckValue("Length3Vec");
            return Length::FromNative(NativeValue_.value().x());
        }

x() [2/2]

void x ( const Length &  val )

inlineinherited

Definition at line 536 of file DLG4Units.hh.

                                  {
            val.CheckValue("Length3Vec, x");
            EnsureInternalVec().setX(val.NativeValue_.value());
        }

y() [1/2]

Length y ( ) const

inlineinherited

Definition at line 526 of file DLG4Units.hh.

                         {
            CheckValue("Length3Vec");
            return Length::FromNative(NativeValue_.value().y());
        }

y() [2/2]

void y ( const Length &  val )

inlineinherited

Definition at line 541 of file DLG4Units.hh.

                                  {
            val.CheckValue("Length3Vec, x");
            EnsureInternalVec().setY(val.NativeValue_.value());
        }

z() [1/2]

Length z ( ) const

inlineinherited

Definition at line 531 of file DLG4Units.hh.

                         {
            CheckValue("Length3Vec");
            return Length::FromNative(NativeValue_.value().z());
        }

z() [2/2]

void z ( const Length &  val )

inlineinherited

Definition at line 546 of file DLG4Units.hh.

                                  {
            val.CheckValue("Length3Vec, x");
            EnsureInternalVec().setZ(val.NativeValue_.value());
        }

Member Data Documentation

default_length_

Length default_length_ {Length::native}

protectedinherited

Definition at line 559 of file DLG4Units.hh.

{Length::native};

InDefaultUnits

DefaultUnitsProxy InDefaultUnits

inherited

Definition at line 228 of file DLG4Units.hh.

{*this};

InUnits

ScalableProxy<Length> InUnits {*this}

inherited

Definition at line 465 of file DLG4Units.hh.

{*this};

native

Length3Vec native

inlinestaticinherited

Definition at line 231 of file DLG4Units.hh.

{1.0};

Native

NativeVectorProxy Native {*this}

inherited

Definition at line 463 of file DLG4Units.hh.

{*this};

NativeValue_

std::optional<G4ThreeVector > NativeValue_

protectedinherited

Definition at line 98 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