Units

Functions
DerivedPtr	SetDefaultUnit (G4double unit)
DerivedPtr	SetDefaultUnit (G4double unit)
G4double	GetEffectiveDefaultUnit () const
void	SetGlobalDefaultUnit (G4double unit)

Detailed Description

Methods to set units used in geometry methods.

Methods are available for both VolumeBuilder and StructureBuilder (ie builders and assemblies).

Function Documentation

GetEffectiveDefaultUnit()

template<typename U >

G4double GetEffectiveDefaultUnit

(

)

const

Get the builder default unit or global if not set.

Returns

The active default unit.

Definition at line 908 of file VolumeBuilder.hpp.

                                                 {
        auto temp = builder_configs_.get();
        auto local = temp->default_unit;
        //        auto local = builder_configs_->default_unit;
        auto global = BuilderConfigs::global_default_unit;
        G4double default_unit = local.value_or(global);
        return default_unit;
    }

SetDefaultUnit() [1/2]

template<typename U >

DerivedPtr SetDefaultUnit

(

G4double

unit

)

Set the per-Structure default unit for all later non-factory offsets.

Use DLG4::VolumeBuilders::SetGlobalDefaultUnit() to set a default for all builders, or fall back to the initial default of CLHEP::mm.

• May not apply to values set before this is called.
  
• Does not apply to factory units like CreateCenteredBoxBuilder();
  But should not be set and changed. Just use it once, early.
  

  Parameters

  unit	The unit to set, ex: CLHEP::mm

  Returns

  The builder (allows chaining)

SetDefaultUnit() [2/2]

template<typename U >

VolumeBuilder< U >::DerivedPtr SetDefaultUnit

(

G4double

unit

)

Set the per-Builder default unit for all later non-factory offsets.

Use DLG4::VolumeBuilders::SetGlobalDefaultUnit() to set a default for all builders, or fall back to the initial default of CLHEP::mm.

• May not apply to values set before this is called.
  
• Does not apply to factory units like CreateCenteredBoxBuilder();
  But should not be set and changed. Just use it once, early.
  

  Parameters

  unit	The unit to set, ex: CLHEP::mm

  Returns

  The builder (allows chaining)

Definition at line 902 of file VolumeBuilder.hpp.

                                              {
        this->builder_configs_->default_unit = unit;
        return this->shared_from_this();
    }

SetGlobalDefaultUnit()

void SetGlobalDefaultUnit ( G4double  unit )

inline

Set the default unit for all VolumeBuilder methods.

Definition at line 58 of file VolumeBuilderConfigs.hh.

                                                    {
        BuilderConfigs::global_default_unit = unit;
    }