diff options
author | Kenji Hosokawa <khosokawa@jp.adit-jv.com> | 2020-10-23 13:04:49 +0900 |
---|---|---|
committer | Kenji Hosokawa <khosokawa@jp.adit-jv.com> | 2020-10-23 13:04:49 +0900 |
commit | 4680fc4332d939d852592c86546f7bca148dace7 (patch) | |
tree | fa1d71082e85e1bbcc6ba3686dfd372311cc8885 | |
parent | c0ecf677d8ac6ad5cd12e97a294e075f3f8cb249 (diff) |
Cosmetic changes to pass compilation
Signed-off-by: Kenji Hosokawa <khosokawa@jp.adit-jv.com>
42 files changed, 99 insertions, 96 deletions
@@ -11,9 +11,9 @@ This document describes build of Rule Based Arbitrator | rba/include/ | header files | | rba/src/ | source code files | | rba/lib/ | libraries | -| rba/lib/librba.a | Arbitrator staticl lib<br>(on Linux) | -| rba/lib/librba.so | Arbitrator shared lib<br>(on Linux) | -| rba/lib/rba.dll | Arbitrator DLL<br>(on Windows) | +| rba/lib/librba.a | Arbitrator staticl lib<br>(on Linux) | +| rba/lib/librba.so | Arbitrator shared lib<br>(on Linux) | +| rba/lib/rba.dll | Arbitrator DLL<br>(on Windows) | | rba/unittest/ | for unit test | | rba/doc/ | Documents | | rba/script/ | include script file | diff --git a/doc/RBA_IF_Specification.md b/doc/RBA_IF_Specification.md index daf2e61..6c5aa2c 100644 --- a/doc/RBA_IF_Specification.md +++ b/doc/RBA_IF_Specification.md @@ -14,9 +14,9 @@ ### Table of Contents
-[**1. Purpose of this document**](#anchor0)
+[**1. Purpose of this document**](#anchor0)
-[**2. Arbitration Policy Type class**](#anchor1)
+[**2. Arbitration Policy Type class**](#anchor1)
2.1. Definition name
2.2. Overview
2.3. Class member
diff --git a/include/rba/RBAArbitrator.hpp b/include/rba/RBAArbitrator.hpp index c7c2761..f3aa5d5 100644 --- a/include/rba/RBAArbitrator.hpp +++ b/include/rba/RBAArbitrator.hpp @@ -136,7 +136,7 @@ public: * Display request or sound request : "<CONTENT_NAME>/<STATE_NAME>"\n * If the content has only one state, the <STATE> can be omitted.\n * \n - * Scene request : ”<SCENE_NAME>” + * Scene request : "<SCENE_NAME>" * @param require * true : request displaying / outputting content or scene on (default)\n * false : withdraw a request or scene off. diff --git a/include/rba/RBAResult.hpp b/include/rba/RBAResult.hpp index 4a6766b..76fa4fb 100644 --- a/include/rba/RBAResult.hpp +++ b/include/rba/RBAResult.hpp @@ -96,7 +96,7 @@ public: * @return List of active view content states. * @details * The active view content states are those that have been requested to - * display so far. They do not include the view content state whose request + * display so far. They do not include the view content state whose request * has been withdrawn or canceled. */ virtual const std::list<const RBAViewContentState*>& getActiveViewContentStates() const=0; @@ -107,7 +107,7 @@ public: * @return List of active sound content states. * @details * The active sound content states are those that have been requested to - * output so far. They do not include the sound content state whose request + * output so far. They do not include the sound content state whose request * has been withdrawn or canceled. */ virtual const std::list<const RBASoundContentState*>& getActiveSoundContentStates() const=0; @@ -402,7 +402,7 @@ public: * @param area Area * @return The view content state allocated to the area. * @details - * Even if the area is hidden, Returns the allocated content state.\n + * Even if the area is hidden, Returns the allocated content state.\n * If no visible view content state is allocated the area, nullptr is returnd.\n * If area is not defined in the Model or nullptr, returns nullptr. */ @@ -414,7 +414,7 @@ public: * @param zone Zone * @return The sounding sound content state assign to the zone. * @details - * Even if the zone is muted, Returns the allocated content state.\n + * Even if the zone is muted, Returns the allocated content state.\n * If no sounding sound content state is allocated the area, * nullptr is returnd.\n * If zone is not defined in the Model or nullptr, returns nullptr. @@ -507,6 +507,7 @@ public: * @return UNKNOWN_CONTENT_STATE: Failed (The reuqest is unknown) * @return CANCEL_ERROR: Cancel arbitrration error * @endcond + */ virtual RBAResultStatusType getStatusType() const=0; /** @@ -522,6 +523,7 @@ public: * @details * If the scene or propertyName is not defined in the Model, returns -99.\n * @endcond + */ virtual std::int32_t getSceneProperty(const RBAScene* scene, const std::string& propertyName) const=0; // internal { @@ -556,7 +558,7 @@ public: * @return List of active view content states. * @details * The active view content states are those that have been requested to - * display so far. They do not include the view content state whose request + * display so far. They do not include the view content state whose request * has been withdrawn or canceled. */ virtual const std::list<const RBAViewContentState*>& getPreActiveViewContentStates() const=0; @@ -567,7 +569,7 @@ public: * @return List of active sound content states. * @details * The active sound content states are those that have been requested to - * output so far. They do not include the sound content state whose request + * output so far. They do not include the sound content state whose request * has been withdrawn or canceled. */ virtual const std::list<const RBASoundContentState*>& getPreActiveSoundContentStates() const=0; @@ -721,7 +723,7 @@ public: * @return true: Active * @return false: Not active * - * The active scene is the scene requested to ON. + * The active scene is the scene requested to ON. */ virtual bool isPreActive(const RBAScene* scene) const=0; @@ -789,7 +791,7 @@ public: * @param zone Zone * @return The sounding sound content state assign to the zone. * - * When a zone is muted, Returns the content state. + * When a zone is muted, Returns the content state. * If no sounding sound content state is allocated the area, * nullptr is returnd. */ diff --git a/include/rba/RBASoundContentState.hpp b/include/rba/RBASoundContentState.hpp index fdd22f5..7f35d39 100644 --- a/include/rba/RBASoundContentState.hpp +++ b/include/rba/RBASoundContentState.hpp @@ -35,7 +35,7 @@ protected: RBASoundContentState(RBASoundContentState&&)=delete; RBASoundContentState& operator=(const RBASoundContentState&)=delete; RBASoundContentState& operator=(RBASoundContentState&&)=delete; - ~RBASoundContentState()=default;音声コンテントクラス + ~RBASoundContentState()=default; public: /** @@ -66,7 +66,7 @@ public: * The order of the sound content state does not include the output request * of the view content state. */ - virtual std::int32_t getOrder() con音声コンテントクラスst=0; + virtual std::int32_t getOrder() const=0; /** * @brief Returns the unique character string of the sound contents state. diff --git a/src/BUILD.md b/src/BUILD.md index b47b9ac..2b0f5da 100644 --- a/src/BUILD.md +++ b/src/BUILD.md @@ -11,9 +11,9 @@ This document describes build of Rule Based Arbitrator | rba/include/ | header files | | rba/src/ | source code files | | rba/lib/ | libraries | -| rba/lib/librba.a | Arbitrator staticl lib<br>(on Linux) | -| rba/lib/librba.so | Arbitrator shared lib<br>(on Linux) | -| rba/lib/rba.dll | Arbitrator DLL<br>(on Windows) | +| rba/lib/librba.a | Arbitrator staticl lib<br>(on Linux) | +| rba/lib/librba.so | Arbitrator shared lib<br>(on Linux) | +| rba/lib/rba.dll | Arbitrator DLL<br>(on Windows) | | rba/unittest/ | for unit test | | rba/doc/ | Documents | | rba/script/ | include script file | diff --git a/src/CMakeSettings.json b/src/CMakeSettings.json index ed9cc6c..9536d41 100644 --- a/src/CMakeSettings.json +++ b/src/CMakeSettings.json @@ -1,6 +1,5 @@ { "configurations": [ - { "buildRoot": "${env.USERPROFILE}\\CMakeBuilds\\${workspaceHash}\\build\\${name}", "configurationType": "Release", "generator": "Visual Studio 15 2017 Win64", @@ -53,4 +52,4 @@ "installRoot": "${env.USERPROFILE}\\CMakeBuilds\\${workspaceHash}\\install\\${name}" } ] -}
\ No newline at end of file +} diff --git a/src/core/expression/RBAActionOperator.cpp b/src/core/expression/RBAActionOperator.cpp index 7cd38ec..299ba5e 100644 --- a/src/core/expression/RBAActionOperator.cpp +++ b/src/core/expression/RBAActionOperator.cpp @@ -15,7 +15,7 @@ */ /* - * Action operator class definition + * Action operator class definition */ #include "RBAActionOperator.hpp" diff --git a/src/core/expression/RBAExecuteResult.hpp b/src/core/expression/RBAExecuteResult.hpp index 1eaf2a5..0dc7591 100644 --- a/src/core/expression/RBAExecuteResult.hpp +++ b/src/core/expression/RBAExecuteResult.hpp @@ -30,7 +30,7 @@ enum class RBAExecuteResult : std::uint8_t FALSE, EXE, // In case of action is performed by doAction() // (Excludes SetOfAction and IfAction) - NOTEXE, // In case of action is NOT performed by doAction() + NOTEXE, // In case of action is NOT performed by doAction() // (Excludes SetOfAction and IfAction) SKIP // In case of getValue() or getReferenceObject() }; diff --git a/src/core/expression/RBAExpressionMaker.hpp b/src/core/expression/RBAExpressionMaker.hpp index 282a093..644b4fa 100644 --- a/src/core/expression/RBAExpressionMaker.hpp +++ b/src/core/expression/RBAExpressionMaker.hpp @@ -40,7 +40,7 @@ public: virtual ~RBAExpressionMaker()=default; protected: - /// @brief To set ”Let" expression + /// @brief To set "Let" expression /// @details Generate Let expression from jsonElem and register it in expr. /// Return the number of variables that have been registered /// (pushed) to ModelFactory, and pop them when the reference of diff --git a/src/core/expression/RBAExpressionVisitor.hpp b/src/core/expression/RBAExpressionVisitor.hpp index e678b42..72a742c 100644 --- a/src/core/expression/RBAExpressionVisitor.hpp +++ b/src/core/expression/RBAExpressionVisitor.hpp @@ -102,11 +102,11 @@ class RBAExpressionVisitor { // Refer to Zone status virtual void visit(RBAIsOutputted& exp) = 0; virtual void visit(RBAOutputtingSound& exp) = 0; - // allocatedContent is common with Area + // allocatedContent is common with Area virtual void visit(RBAIsMuted& exp) = 0; virtual void visit(RBAIsAttenuated& exp) = 0; // contentValue is common with Area - // contentsList is common with Area + // contentsList is common with Area // Refer to sound content status // isActive is common with display content diff --git a/src/core/expression/RBAForAllOperatorMaker.cpp b/src/core/expression/RBAForAllOperatorMaker.cpp index eb1068d..1e5579b 100644 --- a/src/core/expression/RBAForAllOperatorMaker.cpp +++ b/src/core/expression/RBAForAllOperatorMaker.cpp @@ -15,7 +15,7 @@ */ /// @file RBAForAllOperatorMaker.cpp -/// @brief ForAllOperator object generation class +/// @brief ForAllOperator object generation class #include "RBAForAllOperatorMaker.hpp" #include "RBAJsonElement.hpp" diff --git a/src/core/expression/RBAForAllOperatorMaker.hpp b/src/core/expression/RBAForAllOperatorMaker.hpp index 9c5de92..68028fb 100644 --- a/src/core/expression/RBAForAllOperatorMaker.hpp +++ b/src/core/expression/RBAForAllOperatorMaker.hpp @@ -15,7 +15,7 @@ */ /// @file RBAForAllOperatorMaker.hpp -/// @brief ForAllOperator object generation class header +/// @brief ForAllOperator object generation class header #ifndef RBAFORALLOPERATORMAKER_HPP #define RBAFORALLOPERATORMAKER_HPP @@ -25,7 +25,7 @@ namespace rba { -/// @brief ForAllOperator object generation class +/// @brief ForAllOperator object generation class class RBAForAllOperatorMaker : public RBALambdaContextMaker { public: diff --git a/src/core/expression/RBAGetAllocatables.cpp b/src/core/expression/RBAGetAllocatables.cpp index 8494a01..18d4cf4 100644 --- a/src/core/expression/RBAGetAllocatables.cpp +++ b/src/core/expression/RBAGetAllocatables.cpp @@ -87,7 +87,7 @@ RBAGetAllocatables::getExpressionText() const void RBAGetAllocatables::createHierarchy() { - // No operation because it does not affect structure. + // No operation because it does not affect structure. } #endif diff --git a/src/core/expression/RBAGetContentsList.cpp b/src/core/expression/RBAGetContentsList.cpp index 5f14b33..c106d5f 100644 --- a/src/core/expression/RBAGetContentsList.cpp +++ b/src/core/expression/RBAGetContentsList.cpp @@ -79,7 +79,7 @@ RBAGetContentsList::getReferenceObjectCore(RBAConstraintInfo* info, void RBAGetContentsList::createHierarchy() { - // No operation because it does not affect structure. + // No operation because it does not affect structure. } #endif diff --git a/src/core/expression/RBAHasComeEarlierThan.cpp b/src/core/expression/RBAHasComeEarlierThan.cpp index 4b5482a..ae15a2c 100644 --- a/src/core/expression/RBAHasComeEarlierThan.cpp +++ b/src/core/expression/RBAHasComeEarlierThan.cpp @@ -49,7 +49,7 @@ RBAHasComeEarlierThan::executeCore(RBAConstraintInfo* info, LOG_addHierarchy(LOG_getSymbol()); bool isResult {false}; - // Get content in left side of the expression + // Get content in left side of the expression RBAConstraintInfo* const leftInfo {info->getChild(0U)}; const RBARuleObject* ruleObj {getLhsOperand()->getReferenceObject(leftInfo, arb)}; const RBAContent* contentLhs {nullptr}; @@ -57,7 +57,7 @@ RBAHasComeEarlierThan::executeCore(RBAConstraintInfo* info, contentLhs = dynamic_cast<const RBAContent*>(ruleObj->getRawObject()); } - // Get content in right hand side of the expression + // Get content in right hand side of the expression RBAConstraintInfo* const rightInfo {info->getChild(1U)}; ruleObj = getRhsOperand()->getReferenceObject(rightInfo, arb); const RBAContent* contentRhs {nullptr}; diff --git a/src/core/expression/RBAIsOn.cpp b/src/core/expression/RBAIsOn.cpp index f8dd769..af60c20 100644 --- a/src/core/expression/RBAIsOn.cpp +++ b/src/core/expression/RBAIsOn.cpp @@ -63,8 +63,8 @@ RBAIsOn::executeCore(RBAConstraintInfo* info, } } else { // Currently, there is no expression that returns null as "Scene", - // so it does not go through this path. But an expression that returns null - // may be added in the future, so it is described as it is. + // so it does not go through this path. But an expression that returns null + // may be added in the future, so it is described as it is. ; } #ifdef RBA_USE_LOG @@ -91,8 +91,8 @@ RBAIsOn::executeCore(RBAConstraintInfo* info, } } else { // Currently, there is no expression that returns null as "Scene", - // so it does not go through this path. But an expression that returns null - // may be added in the future, so it is described as it is. + // so it does not go through this path. But an expression that returns null + // may be added in the future, so it is described as it is. LOG_arbitrateConstraintLogicLogLine( " " + getPreMsg(ruleObj->isPrevious()) + "Scene[NULL] is not On"); LOG_coverageConstraintExpressionLog(LOG_getCoverageExpressionText(), diff --git a/src/core/expression/RBAIsTypeOfOperator.cpp b/src/core/expression/RBAIsTypeOfOperator.cpp index 2104f43..7520f26 100644 --- a/src/core/expression/RBAIsTypeOfOperator.cpp +++ b/src/core/expression/RBAIsTypeOfOperator.cpp @@ -15,7 +15,7 @@ */ // -// IsTypeOf class defintion file +// IsTypeOf class definition file // #include "RBAIsTypeOfOperator.hpp" diff --git a/src/core/expression/RBAIsTypeOfOperator.hpp b/src/core/expression/RBAIsTypeOfOperator.hpp index ce4d213..e91c8e0 100644 --- a/src/core/expression/RBAIsTypeOfOperator.hpp +++ b/src/core/expression/RBAIsTypeOfOperator.hpp @@ -15,7 +15,7 @@ */ // -// IsTypeOfクラスヘッダファイル +// IsTypeOf class header file // #ifndef RBAISTYPEOFOPERATOR_HPP diff --git a/src/core/expression/RBALogicalOperator.cpp b/src/core/expression/RBALogicalOperator.cpp index e931b7a..9e39e97 100644 --- a/src/core/expression/RBALogicalOperator.cpp +++ b/src/core/expression/RBALogicalOperator.cpp @@ -16,7 +16,7 @@ */ /** - * 論理オペレータクラス定義ファイル + * LogicalOperator class definition */ #include <sstream> diff --git a/src/core/expression/RBAObjectCompare.cpp b/src/core/expression/RBAObjectCompare.cpp index 65bee04..5ed900c 100644 --- a/src/core/expression/RBAObjectCompare.cpp +++ b/src/core/expression/RBAObjectCompare.cpp @@ -74,7 +74,7 @@ RBAObjectCompare::executeCore(RBAConstraintInfo* info, if ((lhobj != nullptr) && (rhobj != nullptr)) { if (lhobj->getRawObject() == rhobj->getRawObject()) { isPassed = true; - // Even if re-arbitration is performed for "ObjectCompare" that uses + // Even if re-arbitration is performed for "ObjectCompare" that uses // "ObjectRefrence" as an operand, the evaluation result does not // change from false to True, so it is not necessary to add // "FalseAllocatable" or "TrueAllocatabe" for re-arbitration. diff --git a/src/core/expression/RBAStateValue.cpp b/src/core/expression/RBAStateValue.cpp index f2fe5cb..77d14b5 100644 --- a/src/core/expression/RBAStateValue.cpp +++ b/src/core/expression/RBAStateValue.cpp @@ -33,7 +33,7 @@ void RBAStateValue::accept(RBAExpressionVisitor& visitor) { // RBASceneAllocatableCollector which is the only existing vistor // does not pass this path because it does not accept - // the expression that returns Value. But, in the future, + // the expression that returns Value. But, in the future, // another visitor may accept, so implement this. visitor.visit(*this); } diff --git a/src/core/logic/RBAAffectInfo.cpp b/src/core/logic/RBAAffectInfo.cpp index 6cf4e98..2186ad2 100644 --- a/src/core/logic/RBAAffectInfo.cpp +++ b/src/core/logic/RBAAffectInfo.cpp @@ -55,8 +55,8 @@ RBAAffectInfo::addInfoThatFormerAffectedToLatter(const RBAAllocatable* const all /** * @brief Deletes the Affect information of "allocatable" registered by - * other allocatables registered by arbitration of the specified - * recursion hierarchy of the specified "allocatable". + * other allocatables registered by arbitration of the specified + * recursion hierarchy of the specified "allocatable". * @param affectAllocatable */ void RBAAffectInfo::removeAffectInfo(const RBAAllocatable* const affectAllocatable) diff --git a/src/core/logic/RBAArbitrator.cpp b/src/core/logic/RBAArbitrator.cpp index 9fdd7d3..74db3aa 100644 --- a/src/core/logic/RBAArbitrator.cpp +++ b/src/core/logic/RBAArbitrator.cpp @@ -510,7 +510,7 @@ RBAArbitrator::arbitrateMain() result_ = std::make_unique<RBAResultImpl>(retResult.get()); // A compile error occurs if std::move() is missing because - // std::unique_ptr<RBAResultImpl> is cast to std::unique_ptr<RBAResult> + // std::unique_ptr<RBAResultImpl> is cast to std::unique_ptr<RBAResult> return std::move(retResult); } @@ -659,7 +659,7 @@ arbitrate(std::list<RBAAllocatable*>& allocatables) revisited = revisitedInitSet; // ------------------------------------------------------------------------- // To prevent an infinite loop, generate information to limit registration - // of other "allocable" that affected the target "allocatable" + // of other "allocable" that affected the target "allocatable" // during arbitration // ------------------------------------------------------------------------- RBAAffectInfo affectInfo; @@ -825,7 +825,7 @@ void RBAArbitrator::arbitrateAllocatable( } } // --------------------------------------------------------------------- - // Re-arbitration of the Allocatable that influenced + // Re-arbitration of the Allocatable that influenced // --------------------------------------------------------------------- if ((beforeState != allocatable->getState()) || allocatable->isHidden() @@ -876,7 +876,7 @@ void RBAArbitrator::arbitrateAllocatable( // This is a 'const_cast' expression that strips away a 'const' or // 'volatile' qualifier. // [Why there is no problem if it deviate from the rules] - // Confirmed that there is no problem from the design point of view. + // Confirmed that there is no problem from the design point of view. // We won't fix it now because we need to redesign the class, but // no much effort as of now. RBAAllocatable* allo {const_cast<RBAAllocatable*>(affectAllocatable)}; @@ -970,7 +970,7 @@ collectRevisitAllocatable(std::list<const RBAAllocatable*>* const totalRevisitAl { std::set<const RBAAllocatable*> revisitAllocatablesSet; - // Determine if re-arbitration should be done based on the constraint + // Determine if re-arbitration should be done based on the constraint // that the determination was NG for(RBAConstraintImpl*& constraint : falseConstraints) { // Get Contraint information @@ -982,7 +982,7 @@ collectRevisitAllocatable(std::list<const RBAAllocatable*>* const totalRevisitAl info->collectRearbitrationTargetFor(allocatable, rightFalseAllocatables, false); } if (rightFalseAllocatables.empty()) { - // Non-implication constraint expression + // Non-implication constraint expression // To ensure that "currently arbitrated allocable" does not lose to lower // priority allocable, arbitration of low priority Allocable is performed // if low priority Allocable is included in @@ -1211,7 +1211,7 @@ updateResult() // Deactivate canceled Content result_->updateActiveContentStates(); - // Update coordinates of Area + // Update coordinates of Area for(auto& area : result_->getVisibleAreas()) { const RBAAreaImpl* const areaImpl {dynamic_cast<const RBAAreaImpl*>(area)}; const auto posCont = model_->findPositionContainerImpl(area->getName()); diff --git a/src/core/logic/RBAConstraintInfo.cpp b/src/core/logic/RBAConstraintInfo.cpp index b208c5f..8614394 100644 --- a/src/core/logic/RBAConstraintInfo.cpp +++ b/src/core/logic/RBAConstraintInfo.cpp @@ -135,7 +135,7 @@ void RBAConstraintInfo::clear() // @Deviation (MEM05-CPP,Rule-7_5_4,A7-5-2) // [Contents that deviate from the rules] // recursively calling clear() - // [Reason that there is no problem if the rule is deviated] + // [Reason that there is no problem if the rule is deviated] // ConstraintInfo is created for each node in the Constraint expression // tree. The Constraint expression tree is determined by the constraint // expressions written in the model file, and its depth is finite. @@ -177,7 +177,7 @@ bool RBAConstraintInfo::needsReRearbitrationFor( // [Contents that deviate from the rules] // Function '::rba::RBAConstraintInfo::needsReRearbitrationFor=(_, // p={c::rba::RBAAllocatable})' is recursive. - // [Reason that there is no problem if the rule is deviated] + // [Reason that there is no problem if the rule is deviated] // Recursive call is required as a feature result = children_.back()->needsReRearbitrationFor(allocatable); } @@ -198,7 +198,7 @@ bool RBAConstraintInfo::needsReRearbitrationFor( bool RBAConstraintInfo::needsRearbitrationFor(const RBAAllocatable* const allocatable, bool isImplies) const { - bool result {false}; // 再調停要否 + bool result {false}; // Necessity of re-arbitration if (children_.empty() == false) { // When the syntax of the constraint expression is // - ImpliesOperator @@ -248,13 +248,13 @@ bool RBAConstraintInfo::needsRearbitrationFor(const RBAAllocatable* const alloca // [Contents that deviate from the rules] // Function '::rba::RBAConstraintInfo::needsRearbitrationFor=(_, // p={c::rba::RBAAllocatable},_o)' is recursive. - // [Reason that there is no problem if the rule is deviated] + // [Reason that there is no problem if the rule is deviated] // Recursive call is required as a feature result = (result || child->needsRearbitrationFor(allocatable, isImplies)); } // The Constraint expression does not include IF or implication, // or - // the Allocatable state reference expression is not included in the + // the Allocatable state reference expression is not included in the // left side of the IF condition of the parent syntax or // the implication of the parent syntax, // or @@ -333,7 +333,7 @@ void RBAConstraintInfo::collectRearbitrationTargetFor( // Function '::rba::RBAConstraintInfo::collectRearbitrationTargetFor=(_,p={c::rba::RBAAllocatable}, // &{c::std::set<p={c::rba::RBAAllocatable},{c::std::less<p={c::rba::RBAAllocatable}>}, // {c::std::allocator<p={c::rba::RBAAllocatable}>}>},_o)' is recursive. - // [Reason that there is no problem if the rule is deviated] + // [Reason that there is no problem if the rule is deviated] // Recursive call is required as a feature children_.front()->collectRearbitrationTargetFor(allocatable, targets, !isNot); @@ -374,7 +374,7 @@ void RBAConstraintInfo::collectTrueAllocatables( // &{c::std::set<p={c::rba::RBAAllocatable}, // {c::std::less<p={c::rba::RBAAllocatable}>}, // {c::std::allocator<p={c::rba::RBAAllocatable}>}>})' is recursive. - // [Reason that there is no problem if the rule is deviated] + // [Reason that there is no problem if the rule is deviated] // Recursive call is required as a feature child->collectTrueAllocatables(allocatables); } @@ -411,7 +411,7 @@ void RBAConstraintInfo::collectFalseAllocatables( // {c::std::less<p={c::rba::RBAAllocatable}>}, // {c::std::allocator<p={c::rba::RBAAllocatable}>}>})' // is recursive. - // [Reason that there is no problem if the rule is deviated] + // [Reason that there is no problem if the rule is deviated] // Recursive call is required as a feature child->collectFalseAllocatables(allocatables); } @@ -440,7 +440,7 @@ bool RBAConstraintInfo::contains(const RBAAllocatable* const allocatable) const // Function '::rba::RBAConstraintInfo::contains=(_, // p={c::rba::RBAAllocatable})' // is recursive. - // [Reason that there is no problem if the rule is deviated] + // [Reason that there is no problem if the rule is deviated] // Recursive call is required as a feature if (child->contains(allocatable)) { return true; @@ -489,7 +489,7 @@ void RBAConstraintInfo::collectAffectedAllocatables( // the same processing is performed, because "Exists {A,B}{x|x.isXXX}" // is equivalent to "A.isXXX OR B.isXXX" if (!isRevert) { - // Processing when "Info" of "OR" in which evaluation result that is not + // Processing when "Info" of "OR" in which evaluation result that is not // qualified by an odd number of negative is "Skip" or evaluation reslt // that is not qualified by an odd number of negative is "False". if (!isTrue()) { @@ -507,7 +507,7 @@ void RBAConstraintInfo::collectAffectedAllocatables( } } } else { - // Processing when "Info" of "OR" in which evaluation result that is not + // Processing when "Info" of "OR" in which evaluation result that is not // qualified by an odd number of negative is "Skip" or evaluation reslt // that is not qualified by an odd number of negative is "False". // "!(A.isXXX OR B.isXXX)" can be decomposed into @@ -526,7 +526,7 @@ void RBAConstraintInfo::collectAffectedAllocatables( //"For-All {A,B}{x|x.isXXX}" is equivalent to "A.isXXX AND B.isXXX", // so the same processing is performed if (isRevert) { - // Processing when "Info" of "AND" in which evaluation result that + // Processing when "Info" of "AND" in which evaluation result that // is not qualified by an odd number of "negative" is "Skip" or // evaluation reslt that is not qualified by an odd number of negative // is "True". @@ -540,21 +540,21 @@ void RBAConstraintInfo::collectAffectedAllocatables( // [Contents that deviate from the rules] // Function '::rba::RBAConstraintInfo::collectAffectedAllocatables(_,_o,&{c::std::set<p={c::rba::RBAAllocatable}, // {c::std::less<p={c::rba::RBAAllocatable}>},{c::std::allocator<p={c::rba::RBAAllocatable}>}>},_o)' is recursive. - // [Reason that there is no problem if the rule is deviated] + // [Reason that there is no problem if the rule is deviated] // Recursive call is required as a feature i->collectAffectedAllocatables(isRevert, affectAllocatables, true, forObject); } } } else { - // Processing when "Info" of "AND" in which evaluation result that + // Processing when "Info" of "AND" in which evaluation result that // is not qualified by an odd number of "negative" is "Skip" or // evaluation reslt that is not qualified by an odd number of negative // is "True". // // When "A.isXXX AND B.isXXX", the evaluation result of "AND" does not // become True unless the evaluation result of B becomes True, - // regardless of the evaluation result of A. Therefore, A does not + // regardless of the evaluation result of A. Therefore, A does not // affect B, and B does not affect A. // Therefore, "collecting" is as it is, and the "child Info" is // searched for an allocable influence. diff --git a/src/core/logic/RBAResultSet.cpp b/src/core/logic/RBAResultSet.cpp index bcc9892..d516406 100644 --- a/src/core/logic/RBAResultSet.cpp +++ b/src/core/logic/RBAResultSet.cpp @@ -267,7 +267,7 @@ RBAResultSet::getArea(const RBAViewContentState* const state, // @Deviation (MEM05-CPP,Rule-7_5_4,A7-5-2) // [Contents that deviate from the rules] // calling getArea() recursively - // [Reason that there is no problem if the rule is deviated] + // [Reason that there is no problem if the rule is deviated] // When getArea() is performed on CyclicContent, at that time, // respond Area where ViewContent assigned to CyclicContent // is assigned. When CyclicContent is assigned to CyclicContent, @@ -301,7 +301,7 @@ RBAResultSet::getZone(const RBASoundContentState* const state, // &{c::std::__cxx11::list<p={c::rba::RBAZone}, // {c::std::allocator<p={c::rba::RBAZone}>}>})' // is recursive. - // [Reason that there is no problem if the rule is deviated] + // [Reason that there is no problem if the rule is deviated] // Recursive call is required as a feature getZone(ownerState, zoneList); } else { diff --git a/src/core/model/RBAModelElementMaker.cpp b/src/core/model/RBAModelElementMaker.cpp index 9d750c0..1a5a649 100644 --- a/src/core/model/RBAModelElementMaker.cpp +++ b/src/core/model/RBAModelElementMaker.cpp @@ -83,7 +83,7 @@ RBAModelElementMaker::getInstance(RBAModelImpl* model, } // In case of Elemetn with name - if(fullName != "") { + if(fullName != "") { const auto elem = model->findModelElement(fullName); // exists in model if(elem != nullptr) { diff --git a/src/core/model/RBARuleObject.cpp b/src/core/model/RBARuleObject.cpp index 62aa1a5..a3eddde 100644 --- a/src/core/model/RBARuleObject.cpp +++ b/src/core/model/RBARuleObject.cpp @@ -90,7 +90,7 @@ RBARuleObject::getUniqueName() const // [Contents that deviate from the rules] // Calling getUniqueName() recursively. // [Reason that there is no problem if the rule is deviated] - // Since the number of elements in the rule model is finite and + // Since the number of elements in the rule model is finite and // there is no cyclic relationship, stack overflow does not occur. return owner_->getUniqueName() + "/" + getElementName(); } diff --git a/src/core/model/RBASceneMaker.cpp b/src/core/model/RBASceneMaker.cpp index 9c55f84..e4a44d0 100644 --- a/src/core/model/RBASceneMaker.cpp +++ b/src/core/model/RBASceneMaker.cpp @@ -14,7 +14,7 @@ * limitations under the License. */ /// @file RBASceneMaker.cpp -/// @brief Scene object generator class +/// @brief Scene object generator class #include "RBASceneMaker.hpp" #include "RBASceneImpl.hpp" diff --git a/src/core/model/RBASceneMaker.hpp b/src/core/model/RBASceneMaker.hpp index 6d2ea5e..a619bfe 100644 --- a/src/core/model/RBASceneMaker.hpp +++ b/src/core/model/RBASceneMaker.hpp @@ -14,7 +14,7 @@ * limitations under the License. */ /// @file RBASceneMaker.hpp -/// @brief Scene object generator class header +/// @brief Scene object generator class header #ifndef RBASCENEMAKER_HPP #define RBASCENEMAKER_HPP @@ -24,7 +24,7 @@ namespace rba { -/// @brief Scene object generator class +/// @brief Scene object generator class class RBASceneMaker : public RBARuleObjectMaker { public: diff --git a/src/doc/RBA_IF_Specification.md b/src/doc/RBA_IF_Specification.md index daf2e61..6c5aa2c 100644 --- a/src/doc/RBA_IF_Specification.md +++ b/src/doc/RBA_IF_Specification.md @@ -14,9 +14,9 @@ ### Table of Contents
-[**1. Purpose of this document**](#anchor0)
+[**1. Purpose of this document**](#anchor0)
-[**2. Arbitration Policy Type class**](#anchor1)
+[**2. Arbitration Policy Type class**](#anchor1)
2.1. Definition name
2.2. Overview
2.3. Class member
diff --git a/src/factory/RBAJsonElement.hpp b/src/factory/RBAJsonElement.hpp index a5fcc8e..e317ef2 100644 --- a/src/factory/RBAJsonElement.hpp +++ b/src/factory/RBAJsonElement.hpp @@ -35,7 +35,7 @@ enum class RBAContentLoserType : std::uint8_t; enum class RBAExpressionType : std::uint8_t; #endif -/// @brief JSONエ Element class +/// @brief JSON Element class class DLL_EXPORT RBAJsonElement { public: diff --git a/src/factory/RBAJsonParserImpl.cpp b/src/factory/RBAJsonParserImpl.cpp index db65367..a883609 100644 --- a/src/factory/RBAJsonParserImpl.cpp +++ b/src/factory/RBAJsonParserImpl.cpp @@ -80,7 +80,7 @@ parse(const std::string& filename) return nullptr; } - // Create map between Area and Costraint + // Create map between Area and Costraint createConstraintMap(root->findChildren("area_constraint_map"), RBAConstraintMap::CONTENT_ALLOCATE_CONSTRAINTS); createConstraintMap(root->findChildren("area_hidden_true_check_constraint_map"), @@ -88,7 +88,7 @@ parse(const std::string& filename) createConstraintMap(root->findChildren("area_hidden_false_check_constraint_map"), RBAConstraintMap::HIDDEN_FALSE_CHECK_CONSTRAINTS); - // Create map between Zone and Costraint + // Create map between Zone and Costraint createConstraintMap(root->findChildren("zone_constraint_map"), RBAConstraintMap::CONTENT_ALLOCATE_CONSTRAINTS); createConstraintMap(root->findChildren("zone_mute_true_check_constraint_map"), diff --git a/src/factory/RBAJsonParserImpl.hpp b/src/factory/RBAJsonParserImpl.hpp index 533f894..4744571 100644 --- a/src/factory/RBAJsonParserImpl.hpp +++ b/src/factory/RBAJsonParserImpl.hpp @@ -15,7 +15,7 @@ */ /// @file RBAJsonParserImpl.hpp -/// @brief JSON Parser implementation class header file +/// @brief JSON Parser implementation class header file #ifndef RBAJSONPARSERIMPL_HPP #define RBAJSONPARSERIMPL_HPP @@ -30,7 +30,7 @@ namespace rba class RBAJsonElement; enum class RBAConstraintMap : std::uint8_t; -/// @brief JSON Parser implementation class +/// @brief JSON Parser implementation class class RBAJsonParser::Impl { public: diff --git a/src/include/rba/RBAArbitrator.hpp b/src/include/rba/RBAArbitrator.hpp index c7c2761..f3aa5d5 100644 --- a/src/include/rba/RBAArbitrator.hpp +++ b/src/include/rba/RBAArbitrator.hpp @@ -136,7 +136,7 @@ public: * Display request or sound request : "<CONTENT_NAME>/<STATE_NAME>"\n * If the content has only one state, the <STATE> can be omitted.\n * \n - * Scene request : ”<SCENE_NAME>” + * Scene request : "<SCENE_NAME>" * @param require * true : request displaying / outputting content or scene on (default)\n * false : withdraw a request or scene off. diff --git a/src/include/rba/RBAResult.hpp b/src/include/rba/RBAResult.hpp index 4a6766b..9d05e56 100644 --- a/src/include/rba/RBAResult.hpp +++ b/src/include/rba/RBAResult.hpp @@ -96,7 +96,7 @@ public: * @return List of active view content states. * @details * The active view content states are those that have been requested to - * display so far. They do not include the view content state whose request + * display so far. They do not include the view content state whose request * has been withdrawn or canceled. */ virtual const std::list<const RBAViewContentState*>& getActiveViewContentStates() const=0; @@ -107,7 +107,7 @@ public: * @return List of active sound content states. * @details * The active sound content states are those that have been requested to - * output so far. They do not include the sound content state whose request + * output so far. They do not include the sound content state whose request * has been withdrawn or canceled. */ virtual const std::list<const RBASoundContentState*>& getActiveSoundContentStates() const=0; @@ -402,7 +402,7 @@ public: * @param area Area * @return The view content state allocated to the area. * @details - * Even if the area is hidden, Returns the allocated content state.\n + * Even if the area is hidden, Returns the allocated content state.\n * If no visible view content state is allocated the area, nullptr is returnd.\n * If area is not defined in the Model or nullptr, returns nullptr. */ @@ -414,7 +414,7 @@ public: * @param zone Zone * @return The sounding sound content state assign to the zone. * @details - * Even if the zone is muted, Returns the allocated content state.\n + * Even if the zone is muted, Returns the allocated content state.\n * If no sounding sound content state is allocated the area, * nullptr is returnd.\n * If zone is not defined in the Model or nullptr, returns nullptr. @@ -507,6 +507,7 @@ public: * @return UNKNOWN_CONTENT_STATE: Failed (The reuqest is unknown) * @return CANCEL_ERROR: Cancel arbitrration error * @endcond + */ virtual RBAResultStatusType getStatusType() const=0; /** @@ -522,6 +523,7 @@ public: * @details * If the scene or propertyName is not defined in the Model, returns -99.\n * @endcond + */ virtual std::int32_t getSceneProperty(const RBAScene* scene, const std::string& propertyName) const=0; // internal { @@ -556,7 +558,7 @@ public: * @return List of active view content states. * @details * The active view content states are those that have been requested to - * display so far. They do not include the view content state whose request + * display so far. They do not include the view content state whose request * has been withdrawn or canceled. */ virtual const std::list<const RBAViewContentState*>& getPreActiveViewContentStates() const=0; @@ -567,7 +569,7 @@ public: * @return List of active sound content states. * @details * The active sound content states are those that have been requested to - * output so far. They do not include the sound content state whose request + * output so far. They do not include the sound content state whose request * has been withdrawn or canceled. */ virtual const std::list<const RBASoundContentState*>& getPreActiveSoundContentStates() const=0; @@ -721,7 +723,7 @@ public: * @return true: Active * @return false: Not active * - * The active scene is the scene requested to ON. + * The active scene is the scene requested to ON. */ virtual bool isPreActive(const RBAScene* scene) const=0; @@ -789,7 +791,7 @@ public: * @param zone Zone * @return The sounding sound content state assign to the zone. * - * When a zone is muted, Returns the content state. + * When a zone is muted, Returns the content state. * If no sounding sound content state is allocated the area, * nullptr is returnd. */ diff --git a/src/include/rba/RBASoundContentState.hpp b/src/include/rba/RBASoundContentState.hpp index fdd22f5..7f35d39 100644 --- a/src/include/rba/RBASoundContentState.hpp +++ b/src/include/rba/RBASoundContentState.hpp @@ -35,7 +35,7 @@ protected: RBASoundContentState(RBASoundContentState&&)=delete; RBASoundContentState& operator=(const RBASoundContentState&)=delete; RBASoundContentState& operator=(RBASoundContentState&&)=delete; - ~RBASoundContentState()=default;音声コンテントクラス + ~RBASoundContentState()=default; public: /** @@ -66,7 +66,7 @@ public: * The order of the sound content state does not include the output request * of the view content state. */ - virtual std::int32_t getOrder() con音声コンテントクラスst=0; + virtual std::int32_t getOrder() const=0; /** * @brief Returns the unique character string of the sound contents state. diff --git a/src/log/RBACoverageLog.hpp b/src/log/RBACoverageLog.hpp index 11e3695..ef0a315 100644 --- a/src/log/RBACoverageLog.hpp +++ b/src/log/RBACoverageLog.hpp @@ -103,7 +103,7 @@ private: std::vector<RBALog*> constraintLogs; std::vector<RBALog*> canceledRequestLogs_; - // Constraint structure log for finding the denominator of + // Constraint structure log for finding the denominator of // constraint coverage. The constraint log is different // because it also has the execution result. std::vector<RBALog*> hierarchyOfConstraintLogs_; diff --git a/src/sound/RBAOutputtingSound.hpp b/src/sound/RBAOutputtingSound.hpp index 67b476c..dd2e67e 100644 --- a/src/sound/RBAOutputtingSound.hpp +++ b/src/sound/RBAOutputtingSound.hpp @@ -14,7 +14,7 @@ * limitations under the License. */ /** - * 音声出力クラス + * OutputtingSound class header */ #ifndef RBAOUTPUTTINGSOUND_HPP diff --git a/src/sound/RBAZoneMaker.hpp b/src/sound/RBAZoneMaker.hpp index 8367bd0..96bc98e 100644 --- a/src/sound/RBAZoneMaker.hpp +++ b/src/sound/RBAZoneMaker.hpp @@ -24,7 +24,7 @@ namespace rba { -/// @brief Zone object generator class +/// @brief Zone object generator class class RBAZoneMaker : public RBAAllocatableMaker { public: diff --git a/src/sound/RBAZoneSetMaker.hpp b/src/sound/RBAZoneSetMaker.hpp index 1265628..17a896d 100644 --- a/src/sound/RBAZoneSetMaker.hpp +++ b/src/sound/RBAZoneSetMaker.hpp @@ -24,7 +24,7 @@ namespace rba { -/// @brief ZoneSet object generator class +/// @brief ZoneSet object generator class class RBAZoneSetMaker : public RBAAllocatableSetMaker { public: diff --git a/src/view/RBAAreaMaker.hpp b/src/view/RBAAreaMaker.hpp index 291e91b..864a247 100644 --- a/src/view/RBAAreaMaker.hpp +++ b/src/view/RBAAreaMaker.hpp @@ -31,7 +31,7 @@ public: RBAAreaMaker(); RBAAreaMaker(const RBAAreaMaker&)=default; RBAAreaMaker& operator=(const RBAAreaMaker&)=default; - // move削除 + // delete move RBAAreaMaker(const RBAAreaMaker&&)=delete; RBAAreaMaker& operator=(const RBAAreaMaker&&)=delete; virtual ~RBAAreaMaker()=default; |