fwDicomIOFilter::splitter::TagValueInstanceRemoveSplitter Class Reference

Filter that remove instances according to tag value. More...

#include <TagValueInstanceRemoveSplitter.hpp>

Inheritance diagram for fwDicomIOFilter::splitter::TagValueInstanceRemoveSplitter:

Collaboration diagram for fwDicomIOFilter::splitter::TagValueInstanceRemoveSplitter:

Public Member Functions
virtual bool	isA (const std::string &type) const override
FWDICOMIOFILTER_API	TagValueInstanceRemoveSplitter (::fwDicomIOFilter::IFilter::Key key)
	Constructor.
virtual FWDICOMIOFILTER_API	~TagValueInstanceRemoveSplitter ()
	Destructor.
virtual FWDICOMIOFILTER_API DicomSeriesContainerType	apply (const ::fwMedData::DicomSeries::sptr &series, const ::fwLog::Logger::sptr &logger) const override
	Override.
virtual FWDICOMIOFILTER_API std::string	getName () const override
	Return the name of the filter.
virtual FWDICOMIOFILTER_API std::string	getDescription () const override
	Return the description of the filter.
virtual FWDICOMIOFILTER_API bool	isConfigurationRequired () const override
	Return true if a configuration is required.
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.
std::string &	getTagValue ()
	Tag value used to determine if an instance must be removed.
const std::string &	getTagValue () const
	Tag value used to determine if an instance must be removed.
void	setTagValue (const std::string &_tagValue)
	Tag value used to determine if an instance must be removed.
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.
virtual FWDICOMIOFILTER_API bool	isConfigurableWithGUI () const
	Return true if the filter is configurable using GUI.
virtual FWDICOMIOFILTER_API void	configureWithGUI ()
	Configure the filter using GUI dialog.
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::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

Protected Attributes
DcmTagKey	m_tag
	Tag used to sort instances.
std::string	m_tagValue
	Tag value used to determine if an instance must be removed.
Protected Attributes inherited from fwTools::Object
std::shared_ptr< ::fwTools::UUID >	m_uuid
	UUID used to identify the object, notably for serialization.

Static Protected Attributes
static const std::string	s_FILTER_NAME = "Tag value instance remove 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::Object >	getObject (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

Detailed Description

Filter that remove instances according to tag value.

Definition at line 24 of file TagValueInstanceRemoveSplitter.hpp.

Member Data Documentation

const std::string fwDicomIOFilter::splitter::TagValueInstanceRemoveSplitter::s_FILTER_DESCRIPTION

staticprotected

Initial value:

=
    "Remove instances according to a tag value."

Filter description.

Definition at line 100 of file TagValueInstanceRemoveSplitter.hpp.

Referenced by getDescription().

---

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

• TagValueInstanceRemoveSplitter.hpp
• TagValueInstanceRemoveSplitter.cpp