celeritas/user/RootStepWriterInput.hh

0001 //------------------------------- -*- C++ -*- -------------------------------//
0002 // Copyright Celeritas contributors: see top-level COPYRIGHT file for details
0003 // SPDX-License-Identifier: (Apache-2.0 OR MIT)
0004 //---------------------------------------------------------------------------//
0005 //! \file celeritas/user/RootStepWriterInput.hh
0006 //---------------------------------------------------------------------------//
0007 #pragma once
0008
0009 #include <vector>
0010
0011 #include "corecel/Types.hh"
0012
0013 namespace celeritas
0014 {
0015 //---------------------------------------------------------------------------//
0016 /*!
0017  * Input options for filtering ROOT MC truth output.
0018  *
0019  * This is used an input to \c celeritas::RootStepWriter::make_write_filter .
0020  */
0021 struct SimpleRootFilterInput
0022 {
0023     static constexpr size_type unspecified{static_cast<size_type>(-1)};
0024
0025     std::vector<size_type> track_id;
0026     size_type event_id = unspecified;
0027     size_type parent_id = unspecified;
0028     size_type action_id = unspecified;
0029
0030     //! True if any filtering is being applied
0031     explicit operator bool() const
0032     {
0033         return !track_id.empty() || event_id != unspecified
0034                || parent_id != unspecified || action_id != unspecified;
0035     }
0036 };
0037
0038 //---------------------------------------------------------------------------//
0039 }  // namespace celeritas