File size: 11,915 Bytes
68ce2fc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*
  Author(s):  Anton Deguet
  Created on: 2011-12-15

  (C) Copyright 2011-2023 Johns Hopkins University (JHU), All Rights Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/


#ifndef _mtsComponentAddLatency_h
#define _mtsComponentAddLatency_h

#include <cisstMultiTask/mtsTaskPeriodic.h>
#include <cisstMultiTask/mtsInterfaceProvided.h>

// Always include last
#include <cisstMultiTask/mtsExport.h>

// forward declarations for internal types
class mtsComponentAddLatencyDelayedRead;
class mtsComponentAddLatencyDelayedQualifiedRead;
class mtsComponentAddLatencyDelayedVoid;
class mtsComponentAddLatencyDelayedWrite;

/*!
  \ingroup cisstMultiTask

  Base class for component with latency.  This class can be used to
  create a component that delays all commands and events.  For
  example, one might want to simulate the latency introduced by the
  network between a master and a slave for a tele-operation task.  The
  delay component can then be inserted between the client and server.
  It must replicate the server provided interface(s) so that the
  client will connect its required interface(s) as if it was the
  server itself.  Let Cs the server component, Cc the client component
  and Cd the delay component.  Cd will need to be created with the
  same provided interfaces as Cs.  Then, instead of connecting Cc to
  Cs, we will connect Cc to Cd and Cd to Cs.

  The derived component needs to create its required and provided
  interfaces using the methods AddInterfaceRequired and
  AddInterfaceProvided.  Once the interfaces are created, commands can
  be added using AddCommandVoidDelayed, AddCommandReadDelayed, ...

  At runtime, the delay component will continuously read from the
  server and buffer the results in a state table.  It is important to
  set the periodicity of the delay component so that enough data is
  collected but make sure the frequency is not too high either.  For
  void and write commands as well as events, the component buffers all
  requests and periodically checks which commands/events should be
  forwarded.  Therefore the actual latency will be impacted by the
  period used by the delay component.
 */
class CISST_EXPORT mtsComponentAddLatency: public mtsTaskPeriodic
{
    CMN_DECLARE_SERVICES(CMN_DYNAMIC_CREATION_ONEARG, CMN_LOG_ALLOW_DEFAULT);

 protected:

    typedef std::list<mtsComponentAddLatencyDelayedRead *> DelayedReadList;
    DelayedReadList DelayedReads;

    typedef std::list<mtsComponentAddLatencyDelayedQualifiedRead *> DelayedQualifiedReadList;
    DelayedQualifiedReadList DelayedQualifiedReads;

    typedef std::list<mtsComponentAddLatencyDelayedVoid *> DelayedVoidList;
    DelayedVoidList DelayedVoids;

    typedef std::list<mtsComponentAddLatencyDelayedWrite *> DelayedWriteList;
    DelayedWriteList DelayedWrites;

 public:
    // constructor
    mtsComponentAddLatency(const std::string & componentName, double periodInSeconds);
    mtsComponentAddLatency(const mtsTaskPeriodicConstructorArg &arg);
    virtual ~mtsComponentAddLatency();

    // methods defined as virtual in base class
    void Configure(const std::string & filename) override;
    void Startup(void) override;
    void Run(void) override;
    void Cleanup(void) override;

    double SetLatency(double latencyInSeconds);

 protected:

    /*! Add a read command with latency.  The provided and required
      interfaces must be created before using the methods
      AddInterfaceRequired and AddInterfaceProvided.  The command name
      should match the command name from the source component provided
      interface.  By default the provided interface with delay will
      use the same command name. */
    template <class _elementType>
    bool AddCommandReadDelayed(mtsInterfaceRequired * interfaceRequired,
                               const std::string & commandRequiredName,
                               mtsInterfaceProvided * interfaceProvided,
                               const std::string & commandProvidedName = "");

    template <class _element1Type, class _element2Type>
    bool AddCommandQualifiedReadDelayed(mtsInterfaceRequired * interfaceRequired,
                                        const std::string & commandRequiredName,
                                        mtsInterfaceProvided * interfaceProvided,
                                        const std::string & commandProvidedName = "");


    bool AddCommandVoidDelayed(mtsInterfaceRequired * interfaceRequired,
                               const std::string & commandRequiredName,
                               mtsInterfaceProvided * interfaceProvided,
                               const std::string & commandProvidedName = "");

    template <class _elementType>
    bool AddCommandWriteDelayed(mtsInterfaceRequired * interfaceRequired,
                                const std::string & commandRequiredName,
                                mtsInterfaceProvided * interfaceProvided,
                                const std::string & commandProvidedName = "");

    bool AddEventVoidDelayed(mtsInterfaceRequired * interfaceRequired,
                             const std::string & eventRequiredName,
                             mtsInterfaceProvided * interfaceProvided,
                             const std::string & eventProvidedName = "");

    template <class _elementType>
    bool AddEventWriteDelayed(mtsInterfaceRequired * interfaceRequired,
                              const std::string & eventRequiredName,
                              mtsInterfaceProvided * interfaceProvided,
                              const std::string & eventProvidedName = "");

    double Latency;
    mtsStateTable LatencyStateTable;

 private:
    bool AddCommandReadDelayedInternal(mtsGenericObject & data,
                                       mtsInterfaceRequired * interfaceRequired,
                                       const std::string & commandRequiredName);

    bool AddCommandQualifiedReadDelayedInternal(const mtsGenericObject & qualifier,
                                                const mtsGenericObject & placeHolder,
                                                mtsInterfaceRequired * interfaceRequired,
                                                const std::string & commandRequiredName,
                                                mtsInterfaceProvided * interfaceProvided,
                                                const std::string & commandProvidedName);

    bool AddCommandWriteDelayedInternal(const mtsGenericObject & data,
                                        mtsInterfaceRequired * interfaceRequired,
                                        const std::string & commandRequiredName,
                                        mtsInterfaceProvided * interfaceProvided,
                                        const std::string & commandProvidedName);

    bool AddEventWriteDelayedInternal(const mtsGenericObject & data,
                                      mtsInterfaceRequired * interfaceRequired,
                                      const std::string & eventRequiredName,
                                      mtsInterfaceProvided * interfaceProvided,
                                      const std::string & eventProvidedName = "");

};



template <class _elementType>
bool mtsComponentAddLatency::AddCommandReadDelayed(mtsInterfaceRequired * interfaceRequired,
                                                   const std::string & commandRequiredName,
                                                   mtsInterfaceProvided * interfaceProvided,
                                                   const std::string & commandProvidedName)
{
    // data object is used later to store the result of function
    // reads, state teble will keep a pointer on that object so it
    // must not be deleted until the task is killed.
    _elementType * data = new _elementType;
    this->LatencyStateTable.AddData(*data);
    interfaceProvided->AddCommandReadStateDelayed(this->LatencyStateTable,
                                                  *data,
                                                  commandProvidedName == ""
                                                  ? commandRequiredName
                                                  : commandProvidedName);
    return
        this->AddCommandReadDelayedInternal(*data, interfaceRequired, commandRequiredName);
}


template <class _element1Type, class _element2Type>
bool mtsComponentAddLatency::AddCommandQualifiedReadDelayed(mtsInterfaceRequired * interfaceRequired,
                                                            const std::string & commandRequiredName,
                                                            mtsInterfaceProvided * interfaceProvided,
                                                            const std::string & commandProvidedName)
{
    _element1Type qualifier;
    _element2Type placeHolder;
    return
        this->AddCommandQualifiedReadDelayedInternal(qualifier,
                                                     placeHolder,
                                                     interfaceRequired,
                                                     commandRequiredName,
                                                     interfaceProvided,
                                                     commandProvidedName == ""
                                                     ? commandRequiredName
                                                     : commandProvidedName);
}


template <class _elementType>
bool mtsComponentAddLatency::AddCommandWriteDelayed(mtsInterfaceRequired * interfaceRequired,
                                                    const std::string & commandRequiredName,
                                                    mtsInterfaceProvided * interfaceProvided,
                                                    const std::string & commandProvidedName)
{
    // data object is used to create an argument prototype but won't
    // be used afterwards
    _elementType data;
    return
        this->AddCommandWriteDelayedInternal(data,
                                             interfaceRequired,
                                             commandRequiredName,
                                             interfaceProvided,
                                             commandProvidedName == ""
                                             ? commandRequiredName
                                             : commandProvidedName);
}


template <class _elementType>
bool mtsComponentAddLatency::AddEventWriteDelayed(mtsInterfaceRequired * interfaceRequired,
                                                  const std::string & eventRequiredName,
                                                  mtsInterfaceProvided * interfaceProvided,
                                                  const std::string & eventProvidedName)
{
    // data object is used to create an argument prototype but won't
    // be used afterwards
    _elementType data;
    return
        this->AddEventWriteDelayedInternal(data,
                                           interfaceRequired,
                                           eventRequiredName,
                                           interfaceProvided,
                                           eventProvidedName == ""
                                           ? eventRequiredName
                                           : eventProvidedName);
}


CMN_DECLARE_SERVICES_INSTANTIATION(mtsComponentAddLatency)


#endif // _mtsComponentAddLatency_h