include/nrt/Probabilistic/Types/details/StateDefinitionHelpers.H

Go to the documentation of this file.

/*! @file
    @author Randolph Voorhies (voorhies at usc dot edu)
    @copyright GNU Public License (GPL v3)
    @section License
    @verbatim
    // ////////////////////////////////////////////////////////////////////////
    //              The iLab Neuromorphic Robotics Toolkit (NRT)             //
    // Copyright 2010-2012 by the University of Southern California (USC)    //
    //                          and the iLab at USC.                         //
    //                                                                       //
    //                iLab - University of Southern California               //
    //                Hedco Neurociences Building, Room HNB-10               //
    //                    Los Angeles, Ca 90089-2520 - USA                   //
    //                                                                       //
    //      See http://ilab.usc.edu for information about this project.      //
    // ////////////////////////////////////////////////////////////////////////
    // This file is part of The iLab Neuromorphic Robotics Toolkit.          //
    //                                                                       //
    // The iLab Neuromorphic Robotics Toolkit is free software: you can      //
    // redistribute it and/or modify it under the terms of the GNU General   //
    // Public License as published by the Free Software Foundation, either   //
    // version 3 of the License, or (at your option) any later version.      //
    //                                                                       //
    // The iLab Neuromorphic Robotics Toolkit is distributed in the hope     //
    // that it will be useful, but WITHOUT ANY WARRANTY; without even the    //
    // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR       //
    // PURPOSE.  See the GNU General Public License for more details.        //
    //                                                                       //
    // You should have received a copy of the GNU General Public License     //
    // along with The iLab Neuromorphic Robotics Toolkit.  If not, see       //
    // <http://www.gnu.org/licenses/>.                                       //
    // ////////////////////////////////////////////////////////////////////////
    @endverbatim */


#ifndef INCLUDE_NRT_PROBABILISTIC_TYPES_DETAILS_STATEDEFINITIONHELPERS_H
#define INCLUDE_NRT_PROBABILISTIC_TYPES_DETAILS_STATEDEFINITIONHELPERS_H

#define STATE_FIELD_GROUP_STRUCT_NAME(r, data, elem) \
  BOOST_PP_CAT(NRT_STATE_FIELD_GROUP_STRUCT_,BOOST_PP_CAT(data,BOOST_PP_CAT(_,elem)))

#define DEF_STATE_FIELD_GROUP_STRUCT(r, data, elem) \
  class STATE_FIELD_GROUP_STRUCT_NAME(r, data, elem) : public nrt::StateFieldBase {};

#define DEF_STATE_FIELD_GROUP(r, data, elem) \
  typedef STATE_FIELD_GROUP_STRUCT_NAME(r, data, elem) elem;

#define NRT_CREATE_STATE_FIELD_GROUP(StateFieldGroupName, Fields)                 \
  BOOST_PP_SEQ_FOR_EACH(DEF_STATE_FIELD_GROUP_STRUCT,StateFieldGroupName, Fields) \
  class StateFieldGroupName : public nrt::StateFieldGroupBase {                   \
    public:                                                                       \
    BOOST_PP_SEQ_FOR_EACH(DEF_STATE_FIELD_GROUP, StateFieldGroupName, Fields)     \
    typedef boost::mpl::vector<                                                   \
      BOOST_PP_SEQ_ENUM(Fields)                                                   \
    > fields;                                                                     \
    static size_t const num_fields = boost::mpl::size<fields>::value;             \
  }

namespace nrt
{
  template <class ... StateFields> struct ConcatenateFields { };
  template <> struct ConcatenateFields<> 
  {
    typedef boost::mpl::vector<> fields;
  };

  template<class Head, class ... Tail>
    struct ConcatenateFields<Head, Tail...>
    {
      typedef Head head;
      typedef typename head::fields headfields;
      typedef typename ConcatenateFields<Tail...>::fields tailfields;

      typedef 
        typename boost::mpl::insert_range
        <
        headfields,
        typename boost::mpl::end<headfields>::type,
        tailfields
          >::type fields;
    };

  template<class ...FieldGroups> struct ConcatenateFieldGroups { };
  template <> struct ConcatenateFieldGroups<>
  {
    typedef boost::mpl::vector<> groups;
  };

  template<class Head, class ...Tail>
    struct ConcatenateFieldGroups<Head, Tail...>
    {
      typedef typename ConcatenateFieldGroups<Tail...>::groups tailgroups;
      typedef
        typename boost::mpl::push_front
        <
          tailgroups,
          Head
        >::type groups;
    };

  class StateDefinitionBase {};
  class StateFieldGroupBase {};
  class StateFieldBase {};

  template<class Field>
  constexpr bool is_state_field()
  {
    return std::is_base_of<StateFieldBase, Field>::value;
  }

  template<class Field1, class Field2>
  constexpr bool are_state_fields()
  {
    return std::is_base_of<StateFieldBase, Field1>::value && 
      std::is_base_of<StateFieldBase, Field2>::value;
  }

  template<class Group>
  constexpr bool is_state_field_group()
  {
    return std::is_base_of<StateFieldGroupBase, Group>::value;
  };

  template<class Group1, class Group2>
  constexpr bool are_state_field_groups()
  {
    return std::is_base_of<StateFieldGroupBase, Group1>::value &&
      std::is_base_of<StateFieldGroupBase, Group2>::value;
  };
}

#endif // INCLUDE_NRT_PROBABILISTIC_TYPES_DETAILS_STATEDEFINITIONHELPERS_H