Gazebo Plugin

API Reference

1.4.0
gz/plugin/WeakPluginPtr.hh
Go to the documentation of this file.
1/*
2 * Copyright (C) 2018 Open Source Robotics Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
16 */
17
18#ifndef GZ_PLUGIN_WEAKPLUGINPTR_HH_
19#define GZ_PLUGIN_WEAKPLUGINPTR_HH_
20
21#include <memory>
22
24
25namespace ignition
26{
27 namespace plugin
28 {
40 {
42 public: WeakPluginPtr();
43
48
53
59 // cppcheck-suppress noExplicitConstructor
60 public: WeakPluginPtr(const PluginPtr &_ptr);
61
67
73
80
84 public: PluginPtr Lock() const;
85
88 public: bool IsExpired() const;
89
91 public: ~WeakPluginPtr();
92
93 private: class Implementation;
98 };
99 }
100}
101
102#endif
This class manages the lifecycle of a plugin instance. It can receive a plugin instance from the igni...
Definition gz/plugin/PluginPtr.hh:53
WeakPluginPtr is a non-reference-holding smart pointer for a Plugin. WeakPluginPtr is analogous to st...
Definition gz/plugin/WeakPluginPtr.hh:40
WeakPluginPtr()
Default constructor.
WeakPluginPtr & operator=(const WeakPluginPtr &_other)
Copy assignment operator.
WeakPluginPtr(const PluginPtr &_ptr)
Construct from a live PluginPtr.
WeakPluginPtr & operator=(const PluginPtr &_ptr)
Assign from a live PluginPtr.
WeakPluginPtr(WeakPluginPtr &&_other)
Move constructor.
WeakPluginPtr(const WeakPluginPtr &_other)
Copy constructor.
bool IsExpired() const
Check whether the referenced Plugin has already expired.
PluginPtr Lock() const
Retrieve the PluginPtr that this WeakPluginPtr refers to, if it is still available....
WeakPluginPtr & operator=(WeakPluginPtr &&_other)
Move assignment operator.
detail::ConstCompatible< To, From > ConstCompatible
Contains a static constexpr field named value which will be true if the type From has a const-quality...
Definition gz/plugin/utility.hh:50
Definition gz/plugin/EnablePluginFromThis.hh:26