source: finroc_plugins_composite_ports/interface_types.h @ 23:3c9cac2a0cc1

//
// You received this file as part of Finroc
// A framework for intelligent robot control
//
// Copyright (C) Finroc GbR (finroc.org)
//
// This program 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 2 of the License, or
// (at your option) any later version.
//
// This program 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 this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
//----------------------------------------------------------------------
/*!\file    plugins/composite_ports/interface_types.h
 *
 * \author  Max Reichardt
 *
 * \date    2021-03-20
 *
 * Utility functions for handling port composite interface types
 *
 */
//----------------------------------------------------------------------
#ifndef __plugins__composite_ports__interface_types_h__
#define __plugins__composite_ports__interface_types_h__

//----------------------------------------------------------------------
// External includes (system with <>, local with "")
//----------------------------------------------------------------------

//----------------------------------------------------------------------
// Internal includes with ""
//----------------------------------------------------------------------
#include "plugins/composite_ports/internal/tInterfaceTypeInfo.h"

//----------------------------------------------------------------------
// Namespace declaration
//----------------------------------------------------------------------
namespace finroc
{
namespace composite_ports
{

//----------------------------------------------------------------------
// Forward declarations / typedefs / enums
//----------------------------------------------------------------------

//----------------------------------------------------------------------
// Function declarations
//----------------------------------------------------------------------

/*!
 * \param type Data type to check
 * \return Is specified data type a port composite interface type?
 */
inline bool IsInterfaceType(const rrlib::rtti::tType& type)
{
  return type.GetTypeClassification() == rrlib::rtti::tTypeClassification::PORT_COMPOSITE_INTERFACE;
}

/*!
 * \param type Data type
 * \return Full interface type if type is a port composite interface type - possibly a partial interface type
 */
inline bool GetFullInterfaceType(const rrlib::rtti::tType& type)
{
  return IsInterfaceType(type) && static_cast<const internal::tInterfaceTypeInfo&>(type.SharedTypeInfo()).GetFullType();
}

/*!
 * \param type Data type
 * \return Partial interface type if type is a port composite interface type with a partial interface type
 */
inline bool GetPartialInterfaceType(const rrlib::rtti::tType& type)
{
  return IsInterfaceType(type) && static_cast<const internal::tInterfaceTypeInfo&>(type.SharedTypeInfo()).GetPartialType();
}

/*!
 * \param type Data type to check
 * \return Is specified data type a partial port composite interface type?
 */
inline bool IsPartialInterfaceType(const rrlib::rtti::tType& type)
{
  return GetPartialInterfaceType(type) == type;
}

//----------------------------------------------------------------------
// End of namespace declaration
//----------------------------------------------------------------------
}
}


#endif