celeritas::OutputInterface Class Reference

Pure abstract interface for writing metadata output to JSON. More...

#include <OutputInterface.hh>

Inheritance diagram for celeritas::OutputInterface:

Public Types
enum class	Category {   input , result , system , internal ,   size_ }
	Output category (TODO: could replace with string/cstring?)

Public Member Functions
virtual Category	category () const =0
	Category of data to write.
virtual std::string_view	label () const =0
	Key for the entry inside the category.
virtual void	output (JsonPimpl *) const =0

Detailed Description

Pure abstract interface for writing metadata output to JSON.

At the end of the program/run, the OutputRegistry will call the "output" method on all interfaces.

Todo:

Perhaps another output method for saving a schema?

Member Function Documentation

category()

virtual Category celeritas::OutputInterface::category ( ) const

pure virtual

Category of data to write.

Implemented in celeritas::GeantSimpleCalo, celeritas::GeantStepDiagnostic, celeritas::MaterialParamsOutput, celeritas::ParticleParamsOutput, celeritas::PhysicsParamsOutput, celeritas::ActionDiagnostic, celeritas::SimpleCalo, celeritas::StepDiagnostic, celeritas::BuildOutput, celeritas::ExceptionOutput, celeritas::OutputInterfaceAdapter< T >, celeritas::ActionRegistryOutput, celeritas::GeoParamsOutput, celeritas::VecgeomParamsOutput, and celeritas::OrangeParamsOutput.

label()

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

pure virtual

Key for the entry inside the category.

Implemented in celeritas::GeantSimpleCalo, celeritas::GeantStepDiagnostic, celeritas::MaterialParamsOutput, celeritas::ParticleParamsOutput, celeritas::PhysicsParamsOutput, celeritas::ActionDiagnostic, celeritas::SimpleCalo, celeritas::StepDiagnostic, celeritas::BuildOutput, celeritas::ExceptionOutput, celeritas::OutputInterfaceAdapter< T >, celeritas::ActionRegistryOutput, celeritas::GeoParamsOutput, celeritas::VecgeomParamsOutput, and celeritas::OrangeParamsOutput.

output()

virtual void celeritas::OutputInterface::output ( JsonPimpl *  ) const

pure virtual

Implemented in celeritas::GeantSimpleCalo, celeritas::GeantStepDiagnostic, celeritas::MaterialParamsOutput, celeritas::ParticleParamsOutput, celeritas::PhysicsParamsOutput, celeritas::ActionDiagnostic, celeritas::SimpleCalo, celeritas::StepDiagnostic, celeritas::BuildOutput, celeritas::ExceptionOutput, celeritas::ActionRegistryOutput, celeritas::GeoParamsOutput, celeritas::VecgeomParamsOutput, celeritas::OrangeParamsOutput, and celeritas::OutputInterfaceAdapter< T >.

---

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

• OutputInterface.hh