Mercurial > hg > svcore
diff transform/ModelTransformerFactory.h @ 933:d03b3d956358 warnfix_no_size_t
Merge from branch tony_integration
| author | Chris Cannam |
|---|---|
| date | Wed, 18 Jun 2014 08:34:46 +0100 |
| parents | 06579b8ffb7b 85879408f665 |
| children | c7e9afcbf070 |
line wrap: on
line diff
--- a/transform/ModelTransformerFactory.h Tue Jun 17 16:42:51 2014 +0100 +++ b/transform/ModelTransformerFactory.h Wed Jun 18 08:34:46 2014 +0100 @@ -84,7 +84,8 @@ * Return the output model resulting from applying the named * transform to the given input model. The transform may still be * working in the background when the model is returned; check the - * output model's isReady completion status for more details. + * output model's isReady completion status for more details. To + * cancel a background transform, call abandon() on its model. * * If the transform is unknown or the input model is not an * appropriate type for the given transform, or if some other @@ -116,7 +117,8 @@ * (as appropriate). Models will be returned in the same order as * the transforms were given. The plugin may still be working in * the background when the model is returned; check the output - * models' isReady completion statuses for more details. + * models' isReady completion statuses for more details. To cancel + * a background transform, call abandon() on its model. * * If a transform is unknown or the transforms are insufficiently * closely related or the input model is not an appropriate type @@ -130,7 +132,10 @@ * is provided here, its moreModelsAvailable method will be called * when those models become available, and ownership of those * models will be transferred to the handler. Otherwise (if the - * handler is null) any such models will be discarded. + * handler is null) any such models will be discarded. Note that + * calling abandon() on any one of the models returned by + * transformMultiple is sufficient to cancel all background + * transform activity associated with these output models. * * The returned models are owned by the caller and must be deleted * when no longer needed.