Builder Copiers

Functions
DerivedPtr	ForkForPlacement (std::optional< int > copy_no=std::nullopt, const G4String &name_override="")
DerivedPtr	ForkForLogicalVolume (const G4String &new_name)
DerivedPtr	ForkAndReset (const G4String &new_name) const
DerivedPtr	ForkForFinalSolid (const G4String &new_name)
DerivedPtr	ForkForLogicalVolume (const G4String &new_name)
DerivedPtr	ForkForPlacement (std::optional< int > copy_no=std::nullopt, const G4String &name_override="", bool parent_name_was_set=false)

Detailed Description

Copy Builders from various build steps.

These allow you to base placement builders on previously constructed solids etc.

Function Documentation

ForkAndReset()

template<typename U >

VolumeBuilderBase< U >::DerivedPtr ForkAndReset

(

const G4String &

new_name

)

const

Copy a configured/unbuilt Builder, with a new name.

This is the most generic all-purpose copier, but can result in some duplication of constituent solids, etc.

Copies all configurations. You can modify and rebuild all products. Copying-Transformations are not remembered. Base implementation is in VolumeBuilder, but can be overridden for Solid-Builder specific needs.

Parameters

new_name

Returns

Definition at line 656 of file VolumeBuilderBase.hpp.

                                                             {
        NoNameCheck(new_name, "CopySolidBuilder");
        DerivedPtr copy = this->Clone();
        copy->SetName(new_name); // Set base name for derived class
        copy->SetBooleanName("");
        return copy;
    }

ForkForFinalSolid()

template<typename U >

VolumeBuilderBase< U >::DerivedPtr ForkForFinalSolid

(

const G4String &

new_name

)

Calls MakeSolid() and copies builder with products cleared for further construction.

Configurations from ALL stages (including later) are kept.

Parameters

new_name

The base name for the new builder's Geant products.

Returns

A shared pointer to the new builder instance.

Definition at line 665 of file VolumeBuilderBase.hpp.

                                                            {
        NoNameCheck(new_name, "ForkForFinalSolid");
        if (!solid_ptr_) {
            MakeSolid();
        }
        DerivedPtr copy = this->Clone();
        copy->SetName(new_name); // Set base name for derived class
        copy->SetBooleanName("");
        // all products are cleared by default, (re)build up to Solid
        copy->solid_ptr_.Link(this->solid_ptr_);
        return copy;
    }

ForkForLogicalVolume() [1/2]

template<typename U >

DerivedPtr ForkForLogicalVolume

(

const G4String &

new_name

)

Makes final solid (including booleans) if unbuilt and copies builder with products cleared for further construction.

Configurations from ALL stages (including later) are kept.

This one seems pretty specific, but could be useful for extending a boolean build more easily possibly

Parameters

new_name

The base name for the new builder's logical and physical volumes.

Returns

A shared pointer to the new builder instance.

ForkForLogicalVolume() [2/2]

template<typename U >

VolumeBuilderBase< U >::DerivedPtr ForkForLogicalVolume

(

const G4String &

new_name

)

Makes final solid (including booleans) if unbuilt and copies builder with products cleared for further construction.

Configurations from ALL stages (including later) are kept.

This one seems pretty specific, but could be useful for extending a boolean build more easily possibly

Parameters

new_name

The base name for the new builder's logical and physical volumes.

Returns

A shared pointer to the new builder instance.

Definition at line 679 of file VolumeBuilderBase.hpp.

                                                               {
        NoNameCheck(new_name, "ForkForLogicalVolume");
        if (!final_solid_ptr_ && placement_configs_->is_builder) {
            [[maybe_unused]] auto discard = GetFinalSolid();
        }
        DerivedPtr copy = this->Clone();
        copy->SetName(new_name); // Set base name for derived class
        copy->SetBooleanName("");
        // all products are cleared by default, (re)build up to Solid
        if (solid_ptr_ && placement_configs_->is_builder) {
            copy->solid_ptr_.Link(this->solid_ptr_);
        }
        if (final_solid_ptr_ && placement_configs_->is_builder) {
            copy->final_solid_ptr_.Link(this->final_solid_ptr_);
        }
        return copy;
    }

ForkForPlacement() [1/2]

template<typename U >

DerivedPtr ForkForPlacement	(	std::optional< int >	copy_no = std::nullopt,
		const G4String &	name_override = ""
	)

Calls MakeLogicalVolume() and creates a new builder instance with a copy of all placement-related configs.

This will be called automatically by consecutive calls to MakePlacement(). All physical volume and (future?) derived products are reset to be rebuilt. Copy_no and placement name can be auto incremented (number only by default) or overridden.

The copy_no will be incremented.

Parameters

copy_no	no arguments or std::nullopt to leave as auto. Must set on every use to get manual numbering.
name_override	An optional name override for the physical volume. Leave blank to use auto controls instead.

Returns

A shared pointer to the new builder instance.

ForkForPlacement() [2/2]

template<typename U >

VolumeBuilderBase< U >::DerivedPtr ForkForPlacement	(	std::optional< int >	copy_no = std::nullopt,
		const G4String &	name_override = "",
		bool	parent_name_was_set = false
	)

Calls MakeLogicalVolume() and creates a new builder instance with a copy of all placement-related configs.

This will be called automatically by consecutive calls to MakePlacement(). All physical volume and (future?) derived products are reset to be rebuilt. Copy_no and placement name can be auto incremented (number only by default) or overridden.

The copy_no will be incremented.

Parameters

copy_no	no arguments or std::nullopt to leave as auto. Must set on every use to get manual numbering.
name_override	An optional name override for the physical volume. Leave blank to use auto controls instead.

Returns

A shared pointer to the new builder instance.

Definition at line 698 of file VolumeBuilderBase.hpp.

                                                                 {
        // really a clone of logical volume:
        if (!logicvol_ptr_ && placement_configs_->is_builder) {
            MakeLogicalVolume();
        }
        DerivedPtr copy = this->Clone();
        copy->explicit_copyno_set_ = static_cast<bool>(copy_no);
        copy->explicit_physical_copy_name_set_ = !name_override.empty() || parent_name_was_set;
        copy->placement_name_override_ = name_override;
        // register name and get provisional copy_no:
        copy->placement_configs_->copy_no = PlacementNameRegistry::IncrementNameCount(
            GetPlacementBaseName());
        //Override if copy_no was passed:
        copy->placement_configs_->copy_no = copy_no.value_or(copy->placement_configs_->copy_no);
 
        // Restore logical_volume pointer and below
        copy->solid_ptr_.Link(this->solid_ptr_);
        copy->final_solid_ptr_.Link(this->final_solid_ptr_);
        copy->logicvol_ptr_.Link(this->logicvol_ptr_);
 
        return copy;
    }