File: LinearBatteryConsumerPlugin.hh

package info (click to toggle)
gazebo 9.6.0-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 115,400 kB
  • sloc: cpp: 356,787; xml: 20,974; ansic: 9,594; python: 2,417; sh: 395; ruby: 375; makefile: 62
file content (45 lines) | stat: -rw-r--r-- 1,390 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
/*
 * Copyright (C) 2015 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 GAZEBO_PLUGINS_LINEARBATTERYCONSUMERPLUGIN_HH_
#define GAZEBO_PLUGINS_LINEARBATTERYCONSUMERPLUGIN_HH_

#include "gazebo/common/Plugin.hh"
#include "gazebo/common/CommonTypes.hh"

namespace gazebo
{
  /// \brief A plugin that manages a linear battery consumer.
  class GAZEBO_VISIBLE LinearBatteryConsumerPlugin : public ModelPlugin
  {
    /// \brief Constructor.
    public: LinearBatteryConsumerPlugin();

    /// \brief Destructor.
    public: ~LinearBatteryConsumerPlugin();

    // Documentation Inherited.
    public: virtual void Load(physics::ModelPtr _model, sdf::ElementPtr _sdf);

    /// \brief Pointer to battery.
    private: common::BatteryPtr battery;

    /// \brief Battery consumer identifier.
    private: int32_t consumerId;
  };
}
#endif