Length3Vec Class Reference

#include <DLG4Units.hh>

Collaboration diagram for Length3Vec:

Public Member Functions
	Length3Vec ()
	Length3Vec (const Length3Vec &other)
	Length3Vec (Length3Vec &&other) noexcept
Length3Vec &	operator= (const Length3Vec &other)
Length3Vec &	operator= (Length3Vec &&other) noexcept
	Length3Vec (double x, double y, double z, const Length &u)
	Length3Vec (const G4ThreeVector &v, const Length &u)
Length	x () const
Length	y () const
Length	z () const
void	x (const Length &val)
void	y (const Length &val)
void	z (const Length &val)
	Length3Vec (const Length &x, const Length &y, const Length &z)
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
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 3 vector that is scalable with/to Units.

Definition at line 430 of file DLG4Units.hh.

Constructor & Destructor Documentation

Length3Vec() [1/6]

Length3Vec ( )

inline

Definition at line 467 of file DLG4Units.hh.

            : Native{*this} {
        }

Length3Vec() [2/6]

Length3Vec ( const Length3Vec &  other )

inline

Definition at line 472 of file DLG4Units.hh.

            : UnitBase(other),
              Native{*this},
              InUnits{*this},
              default_length_(other.default_length_) {
        }

Length3Vec() [3/6]

Length3Vec ( Length3Vec &&  other )

inlinenoexcept

Definition at line 480 of file DLG4Units.hh.

            : UnitBase(std::move(other)),
              Native{*this},
              InUnits{*this},
              default_length_(std::move(other.default_length_)) {
        }

Length3Vec() [4/6]

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

inline

Definition at line 505 of file DLG4Units.hh.

                                                                  {
            u.CheckUnit("Length3Vec(x,y,z,u)");
            NativeValue_ = G4ThreeVector(x, y, z) * u.NativeValue_.value();
        }

Length3Vec() [5/6]

Length3Vec ( const G4ThreeVector &  v, const Length &  u  )

inline

Definition at line 510 of file DLG4Units.hh.

                                                            {
            u.CheckUnit("Length3Vec(x,y,z,u)");
            NativeValue_ = v * u.NativeValue_.value();
        }

Length3Vec() [6/6]

Length3Vec ( const Length &  x, const Length &  y, const Length &  z  )

inline

Definition at line 551 of file DLG4Units.hh.

                                                                      {
            x.CheckValue("Length3Vec");
            y.CheckValue("Length3Vec");
            z.CheckValue("Length3Vec");
            NativeValue_ = G4ThreeVector(x.NativeValue_.value(), y.NativeValue_.value(), z.NativeValue_.value());
        }

Member Function Documentation

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 )

inlinestatic

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=() [1/2]

Length3Vec & operator= ( const Length3Vec &  other )

inline

Definition at line 488 of file DLG4Units.hh.

                                                       {
            if (this != &other) {
                UnitBase::operator=(other); // Safely copies the unified base NativeValue_
                this->default_length_ = other.default_length_;
            }
            return *this;
        }

operator=() [2/2]

Length3Vec & operator= ( Length3Vec &&  other )

inlinenoexcept

Definition at line 497 of file DLG4Units.hh.

                                                           {
            if (this != &other) {
                UnitBase::operator=(std::move(other)); // Safely moves the unified base NativeValue_
                this->default_length_ = std::move(other.default_length_);
            }
            return *this;
        }

x() [1/2]

Length x ( ) const

inline

Definition at line 521 of file DLG4Units.hh.

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

x() [2/2]

void x ( const Length &  val )

inline

Definition at line 536 of file DLG4Units.hh.

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

y() [1/2]

Length y ( ) const

inline

Definition at line 526 of file DLG4Units.hh.

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

y() [2/2]

void y ( const Length &  val )

inline

Definition at line 541 of file DLG4Units.hh.

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

z() [1/2]

Length z ( ) const

inline

Definition at line 531 of file DLG4Units.hh.

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

z() [2/2]

void z ( const Length &  val )

inline

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}

protected

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}

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}

Definition at line 463 of file DLG4Units.hh.

{*this};

NativeValue_

std::optional<G4ThreeVector > NativeValue_

protectedinherited

Definition at line 98 of file DLG4Units.hh.

---

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

• include/DLG4Units.hh