ctkWorkflowStep.cpp 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  1. /*=========================================================================
  2. Library: CTK
  3. Copyright (c) 2010 Kitware Inc.
  4. Licensed under the Apache License, Version 2.0 (the "License");
  5. you may not use this file except in compliance with the License.
  6. You may obtain a copy of the License at
  7. http://www.commontk.org/LICENSE
  8. Unless required by applicable law or agreed to in writing, software
  9. distributed under the License is distributed on an "AS IS" BASIS,
  10. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11. See the License for the specific language governing permissions and
  12. limitations under the License.
  13. =========================================================================*/
  14. // Qt includes
  15. #include <QState>
  16. // CTK includes
  17. #include "ctkLogger.h"
  18. #include "ctkWorkflowStep.h"
  19. #include "ctkWorkflow.h"
  20. // STD includes
  21. #include <iostream>
  22. //--------------------------------------------------------------------------
  23. static ctkLogger logger("org.commontk.core.ctkWorkflowStep");
  24. //--------------------------------------------------------------------------
  25. //-----------------------------------------------------------------------------
  26. class ctkWorkflowStepPrivate: public ctkPrivate<ctkWorkflowStep>
  27. {
  28. public:
  29. CTK_DECLARE_PUBLIC(ctkWorkflowStep);
  30. ctkWorkflowStepPrivate();
  31. ~ctkWorkflowStepPrivate();
  32. ctkWorkflow* Workflow;
  33. QString Id;
  34. QString Name;
  35. QString Description;
  36. QString StatusText;
  37. QState* ProcessingState;
  38. QState* ValidationState;
  39. ctkWorkflowIntrastepTransition* ValidationTransition;
  40. ctkWorkflowIntrastepTransition* ValidationFailedTransition;
  41. bool HasValidateCommand;
  42. bool HasOnEntryCommand;
  43. bool HasOnExitCommand;
  44. };
  45. // --------------------------------------------------------------------------
  46. // ctkWorkflowStepPrivate methods
  47. // --------------------------------------------------------------------------
  48. ctkWorkflowStepPrivate::ctkWorkflowStepPrivate()
  49. {
  50. this->Workflow = 0;
  51. this->HasValidateCommand = false;
  52. this->HasOnEntryCommand = false;
  53. this->HasOnExitCommand = false;
  54. // Create state
  55. this->ProcessingState = new QState();
  56. this->ValidationState = new QState();
  57. // Create 'validation' transition
  58. this->ValidationTransition =
  59. new ctkWorkflowIntrastepTransition(ctkWorkflowIntrastepTransition::ValidationTransition);
  60. this->ValidationTransition->setTargetState(this->ValidationState);
  61. this->ProcessingState->addTransition(this->ValidationTransition);
  62. // Create 'failed validation' transation
  63. this->ValidationFailedTransition = 0;
  64. this->ValidationFailedTransition =
  65. new ctkWorkflowIntrastepTransition(ctkWorkflowIntrastepTransition::ValidationFailedTransition);
  66. this->ValidationFailedTransition->setTargetState(this->ProcessingState);
  67. this->ValidationState->addTransition(this->ValidationFailedTransition);
  68. }
  69. // --------------------------------------------------------------------------
  70. ctkWorkflowStepPrivate::~ctkWorkflowStepPrivate()
  71. {
  72. delete this->ValidationState;
  73. delete this->ProcessingState;
  74. // If we delete the states, then Qt will handle deleting the transitions
  75. }
  76. // --------------------------------------------------------------------------
  77. // ctkWorkflowStep methods
  78. // --------------------------------------------------------------------------
  79. ctkWorkflowStep::ctkWorkflowStep(ctkWorkflow* newWorkflow, const QString& newId) : Superclass()
  80. {
  81. CTK_INIT_PRIVATE(ctkWorkflowStep);
  82. CTK_D(ctkWorkflowStep);
  83. if (newId.isEmpty())
  84. {
  85. d->Id = this->metaObject()->className();
  86. }
  87. else
  88. {
  89. d->Id = newId;
  90. }
  91. d->Workflow = newWorkflow;
  92. }
  93. // --------------------------------------------------------------------------
  94. CTK_GET_CXX(ctkWorkflowStep, ctkWorkflow*, workflow, Workflow);
  95. // --------------------------------------------------------------------------
  96. CTK_GET_CXX(ctkWorkflowStep, QString, id, Id);
  97. CTK_SET_CXX(ctkWorkflowStep, const QString&, setId, Id);
  98. // --------------------------------------------------------------------------
  99. CTK_GET_CXX(ctkWorkflowStep, QString, name, Name);
  100. CTK_SET_CXX(ctkWorkflowStep, const QString&, setName, Name);
  101. // --------------------------------------------------------------------------
  102. CTK_GET_CXX(ctkWorkflowStep, QString, description, Description);
  103. CTK_SET_CXX(ctkWorkflowStep, const QString&, setDescription, Description);
  104. // --------------------------------------------------------------------------
  105. CTK_GET_CXX(ctkWorkflowStep, QString, statusText, StatusText);
  106. CTK_SET_CXX(ctkWorkflowStep, const QString&, setStatusText, StatusText);
  107. // --------------------------------------------------------------------------
  108. CTK_GET_CXX(ctkWorkflowStep, bool, hasValidateCommand, HasValidateCommand);
  109. CTK_SET_CXX(ctkWorkflowStep, bool, setHasValidateCommand, HasValidateCommand);
  110. // --------------------------------------------------------------------------
  111. CTK_GET_CXX(ctkWorkflowStep, bool, hasOnEntryCommand, HasOnEntryCommand);
  112. CTK_SET_CXX(ctkWorkflowStep, bool, setHasOnEntryCommand, HasOnEntryCommand);
  113. // --------------------------------------------------------------------------
  114. CTK_GET_CXX(ctkWorkflowStep, bool, hasOnExitCommand, HasOnExitCommand);
  115. CTK_SET_CXX(ctkWorkflowStep, bool, setHasOnExitCommand, HasOnExitCommand);
  116. // --------------------------------------------------------------------------
  117. CTK_GET_CXX(ctkWorkflowStep, QState*, processingState, ProcessingState);
  118. CTK_GET_CXX(ctkWorkflowStep, QState*, validationState, ValidationState);
  119. // --------------------------------------------------------------------------
  120. CTK_GET_CXX(ctkWorkflowStep, ctkWorkflowIntrastepTransition*, validationTransition, ValidationTransition);
  121. CTK_GET_CXX(ctkWorkflowStep, ctkWorkflowIntrastepTransition*,
  122. validationFailedTransition, ValidationFailedTransition);
  123. // --------------------------------------------------------------------------
  124. void ctkWorkflowStep::validate(const QString& desiredBranchId)
  125. {
  126. CTK_D(ctkWorkflowStep);
  127. logger.info(QString("validate - validating the input from %1").arg(d->Name));
  128. emit this->validationComplete(true, desiredBranchId);
  129. }
  130. // --------------------------------------------------------------------------
  131. void ctkWorkflowStep::onEntry(const ctkWorkflowStep* comingFrom,
  132. const ctkWorkflowInterstepTransition::InterstepTransitionType transitionType)
  133. {
  134. Q_UNUSED(comingFrom);
  135. Q_UNUSED(transitionType);
  136. // Signals that we are finished
  137. emit this->onEntryComplete();
  138. }
  139. // --------------------------------------------------------------------------
  140. void ctkWorkflowStep::onExit(const ctkWorkflowStep* goingTo,
  141. const ctkWorkflowInterstepTransition::InterstepTransitionType transitionType)
  142. {
  143. Q_UNUSED(goingTo);
  144. Q_UNUSED(transitionType);
  145. // Signals that we are finished
  146. emit this->onExitComplete();
  147. }