celeritas::AuxParamsInterface Class Reference

Base class for extensible shared data that has associated state. More...

#include <AuxInterface.hh>

Inheritance diagram for celeritas::AuxParamsInterface:

Type aliases
using	UPState = std::unique_ptr< AuxStateInterface >
	Default destructor.
virtual	~AuxParamsInterface ()
	Default destructor.
virtual AuxId	aux_id () const =0
	Index of this class instance in its registry.
virtual std::string_view	label () const =0
	Label for the auxiliary data.
virtual UPState	create_state (MemSpace, StreamId, size_type size) const =0
	Factory function for building multithread state for a stream.
	AuxParamsInterface ()=default
	CELER_DEFAULT_COPY_MOVE (AuxParamsInterface)
	Default destructor.

Detailed Description

Base class for extensible shared data that has associated state.

Auxiliary data can be added to a AuxParamsInterface at runtime to be passed among multiple classes, and then dynamic_cast to the expected type. It needs to supply a factory function for creating the a state instance for multithreaded data on a particular stream and a given memory space. Classes can inherit both from AuxParamsInterface and other ActionInterface classes.

Constructor & Destructor Documentation

AuxParamsInterface()

celeritas::AuxParamsInterface::AuxParamsInterface ( )

protecteddefault

Allow construction and assignment only through daughter classes

Member Function Documentation

aux_id()

virtual AuxId celeritas::AuxParamsInterface::aux_id ( ) const

pure virtual

Index of this class instance in its registry.

Implemented in celeritas::optical::GeneratorBase, celeritas::OffloadGatherAction, celeritas::ExtendFromPrimariesAction, celeritas::StatusChecker, celeritas::SlotDiagnostic, celeritas::test::DummyParams, and celeritas::test::AuxMockParams.

create_state()

virtual UPState celeritas::AuxParamsInterface::create_state ( MemSpace  , StreamId  , size_type  size  ) const

pure virtual

Factory function for building multithread state for a stream.

Implemented in celeritas::ExtendFromPrimariesAction, celeritas::StatusChecker, celeritas::SlotDiagnostic, celeritas::test::DummyParams, celeritas::optical::GeneratorAction, celeritas::OffloadGatherAction, celeritas::optical::PrimaryGeneratorAction, and celeritas::test::AuxMockParams.

label()

virtual std::string_view celeritas::AuxParamsInterface::label ( ) const

pure virtual

Label for the auxiliary data.

Implemented in celeritas::optical::GeneratorBase, celeritas::OffloadGatherAction, celeritas::ExtendFromPrimariesAction, celeritas::StatusChecker, celeritas::SlotDiagnostic, celeritas::test::DummyParams, and celeritas::test::AuxMockParams.

---

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

• AuxInterface.hh
• AuxInterface.cc