fw4spl
fwActivities::IValidator Class Referenceabstract

Base class for all fwActivities validator's classes. More...

#include <IValidator.hpp>

+ Inheritance diagram for fwActivities::IValidator:
+ Collaboration diagram for fwActivities::IValidator:

Classes

class  Registrar
 Class used to register a class factory in factory registry. This class defines also the object factory ( 'create' ) More...
 

Public Types

typedef std::pair< bool, std::string > ValidationType
 Defines validation result of an activity. First element tells if the activity is validated or not by the IValidator implementation. Second element may contains information about the result of activity validation.
 
typedef ::fwActivities::validator::factory::Key Key
 

Public Member Functions

virtual bool isA (const std::string &type) const override
 
virtual FWACTIVITIES_API ValidationType validate (const ::fwActivities::registry::ActivityInfo &activityInfo, const std::shared_ptr< const ::fwData::Vector > &currentSelection) const =0
 Performs validation of given data as inputs for the considered activity. More...
 
- Public Member Functions inherited from fwCore::BaseObject
virtual const std::string & getLeafClassname () const
 return object's classname without its namespace, i.e. BaseObject
 

Static Public Member Functions

static bool isTypeOf (const std::string &type)
 
- Static Public Member Functions inherited from fwCore::BaseObject
static bool isTypeOf (const std::string &type)
 
static const std::string & leafClassname ()
 return object's classname without its namespace, i.e. BaseObject
 
static const std::string & classname ()
 return object's classname without its namespace, i.e. BaseObject
 

Demangling methods

virtual const std::string & getClassname () const override
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
static const std::string & classname ()
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 

Detailed Description

Base class for all fwActivities validator's classes.

Definition at line 29 of file IValidator.hpp.

Member Function Documentation

virtual FWACTIVITIES_API ValidationType fwActivities::IValidator::validate ( const ::fwActivities::registry::ActivityInfo activityInfo,
const std::shared_ptr< const ::fwData::Vector > &  currentSelection 
) const
pure virtual

Performs validation of given data as inputs for the considered activity.

Parameters
[in]activityInfoa structure which contains all the activity configuration
[in]currentSelectiona vector which contains current selected data.
Returns
result of the validation
See also
IValidator::ValidationType

Implemented in fwActivities::validator::RelatedStudy, fwActivities::validator::ImageProperties, fwActivities::IObjectValidator, and fwActivities::IActivityValidator.


The documentation for this class was generated from the following file: