.. _program_listing_file_include_rcl_remap.h:

Program Listing for File remap.h
================================

|exhale_lsh| :ref:`Return to documentation for file <file_include_rcl_remap.h>` (``include/rcl/remap.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   // Copyright 2018 Open Source Robotics Foundation, Inc.
   //
   // Licensed under the Apache License, Version 2.0 (the "License");
   // you may not use this file except in compliance with the License.
   // You may obtain a copy of the License at
   //
   //     http://www.apache.org/licenses/LICENSE-2.0
   //
   // Unless required by applicable law or agreed to in writing, software
   // distributed under the License is distributed on an "AS IS" BASIS,
   // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   // See the License for the specific language governing permissions and
   // limitations under the License.
   
   
   #ifndef RCL__REMAP_H_
   #define RCL__REMAP_H_
   
   #include "rcl/allocator.h"
   #include "rcl/arguments.h"
   #include "rcl/macros.h"
   #include "rcl/types.h"
   #include "rcl/visibility_control.h"
   
   #ifdef __cplusplus
   extern "C"
   {
   #endif
   
   typedef struct rcl_remap_impl_s rcl_remap_impl_t;
   
   typedef struct rcl_remap_s
   {
     rcl_remap_impl_t * impl;
   } rcl_remap_t;
   
   RCL_PUBLIC
   RCL_WARN_UNUSED
   rcl_remap_t
   rcl_get_zero_initialized_remap(void);
   
   // TODO(sloretz) add documentation about rostopic:// when it is supported
   
   RCL_PUBLIC
   RCL_WARN_UNUSED
   rcl_ret_t
   rcl_remap_topic_name(
     const rcl_arguments_t * local_arguments,
     const rcl_arguments_t * global_arguments,
     const char * topic_name,
     const char * node_name,
     const char * node_namespace,
     rcl_allocator_t allocator,
     char ** output_name);
   
   // TODO(sloretz) add documentation about rosservice:// when it is supported
   
   RCL_PUBLIC
   RCL_WARN_UNUSED
   rcl_ret_t
   rcl_remap_service_name(
     const rcl_arguments_t * local_arguments,
     const rcl_arguments_t * global_arguments,
     const char * service_name,
     const char * node_name,
     const char * node_namespace,
     rcl_allocator_t allocator,
     char ** output_name);
   
   
   RCL_PUBLIC
   RCL_WARN_UNUSED
   rcl_ret_t
   rcl_remap_node_name(
     const rcl_arguments_t * local_arguments,
     const rcl_arguments_t * global_arguments,
     const char * node_name,
     rcl_allocator_t allocator,
     char ** output_name);
   
   
   RCL_PUBLIC
   RCL_WARN_UNUSED
   rcl_ret_t
   rcl_remap_node_namespace(
     const rcl_arguments_t * local_arguments,
     const rcl_arguments_t * global_arguments,
     const char * node_name,
     rcl_allocator_t allocator,
     char ** output_namespace);
   
   
   RCL_PUBLIC
   RCL_WARN_UNUSED
   rcl_ret_t
   rcl_remap_copy(
     const rcl_remap_t * rule,
     rcl_remap_t * rule_out);
   
   
   RCL_PUBLIC
   RCL_WARN_UNUSED
   rcl_ret_t
   rcl_remap_fini(
     rcl_remap_t * remap);
   
   #ifdef __cplusplus
   }
   #endif
   
   #endif  // RCL__REMAP_H_