fw4spl
fwDicomIOFilterQt::splitter::TagValueConfigurableSplitter Class Reference

Filter that uses a tag to split the instances. More...

#include <TagValueConfigurableSplitter.hpp>

+ Inheritance diagram for fwDicomIOFilterQt::splitter::TagValueConfigurableSplitter:
+ Collaboration diagram for fwDicomIOFilterQt::splitter::TagValueConfigurableSplitter:

Public Member Functions

virtual bool isA (const std::string &type) const override
 
FWDICOMIOFILTERQT_API TagValueConfigurableSplitter (::fwDicomIOFilter::IFilter::Key key)
 Constructor.
 
virtual FWDICOMIOFILTERQT_API ~TagValueConfigurableSplitter ()
 Destructor.
 
virtual FWDICOMIOFILTERQT_API std::string getName () const override
 Return the name of the filter.
 
virtual FWDICOMIOFILTERQT_API std::string getDescription () const override
 Return the description of the filter.
 
virtual FWDICOMIOFILTERQT_API bool isConfigurationRequired () const override
 Return true if a configuration is required.
 
virtual FWDICOMIOFILTERQT_API bool isConfigurableWithGUI () const override
 Return true if the filter is configurable using GUI.
 
virtual FWDICOMIOFILTERQT_API void configureWithGUI () override
 Configure the filter using GUI dialog.
 
- Public Member Functions inherited from fwDicomIOFilter::splitter::TagValueSplitter
FWDICOMIOFILTER_API TagValueSplitter (::fwDicomIOFilter::IFilter::Key key)
 Constructor.
 
virtual FWDICOMIOFILTER_API ~TagValueSplitter ()
 Destructor.
 
virtual FWDICOMIOFILTER_API DicomSeriesContainerType apply (const ::fwMedData::DicomSeries::sptr &series, const ::fwLog::Logger::sptr &logger) const override
 Override.
 
DcmTagKey & getTag ()
 Tag used to sort instances.
 
const DcmTagKey & getTag () const
 Tag used to sort instances.
 
void setTag (const DcmTagKey &_tag)
 Tag used to sort instances.
 
- Public Member Functions inherited from fwDicomIOFilter::splitter::ISplitter
virtual FWDICOMIOFILTER_API ~ISplitter ()
 Destructor.
 
FWDICOMIOFILTER_API FilterType getFilterType () const override
 Return filter type.
 
- Public Member Functions inherited from fwDicomIOFilter::IFilter
virtual FWDICOMIOFILTER_API ~IFilter ()
 Destructor.
 
- Public Member Functions inherited from fwTools::Object
- Public Member Functions inherited from fwCore::BaseObject

Static Public Member Functions

static bool isTypeOf (const std::string &type)
 
- Static Public Member Functions inherited from fwDicomIOFilter::splitter::TagValueSplitter
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
 
- Static Public Member Functions inherited from fwDicomIOFilter::splitter::ISplitter
static bool isTypeOf (const std::string &type)
 
static const std::string & classname ()
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
- Static Public Member Functions inherited from fwDicomIOFilter::IFilter
static bool isTypeOf (const std::string &type)
 
static const std::string & classname ()
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
- Static Public Member Functions inherited from fwTools::Object
static bool isTypeOf (const std::string &type)
 
static const std::string & classname ()
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
- 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
 

Static Protected Attributes

static FWDICOMIOFILTERQT_API const std::string s_FILTER_NAME = "Tag value configurable splitter"
 Filter name.
 
static FWDICOMIOFILTERQT_API const std::string s_FILTER_DESCRIPTION
 Filter description. More...
 
- Static Protected Attributes inherited from fwDicomIOFilter::splitter::TagValueSplitter
static const std::string s_FILTER_NAME = "Tag value splitter"
 Filter name.
 
static const std::string s_FILTER_DESCRIPTION
 Filter description. More...
 

Friends

template<class , class , class >
class ::fwTools::ClassFactory
 
class ::fwTools::Factory
 

Demangling methods

virtual const std::string & getLeafClassname () const override
 return object's classname without its namespace, i.e. BaseObject
 
virtual const std::string & getClassname () const override
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
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
 

Additional Inherited Members

- Public Types inherited from fwDicomIOFilter::IFilter
enum  FilterType {
  MODIFIER = 0, SORTER = 1, SPLITTER = 2, COMPOSITE = 3,
  CUSTOM = 4
}
 Filter types. More...
 
typedef ::fwDicomIOFilter::factory::Key Key
 
typedef std::vector< ::fwMedData::DicomSeries::sptr > DicomSeriesContainerType
 
- Protected Types inherited from fwTools::fwID
enum  Policy { EMPTY = 1, GENERATE, MUST_EXIST }
 
typedef std::string IDType
 
- Protected Member Functions inherited from fwDicomIOFilter::splitter::ISplitter
FWDICOMIOFILTER_API ISplitter ()
 Constructor.
 
- Protected Member Functions inherited from fwDicomIOFilter::IFilter
FWDICOMIOFILTER_API IFilter ()
 Constructor.
 
- Protected Member Functions inherited from fwTools::fwID
FWTOOLS_API bool hasID () const
 Return true if the object has an id set. More...
 
FWTOOLS_API IDType getID (Policy policy=GENERATE) const
 Returns the id of the object. If it is not set and the policy value is. More...
 
virtual FWTOOLS_API void setID (IDType newID)
 Set a newID for the object, (newID must not exist in fwID), the oldest one is released. More...
 
FWTOOLS_API void resetID ()
 Release the id for the object. More...
 
 fwID ()
 Constructor : does nothing.
 
- Static Protected Member Functions inherited from fwTools::fwID
static bool isTypeOf (const std::string &type)
 
static FWTOOLS_API bool exist (IDType _id)
 
static FWTOOLS_API std::shared_ptr< ::fwTools::ObjectgetObject (IDType requestID)
 Retrieve the object attached to the given id. Return a null sptr if no correspondence exist. More...
 
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
 
- Protected Attributes inherited from fwDicomIOFilter::splitter::TagValueSplitter
DcmTagKey m_tag
 Tag used to sort instances.
 
- Protected Attributes inherited from fwTools::Object
std::shared_ptr< ::fwTools::UUIDm_uuid
 UUID used to identify the object, notably for serialization.
 

Detailed Description

Filter that uses a tag to split the instances.

Definition at line 23 of file TagValueConfigurableSplitter.hpp.

Member Data Documentation

const std::string fwDicomIOFilterQt::splitter::TagValueConfigurableSplitter::s_FILTER_DESCRIPTION
staticprotected
Initial value:
=
"Split instances using a tag value."

Filter description.

Definition at line 56 of file TagValueConfigurableSplitter.hpp.

Referenced by getDescription().


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