Celeritas 0.7+b3eeee4
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
celeritas::UniqueVolumeToString Class Reference

Convert a unique volume instance ID to a slash-separated instance path. More...

#include <UniqueVolumeToString.hh>

Public Types

Type aliases
using SPVolumeParams = std::shared_ptr< VolumeParams const >
 

Public Member Functions

 UniqueVolumeToString (SPVolumeParams vols)
 Construct with shared volume metadata.
 
std::string operator() (VolumeUniqueInstanceId uid)
 Unfold to a string.
 

Static Public Member Functions

static UniqueVolumeToString from_ref (VolumeParams const &)
 Construct with non-owning shared pointer.
 

Detailed Description

Convert a unique volume instance ID to a slash-separated instance path.

The value nullid, which corresponds to "outside", returns an empty string. All other strings are slash-separated labels starting with the world instance.

Member Function Documentation

◆ from_ref()

UniqueVolumeToString celeritas::UniqueVolumeToString::from_ref ( VolumeParams const vols)
static

Construct with non-owning shared pointer.

This convenience function is for the case when shared pointers are unavailable (unit testing, non-persistent usage).


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