Issue 18619: API correction required to src/hpp/dds/core/cond/TWaitSet.hpp (dds-psm-cxx-rtf) Source: Micro Focus (Mr. Simon McQueen, simon.mcqueen(at)microfocus.com) Nature: Revision Severity: Summary: Name: Simon McQueen Employer: PrismTech Specification: DDS CXX PSM RTF FormalNumber: ptc/12-10-03 Nature: Revision _Issues_: Code does not compile. Comments incorrect. _Suggested resolution_: diff --git a/src/hpp/dds/core/cond/TWaitSet.hpp b/src/hpp/dds/core/cond/TWaitSet.hpp index dfb05a2..a7fa3ee 100644 --- a/src/hpp/dds/core/cond/TWaitSet.hpp +++ b/src/hpp/dds/core/cond/TWaitSet.hpp @@ -22,7 +22,9 @@ #include <vector> #include <dds/core/types.hpp> +#include <dds/core/Duration.hpp> #include <dds/core/cond/Condition.hpp> +#include <dds/core/cond/WaitSet.hpp> namespace dds { namespace core { @@ -51,11 +53,6 @@ public: OMG_DDS_REF_TYPE(TWaitSet, dds::core::Reference, DELEGATE) public: - /** - * Creates a new waitset. - */ - TWaitSet(); - ~TWaitSet(); public: @@ -82,7 +79,7 @@ public: * @param timeout the maximum amount of time for which the wait * should block while waiting for a condition to be triggered. * - * @raise PreconditionNotMetException when multiple thread try to invoke + * @throws PreconditionNotMetException when multiple thread try to invoke * the method concurrently. * * @return a vector containing the triggered conditions @@ -95,11 +92,6 @@ public: * WaitSet have a trigger_value of TRUE, the wait operation will block * suspending the calling thread. * - * The wait operation takes a timeout argument that specifies the maximum - * duration for the wait. It this duration is exceeded and none of - * the attached Condition objects is true, wait will continue and the - * returned ConditionSeq will be empty. - * * It is not allowed for more than one application thread to be waiting * on the same WaitSet. If the wait operation is invoked on a WaitSet that * already has a thread blocking on it, the operation will raise @@ -109,10 +101,7 @@ public: * conditions that have a trigger_value of TRUE (i.e., the conditions * that unblocked the wait). * - * @param timeout the maximum amount of time for which the wait - * should block while waiting for a condition to be triggered. - * - * @raise PreconditionNotMetException when multiple thread try to invoke + * @throws PreconditionNotMetException when multiple thread try to invoke * the method concurrently. * * @return a vector containing the triggered conditions @@ -142,7 +131,7 @@ public: * @param timeout the maximum amount of time for which the wait * should block while waiting for a condition to be triggered. * - * @raise PreconditionNotMetException when multiple thread try to invoke + * @throws PreconditionNotMetException when multiple thread try to invoke * the method concurrently. * * @return a vector containing the triggered conditions @@ -173,7 +162,7 @@ public: * @param timeout the maximum amount of time for which the wait * should block while waiting for a condition to be triggered. * - * @raise PreconditionNotMetException when multiple thread try to invoke + * @throws PreconditionNotMetException when multiple thread try to invoke * the method concurrently. * * @return a vector containing the triggered conditions @@ -199,12 +188,12 @@ public: /** * A synonym for attach_condition. */ - WaitSet& operator +=(const dds::core::cond::Condition& cond); + TWaitSet& operator +=(const dds::core::cond::Condition& cond); /** * A synonym for detach_condition. */ - WaitSet& operator -=(const dds::core::cond::Condition& cond); + TWaitSet& operator -=(const dds::core::cond::Condition& cond); /** * Attaches a Condition to the WaitSet. It is possible to attach a @@ -216,7 +205,7 @@ public: * * @param cond the condition to be attached to this waitset. */ - WaitSet& attach_condition(const dds::core::cond::Condition& cond); + TWaitSet& attach_condition(const dds::core::cond::Condition& cond); /** * Detaches a Condition from the WaitSet. If the Condition was not Resolution: Revised Text: Actions taken: April 3, 2013: received issue Discussion: End of Annotations:===== ogle-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=x-received:message-id:date:from:user-agent:mime-version:to:subject :content-type:content-transfer-encoding:x-gm-message-state; bh=dJZADQIzj+9qqt8ImCc3R/0bBMfGCnuxa859z2Qz8co=; b=jl04nWjzdWqxBZWBPdbIJ4CRwk82+Hhpw7qS9jK/FLDipgJDos8wak8MfLBf7NVOBG Uy/owHlEM5dmedXHLRwe0kgVbBTUUjE5VnBYOA7aDZkpMg5aMVldKm3USJ8rf13YDiY/ OKzcSxmQcn14735j7EuRkr5/TehM4CWrtf7fUwuQhwaQRukpiaTJ6xSXC5CgOvqB+Lh1 zgv9tVw9araSR5e9wrRr6NfNTnJMTcojdGoX1Ip0/WX1EsDEkG3mvtcLCY4RDefd/XTq pC8SyDSjsSBnmC3+obRzl+CC7CVUBRhUSsbKeokImb4D8nMIOnYQOBLL3EoKKM1M8//V YuvA== X-Received: by 10.180.90.18 with SMTP id bs18mr23809269wib.31.1365007930097; Wed, 03 Apr 2013 09:52:10 -0700 (PDT) Date: Wed, 03 Apr 2013 17:52:03 +0100 From: Simon McQueen User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:17.0) Gecko/20130307 Thunderbird/17.0.4 To: issues@omg.org Subject: API correction required to src/hpp/dds/core/cond/TWaitSet.hpp X-Gm-Message-State: ALoCoQnOa6T56d6lub6aXsfU0LEE4LlEmqRUYYCFEF/618U9u3K5SIxMMDfPWunhNDhjHJP6dsDs X-Virus-Scanned: amavisd-new at omg.org X-Brightmail-Tracker: AAAAAA== X-Brightmail-Tracker: AAAAAA== Name: Simon McQueen Employer: PrismTech Specification: DDS CXX PSM RTF FormalNumber: ptc/12-10-03 Nature: Revision _Issues_: Code does not compile. Comments incorrect. _Suggested resolution_: diff --git a/src/hpp/dds/core/cond/TWaitSet.hpp b/src/hpp/dds/core/cond/TWaitSet.hpp index dfb05a2..a7fa3ee 100644 --- a/src/hpp/dds/core/cond/TWaitSet.hpp +++ b/src/hpp/dds/core/cond/TWaitSet.hpp @@ -22,7 +22,9 @@ #include #include +#include #include +#include namespace dds { namespace core { @@ -51,11 +53,6 @@ public: OMG_DDS_REF_TYPE(TWaitSet, dds::core::Reference, DELEGATE) public: - /** - * Creates a new waitset. - */ - TWaitSet(); - ~TWaitSet(); public: @@ -82,7 +79,7 @@ public: * @param timeout the maximum amount of time for which the wait * should block while waiting for a condition to be triggered. * - * @raise PreconditionNotMetException when multiple thread try to invoke + * @throws PreconditionNotMetException when multiple thread try to invoke * the method concurrently. * * @return a vector containing the triggered conditions @@ -95,11 +92,6 @@ public: * WaitSet have a trigger_value of TRUE, the wait operation will block * suspending the calling thread. * - * The wait operation takes a timeout argument that specifies the maximum - * duration for the wait. It this duration is exceeded and none of - * the attached Condition objects is true, wait will continue and the - * returned ConditionSeq will be empty. - * * It is not allowed for more than one application thread to be waiting * on the same WaitSet. If the wait operation is invoked on a WaitSet that * already has a thread blocking on it, the operation will raise @@ -109,10 +101,7 @@ public: * conditions that have a trigger_value of TRUE (i.e., the conditions * that unblocked the wait). * - * @param timeout the maximum amount of time for which the wait - * should block while waiting for a condition to be triggered. - * - * @raise PreconditionNotMetException when multiple thread try to invoke + * @throws PreconditionNotMetException when multiple thread try to invoke * the method concurrently. * * @return a vector containing the triggered conditions @@ -142,7 +131,7 @@ public: * @param timeout the maximum amount of time for which the wait * should block while waiting for a condition to be triggered. * - * @raise PreconditionNotMetException when multiple thread try to invoke + * @throws PreconditionNotMetException when multiple thread try to invoke * the method concurrently. * * @return a vector containing the triggered conditions @@ -173,7 +162,7 @@ public: * @param timeout the maximum amount of time for which the wait * should block while waiting for a condition to be triggered. * - * @raise PreconditionNotMetException when multiple thread try to invoke + * @throws PreconditionNotMetException when multiple thread try to invoke * the method concurrently. * * @return a vector containing the triggered conditions @@ -199,12 +188,12 @@ public: /** * A synonym for attach_condition. */ - WaitSet& operator +=(const dds::core::cond::Condition& cond); + TWaitSet& operator +=(const dds::core::cond::Condition& cond); /** * A synonym for detach_condition. */ - WaitSet& operator -=(const dds::core::cond::Condition& cond); + TWaitSet& operator -=(const dds::core::cond::Condition& cond); /** * Attaches a Condition to the WaitSet. It is possible to attach a @@ -216,7 +205,7 @@ public: * * @param cond the condition to be attached to this waitset. */ - WaitSet& attach_condition(const dds::core::cond::Condition& cond); + TWaitSet& attach_condition(const dds::core::cond::Condition& cond); /** * Detaches a Condition from the WaitSet. If the Condition was not