celeritas::StaticConcreteAction Class Reference

Concrete mixin utility class for managing an action with static strings. More...

#include <ActionInterface.hh>

Inheritance diagram for celeritas::StaticConcreteAction:

Public Member Functions
	StaticConcreteAction (ActionId id, std::string_view label) noexcept(! 0)
	Construct a concrete action from a label and ID.
	StaticConcreteAction (ActionId id, std::string_view label, std::string_view description) noexcept(! 0)
	Construct a concrete action from an ID, a unique label, and a description.
	StaticConcreteAction (StaticConcreteAction const &)=delete
StaticConcreteAction &	operator= (StaticConcreteAction const &)=delete
	StaticConcreteAction (StaticConcreteAction &&)=delete
StaticConcreteAction &	operator= (StaticConcreteAction &&)=delete
ActionId	action_id () const final
	ID of this action for verification.
std::string_view	label () const final
	Short label.
std::string_view	description () const final
	Descriptive label.
Public Member Functions inherited from celeritas::ActionInterface
virtual	~ActionInterface () noexcept=0
	Default destructor.

Additional Inherited Members
Protected Member Functions inherited from celeritas::ActionInterface
	ActionInterface (ActionInterface const &)=default
ActionInterface &	operator= (ActionInterface const &)=default
	ActionInterface (ActionInterface &&)=default
ActionInterface &	operator= (ActionInterface &&)=default

Detailed Description

Concrete mixin utility class for managing an action with static strings.

This is a typical use case for "singleton" actions where a maximum of one can exist per stepping loop. The action ID still must be supplied at runtime.

Note

Use this class when the label and description are compile-time constants.

Member Function Documentation

action_id()

ActionId celeritas::StaticConcreteAction::action_id ( ) const

inlinefinalvirtual

ID of this action for verification.

Implements celeritas::ActionInterface.

description()

std::string_view celeritas::StaticConcreteAction::description ( ) const

inlinefinalvirtual

Descriptive label.

Implements celeritas::ActionInterface.

label()

std::string_view celeritas::StaticConcreteAction::label ( ) const

inlinefinalvirtual

Short label.

Implements celeritas::ActionInterface.

---

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

• corecel/sys/ActionInterface.hh
• ActionInterface.cc