TopicTimingServer.h
Go to the documentation of this file.
1/*
2 * This file is part of ArmarX.
3 *
4 * ArmarX is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
7 *
8 * ArmarX is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 *
16 * @package RobotAPI::ArmarXObjects::TopicTimingServer
17 * @author Fabian Paus ( fabian dot paus at kit dot edu )
18 * @date 2019
19 * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
20 * GNU General Public License
21 */
22
23#pragma once
24
25
28#include <ArmarXCore/interface/observers/ObserverInterface.h>
29
30#include <RobotAPI/interface/core/TopicTimingTest.h>
31
32namespace armarx
33{
34 /**
35 * @class TopicTimingServerPropertyDefinitions
36 * @brief
37 */
43
44 /**
45 * @defgroup Component-TopicTimingServer TopicTimingServer
46 * @ingroup RobotAPI-Components
47 * A description of the component TopicTimingServer.
48 *
49 * @class TopicTimingServer
50 * @ingroup Component-TopicTimingServer
51 * @brief Brief description of class TopicTimingServer.
52 *
53 * Detailed description of class TopicTimingServer.
54 */
55 class TopicTimingServer : virtual public armarx::Component
56 {
57 public:
58 /// @see armarx::ManagedIceObject::getDefaultName()
59 virtual std::string getDefaultName() const override;
60
61
62 protected:
63 /// @see armarx::ManagedIceObject::onInitComponent()
64 virtual void onInitComponent() override;
65
66 /// @see armarx::ManagedIceObject::onConnectComponent()
67 virtual void onConnectComponent() override;
68
69 /// @see armarx::ManagedIceObject::onDisconnectComponent()
70 virtual void onDisconnectComponent() override;
71
72 /// @see armarx::ManagedIceObject::onExitComponent()
73 virtual void onExitComponent() override;
74
75 /// @see PropertyUser::createPropertyDefinitions()
77
78
79 private:
80 void run();
81
82 private:
83 armarx::topic_timing::TopicPrx topic;
84 int updatePeriodInMS = 10;
85
87
89
90 IceUtil::Time lastSmallTime = IceUtil::Time::microSeconds(0);
91 };
92} // namespace armarx
Default component property definition container.
Definition Component.h:70
Baseclass for all ArmarX ManagedIceObjects requiring properties.
Definition Component.h:94
std::string prefix
Prefix of the properties such as namespace, domain, component name, etc.
IceUtil::Handle< RunningTask< T > > pointer_type
Shared pointer type for convenience.
Brief description of class TopicTimingServer.
virtual void onInitComponent() override
virtual void onDisconnectComponent() override
virtual armarx::PropertyDefinitionsPtr createPropertyDefinitions() override
virtual void onConnectComponent() override
virtual void onExitComponent() override
virtual std::string getDefaultName() const override
This file offers overloads of toIce() and fromIce() functions for STL container types.
::IceInternal::ProxyHandle<::IceProxy::armarx::DebugObserverInterface > DebugObserverInterfacePrx
IceUtil::Handle< class PropertyDefinitionContainer > PropertyDefinitionsPtr
PropertyDefinitions smart pointer type.