Unit3Vec Class Reference

#include <DLG4Units.hh>

Collaboration diagram for Unit3Vec:

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

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

Detailed Description

A 3 vector that is scalable with/to Units.

Definition at line 452 of file DLG4Units.hh.

Constructor & Destructor Documentation

Unit3Vec() [1/5]

Unit3Vec ( )

default

Unit3Vec() [2/5]

Unit3Vec ( const Unit3Vec &  other )

inline

Definition at line 456 of file DLG4Units.hh.

            : NativeVec_(other.NativeVec_),
              default_length_(other.default_length_) {
        }

Unit3Vec() [3/5]

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

inline

Definition at line 471 of file DLG4Units.hh.

                                                                {
            NativeVec_ = G4ThreeVector(x, y, z) * u.Native;
        }

Unit3Vec() [4/5]

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

inline

Definition at line 475 of file DLG4Units.hh.

                                                          {
            NativeVec_ = v * u.Native;
        }

Unit3Vec() [5/5]

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

inline

Definition at line 492 of file DLG4Units.hh.

                                                                    {
            NativeVec_ = G4ThreeVector(x.Native, y.Native, z.Native);
        }

Member Function Documentation

FromNative()

Unit3Vec FromNative ( const G4ThreeVector &  v )

inline

Definition at line 479 of file DLG4Units.hh.

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

InUnits() [1/2]

G4ThreeVector InUnits ( ) const

inline

Definition at line 496 of file DLG4Units.hh.

{ return InUnits(default_length_); }

InUnits() [2/2]

G4ThreeVector InUnits ( const Length &  u ) const

inline

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

inline

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=()

Unit3Vec & operator= ( const Unit3Vec &  other )

inline

Definition at line 463 of file DLG4Units.hh.

                                                   {
            if (this != &other) {
                NativeVec_ = other.NativeVec_;
                default_length_ = other.default_length_;
            }
            return *this;
        }

x() [1/2]

Length x ( ) const

inline

Definition at line 484 of file DLG4Units.hh.

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

x() [2/2]

void x ( const Length &  val )

inline

Definition at line 488 of file DLG4Units.hh.

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

y() [1/2]

Length y ( ) const

inline

Definition at line 485 of file DLG4Units.hh.

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

y() [2/2]

void y ( const Length &  val )

inline

Definition at line 489 of file DLG4Units.hh.

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

z() [1/2]

Length z ( ) const

inline

Definition at line 486 of file DLG4Units.hh.

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

z() [2/2]

void z ( const Length &  val )

inline

Definition at line 490 of file DLG4Units.hh.

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

Member Data Documentation

default_length_

Length default_length_

protected

Definition at line 517 of file DLG4Units.hh.

NativeVec_

std::optional<G4ThreeVector> NativeVec_

protected

Definition at line 516 of file DLG4Units.hh.

---

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

• include/DLG4Units.hh