StatechartContextInterface.h
Go to the documentation of this file.
1 /*
2  * This file is part of ArmarX.
3  *
4  * Copyright (C) 2011-2017, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
5  *
6  * ArmarX is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  *
10  * ArmarX is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  *
18  * @package ArmarX
19  * @author Mirko Waechter( mirko.waechter at kit dot edu)
20  * @date 2017
21  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
22  * GNU General Public License
23  */
24 #pragma once
25 
26 #include <Ice/Handle.h>
27 #include <ArmarXCore/interface/observers/VariantBase.h>
28 
29 namespace armarx
30 {
31 
32  class DatafieldRef;
34 
35  class ChannelRef;
37 
38 
39 
40  class DataFieldIdentifier;
41  class DataFieldIdentifierBase;
43  using DataFieldIdentifierBaseList = ::std::vector< ::armarx::DataFieldIdentifierBasePtr>;
44 
45 
47  {
48  public:
49  virtual TimedVariantBaseList getDataListFromObserver(std::string observerName, const DataFieldIdentifierBaseList& identifierList) = 0;
50  virtual VariantBasePtr getDataFromObserver(const DataFieldIdentifierBasePtr& identifier) = 0;
51  virtual ChannelRefPtr getChannelRef(const std::string& observerName, const std::string& channelName) = 0;
52  virtual DatafieldRefPtr getDatafieldRef(const DataFieldIdentifier& datafieldIdentifier) = 0;
53  virtual DatafieldRefPtr getDatafieldRef(ChannelRefPtr channelRef, const std::string& datafieldName) = 0;
54 
55  virtual ~StatechartContextInterface() = default;
56  };
57 
58 }
armarx::ChannelRefPtr
IceInternal::Handle< ChannelRef > ChannelRefPtr
Definition: ChannelRef.h:41
armarx::DataFieldIdentifierBaseList
::std::vector< ::armarx::DataFieldIdentifierBasePtr > DataFieldIdentifierBaseList
Definition: StatechartContextInterface.h:43
armarx::StatechartContextInterface
Definition: StatechartContextInterface.h:46
IceInternal::Handle< DatafieldRef >
armarx::DatafieldRefPtr
IceInternal::Handle< DatafieldRef > DatafieldRefPtr
Definition: Observer.h:44
armarx::StatechartContextInterface::~StatechartContextInterface
virtual ~StatechartContextInterface()=default
armarx::VariantType::ChannelRef
const VariantTypeId ChannelRef
Definition: ChannelRef.h:162
armarx::VariantType::DatafieldRef
const VariantTypeId DatafieldRef
Definition: DatafieldRef.h:169
armarx::StatechartContextInterface::getDataListFromObserver
virtual TimedVariantBaseList getDataListFromObserver(std::string observerName, const DataFieldIdentifierBaseList &identifierList)=0
armarx::StatechartContextInterface::getDataFromObserver
virtual VariantBasePtr getDataFromObserver(const DataFieldIdentifierBasePtr &identifier)=0
armarx::StatechartContextInterface::getDatafieldRef
virtual DatafieldRefPtr getDatafieldRef(const DataFieldIdentifier &datafieldIdentifier)=0
armarx::StatechartContextInterface::getChannelRef
virtual ChannelRefPtr getChannelRef(const std::string &observerName, const std::string &channelName)=0
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:28
armarx::DataFieldIdentifier
DataFieldIdentifier provide the basis to identify data field within a distributed ArmarX scenario.
Definition: DataFieldIdentifier.h:48