Celeritas  0.5.0-56+6b053cd
Public Member Functions | List of all members
celeritas::StaticConcreteAction Class Reference

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

#include <ActionInterface.hh>

Inheritance diagram for celeritas::StaticConcreteAction:
Inheritance graph
[legend]

Public Member Functions

 StaticConcreteAction (ActionId id, std::string_view label) noexcept(!CELERITAS_DEBUG)
 Construct a concrete action from a label and ID.
 
 StaticConcreteAction (ActionId id, std::string_view label, std::string_view description) noexcept(!CELERITAS_DEBUG)
 Construct a concrete action from an ID, a unique label, and a description.
 
 CELER_DELETE_COPY_MOVE (StaticConcreteAction)
 
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 ()=default
 
 CELER_DEFAULT_COPY_MOVE (ActionInterface)
 

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.

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