CanWriteData.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 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 IGNITION_PHYSICS_CANWRITEDATA_HH_
#define IGNITION_PHYSICS_CANWRITEDATA_HH_

#include "ignition/physics/OperateOnSpecifiedData.hh"

namespace ignition
{
  namespace physics
  {
    struct IGNITION_PHYSICS_VISIBLE WriteOptions
    {
      public: bool skipMissingData;

      public: bool onlyWriteUnqueriedData;

      public: explicit WriteOptions(const bool _skipMissing = false,
                                    const bool _onlyUnqueried = true);
    };

    template <typename Derived, typename Specification>
    class CanWriteRequiredData
    {
      public: CanWriteRequiredData();

      public: template <typename CompositeType>
      void WriteRequiredData(
          CompositeType &_data,
          const WriteOptions &_options = WriteOptions()) const;
    };

    template <typename Derived, typename Specification>
    class CanWriteExpectedData
    {
      public: CanWriteExpectedData();

      public: template <typename CompositeType>
      void WriteExpectedData(
          CompositeType &_data,
          const WriteOptions &_options = WriteOptions()) const;
    };
  }
}

#include "ignition/physics/detail/CanWriteData.hh"

#endif