pxmlw6n2f/Gazebo_Distributed_TCP/interfaces/player/OpaqueInterface.hh

83 lines
2.2 KiB
C++
Raw Normal View History

2019-03-28 10:57:49 +08:00
/*
* Copyright (C) 2012 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.
*
*/
/* Desc: Opaque Interface for Player
* Author: Benjamin Kloster
* Date: 13 March 2008
*/
#ifndef OPAQUEINTERFACE_HH
#define OPAQUEINTERFACE_HH
#include "GazeboInterface.hh"
#include "gazebo/util/system.hh"
namespace boost
{
class recursive_mutex;
}
namespace libgazebo
{
/// \addtogroup player_iface
/// \{
/// \defgroup opaque_player Opaque Interface
/// \brief Opaque Player interface
/// \{
// Forward declarations
class OpaqueIface;
/// \brief Opaque Player interface
class GAZEBO_VISIBLE OpaqueInterface : public GazeboInterface
{
/// \brief Constructor
public: OpaqueInterface(player_devaddr_t addr, GazeboDriver *driver,
ConfigFile *cf, int section);
/// \brief Destructor
public: virtual ~OpaqueInterface();
/// \brief Handle all messages. This is called from GazeboDriver
public: virtual int ProcessMessage(QueuePointer &respQueue,
player_msghdr_t *hdr, void *data);
/// \brief Update this interface, publish new info.
public: virtual void Update();
/// \brief Open a SHM interface when a subscription is received.
/// This is called fromGazeboDriver::Subscribe
public: virtual void Subscribe();
/// \brief Close a SHM interface. This is called from
/// GazeboDriver::Unsubscribe
public: virtual void Unsubscribe();
private: OpaqueIface *iface;
/// \brief Gazebo id. This needs to match and ID in a Gazebo WorldFile
private: char *gz_id;
/// \brief Timestamp on last data update
private: double datatime;
private: static boost::recursive_mutex *mutex;
};
/// \}
/// \}
}
#endif