File size: 15,863 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 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 | /* -*- 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-14
(C) Copyright 2011-2026 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 ---
*/
#include <cisstMultiTask/mtsComponentAddLatency.h>
#include <cisstMultiTask/mtsInterfaceRequired.h>
#include <cisstMultiTask/mtsCommandWrite.h>
#include <cisstMultiTask/mtsCallableQualifiedReadMethod.h>
#include <cisstMultiTask/mtsManagerLocal.h>
typedef std::list<std::pair<double, mtsGenericObject *> > mtsComponentAddLatencyWriteHistoryType;
typedef std::list<double> mtsComponentAddLatencyVoidHistoryType;
class mtsComponentAddLatencyDelayedRead
{
public:
inline mtsComponentAddLatencyDelayedRead(const std::string & name, mtsGenericObject & placeHolder):
Name(name),
PlaceHolder(&placeHolder)
{}
inline ~mtsComponentAddLatencyDelayedRead() {
delete PlaceHolder;
}
inline mtsExecutionResult Execute(void) {
CMN_ASSERT(this->PlaceHolder);
return this->Function(*(this->PlaceHolder));
}
mtsFunctionRead Function;
protected:
std::string Name;
mtsGenericObject * PlaceHolder;
};
class mtsComponentAddLatencyDelayedQualifiedRead
{
public:
inline mtsComponentAddLatencyDelayedQualifiedRead(const std::string & name):
Callable(0),
Name(name)
{}
inline ~mtsComponentAddLatencyDelayedQualifiedRead() {
if (this->Callable) {
delete this->Callable;
this->Callable = 0;
}
}
inline bool Method(const mtsGenericObject & qualifier,
mtsGenericObject & placeHolder) const {
mtsExecutionResult executionResult = this->Function(qualifier, placeHolder);
if (executionResult.IsOK()) {
return true;
}
return false;
}
mtsFunctionQualifiedRead Function;
mtsCallableQualifiedReadBase * Callable;
protected:
std::string Name;
};
class mtsComponentAddLatencyDelayedVoid
{
public:
inline mtsComponentAddLatencyDelayedVoid(const std::string & name):
Name(name)
{}
inline ~mtsComponentAddLatencyDelayedVoid() {
History.clear();
}
inline mtsExecutionResult ProcessQueuedCommands(double time) {
mtsExecutionResult executionResult;
mtsComponentAddLatencyVoidHistoryType::iterator iter = History.begin();
// look in history for all commands with timestamp lower than time
while ((iter != History.end())
&& ((*iter) < time)) {
executionResult = this->Function();
History.erase(iter);
iter = History.begin();
// if the first queued command fails, just quit
if (!executionResult.IsOK()) {
return executionResult;
}
}
return executionResult;
}
inline void Method(void) {
const double time = mtsComponentManager::GetInstance()->GetTimeServer().GetRelativeTime();
History.push_back(time);
}
mtsFunctionVoid Function;
protected:
mtsComponentAddLatencyVoidHistoryType History;
std::string Name;
};
class mtsComponentAddLatencyDelayedWrite
{
public:
inline mtsComponentAddLatencyDelayedWrite(const std::string & name):
Command(0),
Name(name)
{}
inline ~mtsComponentAddLatencyDelayedWrite() {
mtsComponentAddLatencyWriteHistoryType::iterator iter;
const mtsComponentAddLatencyWriteHistoryType::iterator end = History.end();
for (iter = History.begin();
iter != end;
++iter) {
delete (*iter).second;
}
History.clear();
if (this->Command) {
delete this->Command;
this->Command = 0;
}
}
inline mtsExecutionResult ProcessQueuedCommands(double time) {
mtsExecutionResult executionResult;
mtsComponentAddLatencyWriteHistoryType::iterator iter = History.begin();
// look in history for all commands with timestamp lower than time
while ((iter != History.end())
&& ((*iter).first < time)) {
mtsGenericObject * parameter = (*iter).second;
executionResult = this->Function(*parameter);
delete parameter;
History.erase(iter);
iter = History.begin();
// if the first queued command fails, just quit
if (!executionResult.IsOK()) {
return executionResult;
}
}
return executionResult;
}
inline void Method(const mtsGenericObject & data) {
const double time = mtsComponentManager::GetInstance()->GetTimeServer().GetRelativeTime();
// push copy of parameter to history
mtsGenericObject * parameter = dynamic_cast<mtsGenericObject *>(data.Services()->Create(data));
if (parameter) {
History.push_back(std::pair<double, mtsGenericObject *>(time, parameter));
} else {
std::cerr << CMN_LOG_DETAILS << " oops, can't create a copy of parameter" << std::endl;
}
}
mtsFunctionWrite Function;
mtsCommandWriteBase * Command;
protected:
mtsComponentAddLatencyWriteHistoryType History;
std::string Name;
};
mtsComponentAddLatency::mtsComponentAddLatency(const std::string & componentName,
double periodInSeconds):
mtsTaskPeriodic(componentName, periodInSeconds, false /* real time */, 100 /* state table size */),
LatencyStateTable(10000, "DataWithLatency")
{
SetLatency(1.0); // default
}
mtsComponentAddLatency::mtsComponentAddLatency(const mtsTaskPeriodicConstructorArg &arg):
mtsTaskPeriodic(arg),
LatencyStateTable(10000, "DataWithLatency")
{
SetLatency(1.0); // default
}
mtsComponentAddLatency::~mtsComponentAddLatency()
{
DelayedReadList::iterator readIterator = DelayedReads.begin();
const DelayedReadList::iterator readEnd = DelayedReads.end();
this->LatencyStateTable.Start();
for (;
readIterator != readEnd;
++readIterator) {
delete (*readIterator);
}
DelayedReads.clear();
DelayedQualifiedReadList::iterator qualifiedReadIterator = DelayedQualifiedReads.begin();
const DelayedQualifiedReadList::iterator qualifiedReadEnd = DelayedQualifiedReads.end();
this->LatencyStateTable.Start();
for (;
qualifiedReadIterator != qualifiedReadEnd;
++qualifiedReadIterator) {
delete (*qualifiedReadIterator);
}
DelayedQualifiedReads.clear();
DelayedVoidList::iterator voidIterator = DelayedVoids.begin();
const DelayedVoidList::iterator voidEnd = DelayedVoids.end();
this->LatencyStateTable.Start();
for (;
voidIterator != voidEnd;
++voidIterator) {
delete (*voidIterator);
}
DelayedVoids.clear();
DelayedWriteList::iterator writeIterator = DelayedWrites.begin();
const DelayedWriteList::iterator writeEnd = DelayedWrites.end();
this->LatencyStateTable.Start();
for (;
writeIterator != writeEnd;
++writeIterator) {
delete (*writeIterator);
}
DelayedWrites.clear();
}
void mtsComponentAddLatency::Configure(const std::string & CMN_UNUSED(filename))
{
}
void mtsComponentAddLatency::Startup(void)
{
}
void mtsComponentAddLatency::Run(void)
{
ProcessQueuedEvents();
ProcessQueuedCommands();
mtsExecutionResult result;
DelayedReadList::iterator readIterator = DelayedReads.begin();
const DelayedReadList::iterator readEnd = DelayedReads.end();
this->LatencyStateTable.Start();
for (;
readIterator != readEnd;
++readIterator) {
result = (*readIterator)->Execute();
}
this->LatencyStateTable.Advance();
// see if we have some old void/write commands
const double time = mtsComponentManager::GetInstance()->GetTimeServer().GetRelativeTime() - this->Latency;
DelayedVoidList::iterator voidIterator = DelayedVoids.begin();
const DelayedVoidList::iterator voidEnd = DelayedVoids.end();
this->LatencyStateTable.Start();
for (;
voidIterator != voidEnd;
++voidIterator) {
(*voidIterator)->ProcessQueuedCommands(time);
}
DelayedWriteList::iterator writeIterator = DelayedWrites.begin();
const DelayedWriteList::iterator writeEnd = DelayedWrites.end();
this->LatencyStateTable.Start();
for (;
writeIterator != writeEnd;
++writeIterator) {
(*writeIterator)->ProcessQueuedCommands(time);
}
}
void mtsComponentAddLatency::Cleanup(void)
{
}
bool mtsComponentAddLatency::AddCommandReadDelayedInternal(mtsGenericObject & data,
mtsInterfaceRequired * interfaceRequired,
const std::string & commandRequiredName)
{
// create, add to required interface and keep in list
mtsComponentAddLatencyDelayedRead * delayedRead
= new mtsComponentAddLatencyDelayedRead(commandRequiredName, data);
interfaceRequired->AddFunction(commandRequiredName, delayedRead->Function, MTS_REQUIRED);
DelayedReads.push_back(delayedRead);
return true;
}
bool mtsComponentAddLatency::AddCommandQualifiedReadDelayedInternal(const mtsGenericObject & qualifier,
const mtsGenericObject & placeHolder,
mtsInterfaceRequired * interfaceRequired,
const std::string & commandRequiredName,
mtsInterfaceProvided * interfaceProvided,
const std::string & commandProvidedName)
{
mtsComponentAddLatencyDelayedQualifiedRead * delayedQualifiedRead
= new mtsComponentAddLatencyDelayedQualifiedRead(commandRequiredName);
interfaceRequired->AddFunction(commandRequiredName, delayedQualifiedRead->Function, MTS_REQUIRED);
delayedQualifiedRead->Callable = new mtsCallableQualifiedReadMethodGeneric<mtsComponentAddLatencyDelayedQualifiedRead>(&mtsComponentAddLatencyDelayedQualifiedRead::Method, delayedQualifiedRead);
interfaceProvided->AddCommandQualifiedRead(delayedQualifiedRead->Callable,
commandProvidedName == "" ? commandRequiredName : commandProvidedName,
&qualifier,
&placeHolder);
DelayedQualifiedReads.push_back(delayedQualifiedRead);
return true;
}
bool mtsComponentAddLatency::AddCommandVoidDelayed(mtsInterfaceRequired * interfaceRequired,
const std::string & commandRequiredName,
mtsInterfaceProvided * interfaceProvided,
const std::string & commandProvidedName)
{
mtsComponentAddLatencyDelayedVoid * delayedVoid
= new mtsComponentAddLatencyDelayedVoid(commandRequiredName);
interfaceRequired->AddFunction(commandRequiredName, delayedVoid->Function, MTS_REQUIRED);
interfaceProvided->AddCommandVoid(&mtsComponentAddLatencyDelayedVoid::Method, delayedVoid,
commandProvidedName == "" ? commandRequiredName : commandProvidedName);
DelayedVoids.push_back(delayedVoid);
return true;
}
bool mtsComponentAddLatency::AddCommandWriteDelayedInternal(const mtsGenericObject & data,
mtsInterfaceRequired * interfaceRequired,
const std::string & commandRequiredName,
mtsInterfaceProvided * interfaceProvided,
const std::string & commandProvidedName)
{
mtsComponentAddLatencyDelayedWrite * delayedWrite
= new mtsComponentAddLatencyDelayedWrite(commandRequiredName);
interfaceRequired->AddFunction(commandRequiredName, delayedWrite->Function, MTS_REQUIRED);
delayedWrite->Command
= new mtsCommandWriteGeneric<mtsComponentAddLatencyDelayedWrite>(&mtsComponentAddLatencyDelayedWrite::Method, delayedWrite,
commandProvidedName == "" ? commandRequiredName : commandProvidedName,
&data);
interfaceProvided->AddCommandWrite(delayedWrite->Command);
DelayedWrites.push_back(delayedWrite);
return true;
}
bool mtsComponentAddLatency::AddEventVoidDelayed(mtsInterfaceRequired * interfaceRequired,
const std::string & eventRequiredName,
mtsInterfaceProvided * interfaceProvided,
const std::string & eventProvidedName)
{
mtsComponentAddLatencyDelayedVoid * delayedVoid
= new mtsComponentAddLatencyDelayedVoid(eventRequiredName);
interfaceProvided->AddEventVoid(delayedVoid->Function,
eventProvidedName == "" ? eventRequiredName : eventProvidedName);
interfaceRequired->AddEventHandlerVoid(&mtsComponentAddLatencyDelayedVoid::Method,
delayedVoid,
eventRequiredName);
DelayedVoids.push_back(delayedVoid);
return true;
}
bool mtsComponentAddLatency::AddEventWriteDelayedInternal(const mtsGenericObject & data,
mtsInterfaceRequired * interfaceRequired,
const std::string & eventRequiredName,
mtsInterfaceProvided * interfaceProvided,
const std::string & eventProvidedName)
{
mtsComponentAddLatencyDelayedWrite * delayedWrite
= new mtsComponentAddLatencyDelayedWrite(eventRequiredName);
interfaceProvided->AddEventWriteGeneric(delayedWrite->Function,
eventProvidedName == "" ? eventRequiredName : eventProvidedName,
data);
// Create a temporary argument prototype (using copy constructor) to pass to AddEventHandlerWriteGeneric.
// The alternative would be to cast away the const-ness of "data".
mtsGenericObject * argPrototype = dynamic_cast<mtsGenericObject *>(data.Services()->Create(data));
interfaceRequired->AddEventHandlerWriteGeneric(&mtsComponentAddLatencyDelayedWrite::Method, delayedWrite,
eventRequiredName, MTS_INTERFACE_EVENT_POLICY, argPrototype);
delete argPrototype;
DelayedWrites.push_back(delayedWrite);
return true;
}
double mtsComponentAddLatency::SetLatency(double latencyInSeconds)
{
double previousLatency = this->Latency;
this->Latency = latencyInSeconds;
const size_t latencyInPeriods = static_cast<size_t>(latencyInSeconds / this->GetPeriodicity());
LatencyStateTable.SetDelay(latencyInPeriods);
return previousLatency;
}
|