CLAM::SMSTransformationChain Class Reference
#include <SMSTransformationChain.hxx>
Detailed Description
Using Segment as the type for * input and output ports.It implements the supervised Do and a helper method for updating the frame counter in the Segment.
Definition at line 44 of file SMSTransformationChain.hxx.
Public Member Functions | |
| void | AttachIn (Segment &data) |
| void | AttachOut (Segment &data) |
| SMSTransformationChain () | |
| virtual | ~SMSTransformationChain () |
| Destructor. | |
| virtual bool | DoChildren () |
| bool | Do () |
| Supervised mode execution method (using ports). | |
| bool | ConcreteStart () |
| Concrete start implementation, called when the user calls Start() on the Processing(Composite), should be used to implement any specific start implementation required by classes deriving from this class. | |
| void | InitSegmentArray () |
| void | InitAllFrameIndex () |
| void | TurnOn (TIndex index) |
| Accessor to On/off control. | |
| void | TurnOff (TIndex index) |
| Accessor to On/off control. | |
| const ProcessingConfig & | GetConfig () const |
| Configuration getter. | |
| bool | ConcreteConfigure (const ProcessingConfig &c) |
| Configuration method interface. | |
| SegmentTransformation * | GetTransformation (const std::string &name) |
| Returns first transformation in chain belonging to a given class or NULL if not found. | |
Constructor & Destructor Documentation
| CLAM::SMSTransformationChain::SMSTransformationChain | ( | ) | [inline] |
| virtual CLAM::SMSTransformationChain::~SMSTransformationChain | ( | ) | [inline, virtual] |
Destructor.
Deletes temporal ProcessingData and Configuration and any previously allocated Processing chainee.
Definition at line 72 of file SMSTransformationChain.hxx.
References CLAM::ProcessingComposite::composite_begin(), and CLAM::ProcessingComposite::composite_end().
Member Function Documentation
| void CLAM::SMSTransformationChain::AttachIn | ( | Segment & | data | ) | [inline] |
Definition at line 59 of file SMSTransformationChain.hxx.
| void CLAM::SMSTransformationChain::AttachOut | ( | Segment & | data | ) | [inline] |
Definition at line 60 of file SMSTransformationChain.hxx.
| virtual bool CLAM::SMSTransformationChain::DoChildren | ( | ) | [inline, virtual] |
Definition at line 84 of file SMSTransformationChain.hxx.
References CLAM_DEBUG_ASSERT, CLAM::ProcessingComposite::composite_begin(), CLAM::ProcessingComposite::composite_end(), CLAM::ProcessingComposite::composite_size(), CLAM::SegmentTransformation::DoWithSegments(), and CLAM::Processing::IsRunning().
Referenced by Do().
| bool CLAM::SMSTransformationChain::Do | ( | ) | [inline, virtual] |
Supervised mode execution method (using ports).
- Returns:
- A boolean telling whether it has been output
Implements CLAM::ProcessingComposite.
Definition at line 109 of file SMSTransformationChain.hxx.
References DoChildren().
| bool CLAM::SMSTransformationChain::ConcreteStart | ( | void | ) | [inline, virtual] |
Concrete start implementation, called when the user calls Start() on the Processing(Composite), should be used to implement any specific start implementation required by classes deriving from this class.
When overriding this function in a class derived from ProcessingComposite be sure to call the base class (so child Processings are properly started).
Reimplemented from CLAM::ProcessingComposite.
Definition at line 120 of file SMSTransformationChain.hxx.
References CLAM::SegmentTransformation::AttachIn(), CLAM::SegmentTransformation::AttachOut(), CLAM::ProcessingComposite::composite_begin(), CLAM::ProcessingComposite::composite_end(), CLAM::ProcessingComposite::ConcreteStart(), InitAllFrameIndex(), and InitSegmentArray().
| void CLAM::SMSTransformationChain::InitSegmentArray | ( | ) | [inline] |
| void CLAM::SMSTransformationChain::InitAllFrameIndex | ( | ) | [inline] |
Definition at line 171 of file SMSTransformationChain.hxx.
References CLAM::Segment::mCurrentFrameIndex.
Referenced by ConcreteStart().
| void CLAM::SMSTransformationChain::TurnOn | ( | TIndex | index | ) | [inline] |
Accessor to On/off control.
Turns on the specified control in the array.
Definition at line 179 of file SMSTransformationChain.hxx.
| void CLAM::SMSTransformationChain::TurnOff | ( | TIndex | index | ) | [inline] |
Accessor to On/off control.
Turns on the specified control in the array.
Definition at line 185 of file SMSTransformationChain.hxx.
| const ProcessingConfig& CLAM::SMSTransformationChain::GetConfig | ( | ) | const [inline, virtual] |
Configuration getter.
Gets the configuration parameters used to create the object.
- Returns:
- Const reference to the configuration object. The usual way to perform a configuration change in the processing object is to take a copy of this reference, to change it and to send it with the Configure method. If not overriden, it returns a NullProcessingConfig.
Implements CLAM::ProcessingComposite.
Definition at line 190 of file SMSTransformationChain.hxx.
| bool CLAM::SMSTransformationChain::ConcreteConfigure | ( | const ProcessingConfig & | ) | [inline, virtual] |
Configuration method interface.
The Processing base class forces all the concrete classes derived from it to implement this method, which must actually perform the specific configuration tasks.
Note that the user can not call this method directly. He will use Configure instead. The argument is expected to be an object of the necesary concrete configuration class.
- Parameters:
-
Reference to the configuration object.
- Returns:
- false if the object is not yet fully configured. (For example, if some important configuration attribute such as number of ports was set to zero in the config object)
- Exceptions:
-
This method must throw a bad_cast exception if the argument is not an object of the expected configuration class.
Implements CLAM::ProcessingComposite.
Definition at line 195 of file SMSTransformationChain.hxx.
References CLAM_ASSERT, CLAM::ProcessingComposite::composite_begin(), CLAM::ProcessingComposite::composite_end(), CLAM::ProcessingComposite::composite_size(), CLAM::SMSTransformationChainConfig::ConfigList_begin(), CLAM::SMSTransformationChainConfig::ConfigList_end(), NULL, and CLAM::ProcessingComposite::Remove().
| SegmentTransformation* CLAM::SMSTransformationChain::GetTransformation | ( | const std::string & | name | ) | [inline] |
Returns first transformation in chain belonging to a given class or NULL if not found.
Definition at line 235 of file SMSTransformationChain.hxx.
References CLAM::ProcessingComposite::composite_begin(), CLAM::ProcessingComposite::composite_end(), and NULL.
The documentation for this class was generated from the following file:
