Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/Control/Options/UserTable.hpp
       4                 :            :   \copyright 2012-2015 J. Bakosi,
       5                 :            :              2016-2018 Los Alamos National Security, LLC.,
       6                 :            :              2019-2021 Triad National Security, LLC.
       7                 :            :              All rights reserved. See the LICENSE file for details.
       8                 :            :   \brief     User-defined table (discrete y=f(x) function) options
       9                 :            :   \details   User-defined table (discrete y=f(x) function) options.
      10                 :            : */
      11                 :            : // *****************************************************************************
      12                 :            : #ifndef UserTableOptions_h
      13                 :            : #define UserTableOptions_h
      14                 :            : 
      15                 :            : #include <brigand/sequences/list.hpp>
      16                 :            : 
      17                 :            : #include "Toggle.hpp"
      18                 :            : #include "Keywords.hpp"
      19                 :            : #include "PUPUtil.hpp"
      20                 :            : 
      21                 :            : namespace tk {
      22                 :            : namespace ctr {
      23                 :            : 
      24                 :            : //! Table types types
      25                 :            : enum class UserTableType : uint8_t { POSITION=0,
      26                 :            :                                      VELOCITY,
      27                 :            :                                      ACCELERATION };
      28                 :            : 
      29                 :            : //! \brief Pack/Unpack UserTableType: forward overload to generic enum class
      30                 :            : //!   packer
      31                 :            : inline void operator|( PUP::er& p, UserTableType& e ) { PUP::pup( p, e ); }
      32                 :            : 
      33                 :            : //! \brief UserTable options: outsource searches to base templated on enum
      34                 :            : //!   type
      35                 :          4 : class UserTable : public tk::Toggle< UserTableType > {
      36                 :            : 
      37                 :            :   public:
      38                 :            :     //! Valid expected choices to make them also available at compile-time
      39                 :            :     using keywords = brigand::list< kw::position
      40                 :            :                                   , kw::velocity
      41                 :            :                                   , kw::acceleration
      42                 :            :                                   >;
      43                 :            : 
      44                 :            :     //! \brief Options constructor
      45                 :            :     //! \details Simply initialize in-line and pass associations to base, which
      46                 :            :     //!    will handle client interactions
      47                 :          4 :     explicit UserTable() :
      48                 :            :       tk::Toggle< UserTableType >(
      49                 :            :         //! Group, i.e., options, name
      50                 :            :         "User-defined table",
      51                 :            :         //! Enums -> names
      52                 :          4 :         { { UserTableType::POSITION, kw::position::name() },
      53 [ -  + ][ -  - ]:          4 :           { UserTableType::VELOCITY, kw::velocity::name() },
      54 [ -  + ][ -  - ]:          4 :           { UserTableType::ACCELERATION, kw::acceleration::name() } },
      55                 :            :         //! keywords -> Enums
      56                 :          4 :         { { kw::position::string(), UserTableType::POSITION },
      57 [ -  + ][ -  - ]:          4 :           { kw::velocity::string(), UserTableType::VELOCITY },
      58 [ +  - ][ +  - ]:         48 :           { kw::acceleration::string(), UserTableType::ACCELERATION } } ) {}
         [ +  - ][ +  + ]
         [ -  + ][ -  + ]
         [ +  + ][ -  + ]
         [ -  + ][ -  + ]
         [ -  - ][ -  - ]
         [ -  - ][ -  - ]
         [ -  - ][ -  - ]
                 [ -  - ]
      59                 :            : };
      60                 :            : 
      61                 :            : } // ctr::
      62                 :            : } // tk:::
      63                 :            : 
      64                 :            : #endif // UserTableOptions_h