/* -*- 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): Ankur Kapoor, Peter Kazanzides, Anton Deguet Created on: 2005-05-02 (C) Copyright 2005-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 void mtsCommandQueuedWriteBase::ToStream(std::ostream & outputStream) const { outputStream << "mtsCommandQueuedWrite: MailBox \""; if (this->MailBox) { outputStream << this->MailBox->GetName(); } else { outputStream << "Undefined"; } outputStream << "\" for command " << *(this->ActualCommand) << " currently " << (this->IsEnabled() ? "enabled" : "disabled"); } mtsExecutionResult mtsCommandQueuedWriteBase::Execute(const mtsGenericObject & argument, mtsBlockingType blocking) { return Execute(argument, blocking, 0); } mtsBlockingType mtsCommandQueuedWriteBase::BlockingFlagGet(void) { return *(this->BlockingFlagQueue.Get()); } mtsCommandWriteBase *mtsCommandQueuedWriteBase::FinishedEventGet(void) { return *(this->FinishedEventQueue.Get()); } mtsCommandQueuedWriteGeneric::mtsCommandQueuedWriteGeneric(mtsMailBox * mailBox, mtsCommandWriteBase * actualCommand, size_t size): BaseType(mailBox, actualCommand, size), ArgumentQueueSize(size), ArgumentsQueue() { if (this->ActualCommand) { this->SetArgumentPrototype(ActualCommand->GetArgumentPrototype()); } const mtsGenericObject * argumentPrototype = this->GetArgumentPrototype(); if (argumentPrototype) { ArgumentsQueue.SetSize(size, *argumentPrototype); BlockingFlagQueue.SetSize(size, MTS_NOT_BLOCKING); mtsCommandWriteBase *cmd = 0; FinishedEventQueue.SetSize(size, cmd); } else { CMN_LOG_INIT_DEBUG << "Class mtsCommandQueuedWriteGeneric: constructor: can't find argument prototype from actual command \"" << this->GetName() << "\"" << std::endl; } } void mtsCommandQueuedWriteGeneric::Allocate(size_t size) { if (ArgumentsQueue.GetSize() != size) { if (ArgumentsQueue.GetSize() > 0) { // Probably should never happen CMN_LOG_INIT_WARNING << "Class mtsCommandQueuedWriteGeneric: Allocate: changing ArgumentsQueue size from " << ArgumentsQueue.GetSize() << " to " << size << std::endl; } const mtsGenericObject * argumentPrototype = this->GetArgumentPrototype(); if (argumentPrototype) { ArgumentsQueue.SetSize(size, *argumentPrototype); BlockingFlagQueue.SetSize(size, MTS_NOT_BLOCKING); mtsCommandWriteBase *cmd = 0; FinishedEventQueue.SetSize(size, cmd); } else { CMN_LOG_INIT_ERROR << "Class mtsCommandQueuedWriteGeneric: Allocate: can't find argument prototype from actual command \"" << this->GetName() << "\"" << std::endl; } } } mtsExecutionResult mtsCommandQueuedWriteGeneric::Execute(const mtsGenericObject & argument, mtsBlockingType blocking, mtsCommandWriteBase *finishedEventHandler) { // check if this command is enabled if (!this->IsEnabled()) { return mtsExecutionResult::COMMAND_DISABLED; } // check if there is a mailbox (i.e. if the command is associated to an interface) if (!MailBox) { CMN_LOG_RUN_ERROR << "Class mtsCommandQueuedWriteGeneric: Execute: no mailbox for \"" << this->Name << "\"" << std::endl; return mtsExecutionResult::COMMAND_HAS_NO_MAILBOX; } // check if all queues have some space if (ArgumentsQueue.IsFull() || BlockingFlagQueue.IsFull() || FinishedEventQueue.IsFull() || MailBox->IsFull()) { CMN_LOG_RUN_WARNING << "Class mtsCommandQueuedWriteGeneric: Execute: Queue full for \"" << this->Name << "\" [" << ArgumentsQueue.IsFull() << "|" << BlockingFlagQueue.IsFull() << "|" << FinishedEventQueue.IsFull() << "|" << MailBox->IsFull() << "]" << std::endl; return mtsExecutionResult::COMMAND_ARGUMENT_QUEUE_FULL; } // copy the argument to the local storage. if (!ArgumentsQueue.Put(argument)) { CMN_LOG_RUN_ERROR << "Class mtsCommandQueuedWriteGeneric: Execute: ArgumentsQueue.Put failed for \"" << this->Name << "\"" << std::endl; cmnThrow("mtsCommandQueuedWriteGeneric: Execute: ArgumentsQueue.Put failed"); return mtsExecutionResult::UNDEFINED; } // copy the blocking flag to the local storage. if (!BlockingFlagQueue.Put(blocking)) { CMN_LOG_RUN_ERROR << "Class mtsCommandQueuedWriteGeneric: Execute: BlockingFlagQueue.Put failed for \"" << this->Name << "\"" << std::endl; ArgumentsQueue.Get(); // Remove the argument that was already queued cmnThrow("mtsCommandQueuedWriteGeneric: Execute: BlockingFlagQueue.Put failed"); return mtsExecutionResult::UNDEFINED; } // copy the finished event handler to the local storage. if (!FinishedEventQueue.Put(finishedEventHandler)) { CMN_LOG_RUN_ERROR << "Class mtsCommandQueuedWriteGeneric: Execute: FinishedEventQueue.Put failed for \"" << this->Name << "\"" << std::endl; ArgumentsQueue.Get(); // Remove the argument that was already queued BlockingFlagQueue.Get(); // Remove the blocking flag that was already queued cmnThrow("mtsCommandQueuedWriteGeneric: Execute: FinishedEventQueue.Put failed"); return mtsExecutionResult::UNDEFINED; } // finally try to queue to mailbox if (!MailBox->Write(this)) { CMN_LOG_RUN_ERROR << "Class mtsCommandQueuedWriteGeneric: Execute: MailBox.Write failed for \"" << this->Name << "\"" << std::endl; ArgumentsQueue.Get(); // Remove the argument that was already queued BlockingFlagQueue.Get(); // Remove the blocking flag that was already queued FinishedEventQueue.Get(); // Remove the finished event handler that was already queued cmnThrow("mtsCommandQueuedWriteGeneric: Execute: MailBox.Write failed"); return mtsExecutionResult::UNDEFINED; } return mtsExecutionResult::COMMAND_QUEUED; } void mtsCommandQueuedWriteGeneric::ToStream(std::ostream & outputStream) const { outputStream << "mtsCommandQueuedWrite: MailBox \""; if (this->MailBox) { outputStream << this->MailBox->GetName(); } else { outputStream << "Undefined"; } outputStream << "\" for command " << *(this->ActualCommand) << " currently " << (this->IsEnabled() ? "enabled" : "disabled"); }