.. _program_listing_file__tmp_ws_src_rmf_task_rmf_task_include_rmf_task_Payload.hpp:

Program Listing for File Payload.hpp
====================================

|exhale_lsh| :ref:`Return to documentation for file <file__tmp_ws_src_rmf_task_rmf_task_include_rmf_task_Payload.hpp>` (``/tmp/ws/src/rmf_task/rmf_task/include/rmf_task/Payload.hpp``)

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

.. code-block:: cpp

   /*
    * Copyright (C) 2021 Open Source Robotics Foundation
    *
    * 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 RMF_TASK__PAYLOAD_HPP
   #define RMF_TASK__PAYLOAD_HPP
   
   #include <rmf_utils/impl_ptr.hpp>
   
   #include <string>
   #include <vector>
   
   namespace rmf_task {
   
   //==============================================================================
   class Payload
   {
   public:
   
     class Component;
   
     Payload(std::vector<Component> components);
   
     const std::vector<Component>& components() const;
   
     std::string brief(const std::string& compartment_prefix = "in") const;
   
     class Implementation;
   private:
     rmf_utils::impl_ptr<Implementation> _pimpl;
   };
   
   //==============================================================================
   class Payload::Component
   {
   public:
   
     Component(
       std::string sku,
       uint32_t quantity,
       std::string compartment);
   
     const std::string& sku() const;
   
     uint32_t quantity() const;
   
     const std::string& compartment() const;
   
     class Implementation;
   private:
     rmf_utils::impl_ptr<Implementation> _pimpl;
   };
   
   } // namespace rmf_task
   
   #endif // RMF_TASK__PAYLOAD_HPP