source: finroc_plugins_composite_ports/tInterfaceModifier.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/tInterfaceModifier.h
 *
 * \author  Max Reichardt
 *
 * \date    2021-03-01
 *
 * \brief   Contains tInterfaceModifier
 *
 * \b tInterfaceModifier
 *
 * Can be attached to components in order to customize interfaces that are instantiated
 * with this component as parent.
 *
 */
//----------------------------------------------------------------------
#ifndef __plugins__composite_ports__tInterfaceModifier_h__
#define __plugins__composite_ports__tInterfaceModifier_h__

//----------------------------------------------------------------------
// External includes (system with <>, local with "")
//----------------------------------------------------------------------
#include "core/port/tPortFactory.h"

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

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

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

//----------------------------------------------------------------------
// Class declaration
//----------------------------------------------------------------------
//! Interface Modifier
/*!
 * Can be attached to components in order to customize interfaces that are instantiated
 * with this component as parent.
 */
class tInterfaceModifier : public core::tAnnotation
{

//----------------------------------------------------------------------
// Public methods and typedefs
//----------------------------------------------------------------------
public:

  /*!
   * Base class for implementation.
   * Separate from tInterfaceModifier, to allow tInterfaceModifier's attachment as annotation.
   */
  class tImplementation
  {
  public:

    /*!
     * \param default_component_interface Component interface below which interface element would be created by default
     * \param primary_relation_id Primary relation ID, as used in interface classes (zero is primary port type)
     * \return Return Component interface below which interface element should be created. Return nullptr will not create element.
     */
    virtual core::tPortGroup* GetComponentInterface(core::tPortGroup* default_component_interface, int primary_relation_id) const
    {
      return default_component_interface;
    }

    /*!
     * Creates port.
     * Called for all data and RPC ports to be created below port composite interface root.
     * This function may modify any property of port - or may not create it.
     * (The base class implementation contains the default behavior)
     *
     * \param creation_info Creation info that would be used in default implementation to create port
     * \param primary_relation_id Primary relation ID, as used in interface classes (zero is primary port type)
     */
    virtual core::tAbstractPort* CreatePort(const core::tAbstractPortCreationInfo& creation_info, int primary_relation_id) const
    {
      if (data_ports::IsDataFlowType(creation_info.data_type))
      {
        return data_ports::tGenericPort(static_cast<const data_ports::common::tAbstractDataPortCreationInfo&>(creation_info)).GetWrapped();
      }
      return core::tPortFactory::CreatePort(creation_info.name, *creation_info.parent, creation_info.data_type, creation_info.flags);
    }

    /*!
     * \param type Port composite interface type to create
     * \return Whether to create partial interface? (CONTROLLER_PORT creates controller ports variant, SENSOR_PORT creates sensor ports variant, ANY creates partial interface with its primary port type)
     */
    virtual tInterfaceBase::tPrimaryPortType PartialInterface(const rrlib::rtti::tType& type)
    {
      return tInterfaceBase::tPrimaryPortType::ANY;
    }

  };

  /*! Variant that will not delete implementation on destruction */
  tInterfaceModifier(tImplementation& implementation) :
    implementation(&implementation)
  {}

  /*! Variant that will delete implementation on destruction */
  tInterfaceModifier(std::unique_ptr<tImplementation>& implementation) :
    implementation(implementation.get()),
    implementation_managed(std::move(implementation))
  {}

  /*!
   * \return Wrapped implementation instance
   */
  tImplementation& Implementation()
  {
    return *implementation;
  }

//----------------------------------------------------------------------
// Private fields and methods
//----------------------------------------------------------------------
private:

  tImplementation* implementation;
  std::unique_ptr<tImplementation> implementation_managed;
};

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


#endif