Model.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 GZ_FUEL_TOOLS_MODEL_HH_
#define GZ_FUEL_TOOLS_MODEL_HH_
 
#include <memory>
#include <string>
 
#include "gz/fuel_tools/Helpers.hh"
#include "gz/fuel_tools/Result.hh"
#include "gz/fuel_tools/ModelIdentifier.hh"
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::shared_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
 
namespace gz::fuel_tools
{
  class ModelPrivate;
 
  class ModelIter;
 
  class ModelIterPrivate;
 
  class LocalCache;
 
  class LocalCachePrivate;
 
  class IterIds;
 
  class IterRESTIds;
 
  class IterRestIds;
 
  class ModelIterTest;
 
  class GZ_FUEL_TOOLS_VISIBLE Model
  {
    friend IterIds;
    friend IterRESTIds;
    friend IterRestIds;
    friend ModelIter;
    friend ModelIterPrivate;
    friend ModelIterTest;
    friend LocalCache;
    friend LocalCachePrivate;
 
    public: Model();
 
    public: Model(const Model &_orig) = default;
 
    protected: explicit Model(std::shared_ptr<ModelPrivate> _dptr);
 
    public: operator bool() const;
 
    public: operator bool();
 
    public: ModelIdentifier Identification() const;
 
    public: Result Fetch() const;
 
    public: std::string PathToModel() const;
 
    private: std::shared_ptr<ModelPrivate> dataPtr;
  };
}  // namespace gz::fuel_tools
 
#ifdef _MSC_VER
#pragma warning(pop)
#endif
 
#endif  // GZ_FUEL_TOOLS_MODEL_HH_