File size: 14,163 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 | /* -*- 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): Min Yang Jung, Anton Deguet
Created on: 2009-03-20
(C) Copyright 2009-2025 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/mtsCollectorBase.h>
#include <cisstCommon/cmnPath.h>
#include <cisstOSAbstraction/osaSleep.h>
#include <cisstOSAbstraction/osaStopwatch.h>
#include <cisstMultiTask/mtsInterfaceProvided.h>
//-------------------------------------------------------
// Constructor, Destructor, and Initializer
//-------------------------------------------------------
mtsCollectorBase::mtsCollectorBase(const std::string & collectorName,
const CollectorFileFormat fileFormat)
:
mtsTaskFromSignal(collectorName),
FileFormat(fileFormat),
ConnectedFlag(false),
TimeIntervalForProgressEvent(1.0 * cmn_s),
OutputStream(0),
OutputFile(0),
OutputHeaderStream(0),
OutputHeaderFile(0),
FloatingNotation(COLLECTOR_FILE_FLOATING_NOTATION_NONE),
Precision(10),
Width(4),
FillCharacter(' '),
FileOpened(false),
Serializer(0)
{
// set working directory
this->WorkingDirectoryMember = cmnPath::GetWorkingDirectory();
// add the control interface
this->SetupControlInterface();
this->mTags.clear();
this->AddTag("System");
Init();
}
mtsCollectorBase::~mtsCollectorBase()
{
CMN_LOG_CLASS_INIT_VERBOSE << "destructor: collector " << GetName() << " ends." << std::endl;
}
void mtsCollectorBase::SetupControlInterface(void)
{
// add a control interface to start and stop the data collection
this->ControlInterface = AddInterfaceProvided("Control");
if (this->ControlInterface) {
// commands controlling the output
ControlInterface->AddCommandVoid(&mtsCollectorBase::SetOutputToDefaultCommand, this,
"SetOutputToDefault");
ControlInterface->AddCommandWrite(&mtsCollectorBase::SetWorkingDirectoryCommand, this,
"SetWorkingDirectory");
ControlInterface->AddCommandRead(&mtsCollectorBase::GetWorkingDirectory, this,
"GetWorkingDirectory");
// start/stop commands
ControlInterface->AddCommandWrite(&mtsCollectorBase::StartCollectionCommand, this,
"StartCollection");
ControlInterface->AddCommandWrite(&mtsCollectorBase::StopCollectionCommand, this,
"StopCollection");
// events
ControlInterface->AddEventWrite(this->CollectionStartedEventTrigger,
"CollectionStarted", false);
ControlInterface->AddEventWrite(this->ProgressEventTrigger,
"Progress", size_t(0));
}
}
void mtsCollectorBase::SetOutput(const std::string & fileName,
const CollectorFileFormat fileFormat)
{
CMN_LOG_CLASS_INIT_DEBUG << "SetOutput: file \"" << fileName
<< "\" using file format \"" << fileFormat << "\"" << std::endl;
// test if there was a file opened before
if (this->OutputFile) {
CMN_LOG_CLASS_INIT_VERBOSE << "SetOutput: closing file \"" << this->OutputFileName << "\"" << std::endl;
this->OutputFile->close();
}
if (this->OutputHeaderFile) {
CMN_LOG_CLASS_INIT_VERBOSE << "SetOutput: closing file \"" << this->OutputFileName << "\"" << std::endl;
this->OutputHeaderFile->close();
}
// create the output file
this->OutputFile = new std::ofstream;
this->OutputHeaderFile = new std::ofstream;
// uses the oftream as our ostream
this->OutputHeaderStream = this->OutputHeaderFile;
this->OutputStream = this->OutputFile;
this->FileFormat = fileFormat;
this->SetDelimiter();
this->OutputFileName = fileName;
this->FirstRunningFlag = true;
this->SampleCounter = 0;
this->SampleCounterForEvent = 0;
// currently doesn't store fullpath if not using the default naming.
std::string headerFileName;
size_t pos = fileName.find_last_of(".");
if (pos != std::string::npos) {
headerFileName = fileName.substr(0,pos) + ".desc";
} else {
headerFileName = fileName + ".desc";
std::string ext;
switch (fileFormat) {
case COLLECTOR_FILE_FORMAT_CSV:
ext = ".csv";
break;
case COLLECTOR_FILE_FORMAT_PLAIN_TEXT:
ext = ".txt";
break;
default:
ext = ".cdat";
break;
}
this->OutputFileName = fileName + ext;
}
this->OutputHeaderFileName = headerFileName;
// initialize serializer
if (FileFormat == COLLECTOR_FILE_FORMAT_BINARY) {
// we need to create a serializer for each new file to
// serialize the type info
if (this->Serializer) {
delete this->Serializer;
}
Serializer = new cmnSerializer(StringStreamBufferForSerialization);
}
// set an appropriate delimiter according to the log file format.
switch (FileFormat) {
case COLLECTOR_FILE_FORMAT_CSV:
Delimiter = ',';
break;
case COLLECTOR_FILE_FORMAT_PLAIN_TEXT:
case COLLECTOR_FILE_FORMAT_BINARY:
default:
Delimiter = ' ';
break;
}
this->FileOpened = false;
}
void mtsCollectorBase::CloseOutput(void)
{
if (this->FileOpened) {
CMN_LOG_CLASS_INIT_VERBOSE << "CloseOutput: closing file \"" << this->OutputFileName << "\"" << std::endl;
this->OutputFile->close();
this->OutputHeaderFile->close();
this->FileOpened = false;
}
else {
CMN_LOG_CLASS_INIT_ERROR << "CloseOutput: file not open for \"" << this->GetName() << "\"" << std::endl;
}
}
void mtsCollectorBase::OpenFileIfNeeded(void)
{
if (this->FileOpened || (this->OutputFile == 0)) {
return;
}
// open the output file and update the internal stream pointer
switch (FileFormat) {
case COLLECTOR_FILE_FORMAT_CSV:
case COLLECTOR_FILE_FORMAT_PLAIN_TEXT:
CMN_LOG_CLASS_INIT_VERBOSE << "SetOutput: opening file \"" << this->OutputFileName << "\" in text/truncated mode" << std::endl;
this->OutputFile->open(this->OutputFileName.c_str(), std::ios::trunc);
// set parameters for the output stream!
this->SetOutputStreamParams();
this->OutputHeaderFile->open(this->OutputHeaderFileName.c_str(), std::ios::trunc);
this->FileOpened = true;
break;
// havnt changed the trunc /app option in the case below!!
case COLLECTOR_FILE_FORMAT_BINARY:
CMN_LOG_CLASS_INIT_VERBOSE << "SetOutput: opening file \"" << this->OutputFileName << "\" in binary/truncated mode" << std::endl;
this->OutputFile->open(this->OutputFileName.c_str(), std::ios::binary | std::ios::trunc);
this->OutputHeaderFile->open(this->OutputHeaderFileName.c_str(), std::ios::trunc);
this->FileOpened = true;
break;
default:
CMN_LOG_CLASS_INIT_ERROR << "SetOutput: unexpected file format.";
break;
}
if (!this->OutputStream->good()) {
CMN_LOG_CLASS_INIT_ERROR << "SetOutput: output stream is no good" << std::endl;
}
}
void mtsCollectorBase::SetOutputToDefault(const CollectorFileFormat fileFormat)
{
CMN_LOG_CLASS_INIT_DEBUG << "SetOutputDefault: using file format \"" << fileFormat << "\"" << std::endl;
std::string suffix;
if (fileFormat == COLLECTOR_FILE_FORMAT_PLAIN_TEXT) {
suffix = "txt";
} else if (fileFormat == COLLECTOR_FILE_FORMAT_CSV) {
suffix = "csv";
} else {
suffix = "cdat"; // for cisst dat
}
std::string fileName =
this->WorkingDirectoryMember
+ cmnPath::DirectorySeparator()
+ this->GetDefaultOutputName() + "." + suffix;
// add header file name
this->OutputHeaderFileName = this->WorkingDirectoryMember
+ cmnPath::DirectorySeparator()
+ this->GetDefaultOutputName() + ".desc" ;
this->SetOutput(fileName, fileFormat);
}
void mtsCollectorBase::SetOutputToDefault(void)
{
CollectorFileFormat fileFormat;
// if the format has never been defined use CSV as default
if (this->FileFormat == COLLECTOR_FILE_FORMAT_UNDEFINED) {
fileFormat = COLLECTOR_FILE_FORMAT_CSV;
} else {
// use whatever format was used before
fileFormat = this->FileFormat;
}
this->SetOutputToDefault(fileFormat);
}
void mtsCollectorBase::SetOutput(std::ostream & outputStream, const CollectorFileFormat fileFormat)
{
CMN_LOG_CLASS_INIT_DEBUG << "SetOutput: using user provided output stream with file format \"" << fileFormat << "\"" << std::endl;
// test if there was a file opened before
if (this->OutputFile) {
CMN_LOG_CLASS_INIT_VERBOSE << "SetOutput: closing file \"" << this->OutputFileName << "\"" << std::endl;
this->OutputFile->close();
}
// use whatever format was used before
this->FileFormat = fileFormat;
this->SetDelimiter();
this->Precision = outputStream.precision();
this->FillCharacter = outputStream.fill();
this->FirstRunningFlag = true;
this->SampleCounter = 0;
this->SampleCounterForEvent = 0;
// we are not using our own file
this->OutputFile = 0;
this->OutputFileName = std::string("using a stream");
this->OutputStream = &outputStream;
}
void mtsCollectorBase::SetOutput(std::ostream & outputStream)
{
CollectorFileFormat fileFormat;
// if the format has never been defined use CSV as default
if (this->FileFormat == COLLECTOR_FILE_FORMAT_UNDEFINED) {
fileFormat = COLLECTOR_FILE_FORMAT_CSV;
} else {
// use whatever format was used before
fileFormat = this->FileFormat;
}
this->SetOutput(outputStream, fileFormat);
}
void mtsCollectorBase::SetDelimiter(void)
{
if (this->FileFormat == COLLECTOR_FILE_FORMAT_PLAIN_TEXT) {
this->Delimiter = ' ';
} else if (this->FileFormat == COLLECTOR_FILE_FORMAT_CSV) {
this->Delimiter = ',';
} else {
this->Delimiter = ' ';
}
}
void mtsCollectorBase::SetWorkingDirectory(const std::string & directory)
{
this->WorkingDirectoryMember = directory;
}
void mtsCollectorBase::GetWorkingDirectory(std::string & placeHolder) const
{
placeHolder = this->WorkingDirectoryMember;
}
void mtsCollectorBase::SetOutputStreamParams(void)
{
// set floating point notation
switch (this->FloatingNotation) {
case COLLECTOR_FILE_FLOATING_NOTATION_NONE:
this->OutputStream->unsetf(std::ios::floatfield);
break;
case COLLECTOR_FILE_FLOATING_NOTATION_FIXED:
this->OutputStream->setf(std::ios::fixed, std::ios::floatfield);
break;
case COLLECTOR_FILE_FLOATING_NOTATION_SCIENTIFIC:
this->OutputStream->setf(std::ios::scientific, std::ios::floatfield);
break;
}
// set width
this->OutputStream->width(this->Width);
// set precision
this->OutputStream->precision(this->Precision);
// set fill character
this->OutputStream->fill(this->FillCharacter);
}
void mtsCollectorBase::SetOutputStreamFloatingNotation(const CollectorFileFloatingNotation floatingNotation)
{
this->FloatingNotation = floatingNotation;
if (this->Status == COLLECTOR_COLLECTING) {
CMN_LOG_CLASS_RUN_WARNING << "SetOutputStreamFloatingNotation: floating notation modified while collecting, the setting will only be applied to future files" << std::endl;
}
else {
CMN_LOG_CLASS_RUN_VERBOSE << "SetOutputStreamFloatingNotation: floating notation set to " << this->FloatingNotation << std::endl;
}
}
void mtsCollectorBase::SetOutputStreamPrecision(const int precision)
{
this->Precision = precision;
if (this->Status == COLLECTOR_COLLECTING) {
CMN_LOG_CLASS_RUN_WARNING << "SetOutputStreamPrecision: precision modified while collecting, the setting will only be applied to future files" << std::endl;
}
else {
CMN_LOG_CLASS_RUN_VERBOSE << "SetOutputStreamPrecision: precision set to " << this->Precision << std::endl;
}
}
void mtsCollectorBase::SetOutputStreamWidth(const int width)
{
this->Width = width;
if (this->Status == COLLECTOR_COLLECTING) {
CMN_LOG_CLASS_RUN_WARNING << "SetOutputStreamWidth: width modified while collecting, the setting will only be applied to future files" << std::endl;
}
else {
CMN_LOG_CLASS_RUN_VERBOSE << "SetOutputStreamWidth: width set to " << this->Width << std::endl;
}
}
void mtsCollectorBase::SetOutputStreamFill(const char fillCharacter)
{
this->FillCharacter = fillCharacter;
if (this->Status == COLLECTOR_COLLECTING) {
CMN_LOG_CLASS_RUN_WARNING << "SetOutputStreamFill: fill character modified while collecting, the setting will only be applied to future files" << std::endl;
}
else {
CMN_LOG_CLASS_RUN_VERBOSE << "SetOutputStreamFill: fill character set to " << fillCharacter << std::endl;
}
}
void mtsCollectorBase::Init(void)
{
Status = COLLECTOR_STOP;
ClearComponentMap();
}
void mtsCollectorBase::Cleanup(void)
{
ClearComponentMap();
}
//-------------------------------------------------------
// Miscellaneous Functions
//-------------------------------------------------------
void mtsCollectorBase::ClearComponentMap(void)
{
if (!ComponentMap.empty()) {
ComponentMapType::iterator itr = ComponentMap.begin();
SignalMapType::iterator _itr;
for (; itr != ComponentMap.end(); ++itr) {
itr->second->clear();
delete itr->second;
}
ComponentMap.clear();
}
}
|