This class defines structure traits. More...

#include <StructureTraits.hpp>

Inheritance diagram for fwData::StructureTraits:

Collaboration diagram for fwData::StructureTraits:

Public Types
enum	Category { BODY, HEAD, NECK, THORAX, ABDOMEN, PELVIS, ARM, LEG, LIVER_SEGMENTS, OTHER }
	Defines structure categories.

enum	StructureClass { TOOL, ENVIRONMENT, VESSEL, LESION, ORGAN, FUNCTIONAL, NO_CONSTRAINT }
	Defines structure class.

typedef std::vector< Category >	CategoryContainer

typedef std::string	ROIExpression

Public Types inherited from fwData::Object
typedef ::fwData::factory::Key	Key

typedef std::string	FieldNameType

typedef std::vector< FieldNameType >	FieldNameVectorType

typedef ::std::unordered_map< FieldNameType,::fwData::Object::sptr >	FieldMapType

typedef ::std::unordered_map< ::fwData::Object::csptr,::fwData::Object::sptr >	DeepCopyCacheType

typedef ::fwCom::Signal< void() >	ModifiedSignalType
	Type of signal m_sigModified.

typedef std::map< std::string,::fwData::Object::sptr >	FieldsContainerType
	Type of signal m_sigModified.

typedef ::fwCom::Signal< void(FieldsContainerType) >	AddedFieldsSignalType
	Type of signal when objects are added.

typedef ::fwCom::Signal< void(FieldsContainerType, FieldsContainerType) >	ChangedFieldsSignalType
	Type of signal when objects are changed (newObjects, oldObjects)

typedef ::fwCom::Signal< void(FieldsContainerType) >	RemovedFieldsSignalType
	Type of signal when objects are removed.

Public Types inherited from fwCom::HasSignals
typedef std::shared_ptr< HasSignals >	sptr

typedef std::shared_ptr< const HasSignals >	csptr

Public Member Functions
virtual bool	isA (const std::string &type) const override

FWDATA_API	StructureTraits (::fwData::Object::Key key)
	Constructor. More...

virtual FWDATA_API	~StructureTraits ()
	Destructor. Does nothing.

FWDATA_API void	cachedDeepCopy (const Object::csptr &_source, DeepCopyCacheType &cache) override
	Defines deep copy.


std::string &	getType ()
	Get/Set value of the structure type.

const std::string &	getType () const
	Get/Set value of the structure type.

void	setType (const std::string &_type)
	Get/Set value of the structure type.


CategoryContainer &	getCategories ()
	Get/Set value of the categories.

const CategoryContainer &	getCategories () const
	Get/Set value of the categories.

void	setCategories (const CategoryContainer &_categories)
	Get/Set value of the categories.


StructureClass &	getClass ()
	Get/Set value of the class.

const StructureClass &	getClass () const
	Get/Set value of the class.

void	setClass (const StructureClass &_class)
	Get/Set value of the class.


ROIExpression &	getNativeExp ()
	Get/Set value of the nativeExp.

const ROIExpression &	getNativeExp () const
	Get/Set value of the nativeExp.

void	setNativeExp (const ROIExpression &_nativeExp)
	Get/Set value of the nativeExp.


ROIExpression &	getNativeGeometricExp ()
	Get/Set value of the nativeGeometricExp.

const ROIExpression &	getNativeGeometricExp () const
	Get/Set value of the nativeGeometricExp.

void	setNativeGeometricExp (const ROIExpression &_nativeGeometricExp)
	Get/Set value of the nativeGeometricExp.


std::string &	getAttachmentType ()
	Get/Set value of the attachmentType.

const std::string &	getAttachmentType () const
	Get/Set value of the attachmentType.

void	setAttachmentType (const std::string &_attachmentType)
	Get/Set value of the attachmentType.


::fwData::Color::sptr &	getColor ()
	Get/Set value of the color.

const ::fwData::Color::sptr &	getColor () const
	Get/Set value of the color.

void	setColor (const ::fwData::Color::sptr &_color)
	Get/Set value of the color.


std::string &	getAnatomicRegion ()
	Get/Set value of the anatomicRegion.

const std::string &	getAnatomicRegion () const
	Get/Set value of the anatomicRegion.

void	setAnatomicRegion (const std::string &_anatomicRegion)
	Get/Set value of the anatomicRegion.


std::string &	getPropertyCategory ()
	Get/Set value of the propertyCategory.

const std::string &	getPropertyCategory () const
	Get/Set value of the propertyCategory.

void	setPropertyCategory (const std::string &_propertyCategory)
	Get/Set value of the propertyCategory.


std::string &	getPropertyType ()
	Get/Set value of the propertyType.

const std::string &	getPropertyType () const
	Get/Set value of the propertyType.

void	setPropertyType (const std::string &_propertyType)
	Get/Set value of the propertyType.

Public Member Functions inherited from fwData::Object
FWDATA_API::fwData::Object::sptr	getField (const FieldNameType &name,::fwData::Object::sptr defaultValue=::fwData::Object::sptr()) const
	Returns a pointer of corresponding field (null if non exist). More...

template<typename DATA_TYPE >
std::shared_ptr< DATA_TYPE >	getField (const FieldNameType &name) const
	Returns a pointer of corresponding field. More...

template<typename DATA_TYPE >
std::shared_ptr< DATA_TYPE >	getField (const FieldNameType &name, std::shared_ptr< DATA_TYPE > defaultValue) const
	Returns a pointer of corresponding field. More...

template<typename DATA_TYPE >
std::shared_ptr< DATA_TYPE >	setDefaultField (const FieldNameType &name, std::shared_ptr< DATA_TYPE > defaultValue)
	Returns a pointer of corresponding field. If field did not exist, it is set to defaultValue if defaultValue is not null. More...

FWDATA_API::fwData::Object::csptr	getConstField (const FieldNameType &name) const
	Returns a pointer of corresponding field (null if non exist). More...

FWDATA_API const FieldMapType &	getFields () const
	Returns fields map.

FWDATA_API FieldNameVectorType	getFieldNames () const
	Returns vector of field names.

FWDATA_API void	setField (const FieldNameType &name,::fwData::Object::sptr obj)
	Register field with specified name. If the name does already exist, the matching field will be replaced. More...

FWDATA_API void	setFields (const FieldMapType &fieldMap)
	Replace the field map content.

FWDATA_API void	removeField (const FieldNameType &name)
	Removes field with specified name. More...

virtual FWDATA_API void	shallowCopy (const ::fwData::Object::csptr &source)
	A shallow copy of fields (objects in m_children) More...

FWDATA_API void	deepCopy (const ::fwData::Object::csptr &source)
	Make a deep copy from the source Calling this method may invalidate any DumpLock, RescursiveLock or helper on the object. Prefer using fwData::Object::copy instead.

FWDATA_API void	fieldShallowCopy (const ::fwData::Object::csptr &source)
	A shallow copy of fields (objects in m_children) More...

FWDATA_API void	fieldDeepCopy (const ::fwData::Object::csptr &source)
	A deep copy of fields (objects in m_children) More...

::fwCore::mt::ReadWriteMutex &	getMutex () const
	Returns the object's mutex.

Public Member Functions inherited from fwTools::Object
Public Member Functions inherited from fwCore::BaseObject
Public Member Functions inherited from fwCom::HasSignals
std::shared_ptr< SignalBase >	signal (const Signals::SignalKeyType &key) const

template<typename SignalType >
std::shared_ptr< SignalType >	signal (const Signals::SignalKeyType &key) const

template<typename SignalType >
std::shared_ptr< SignalType >	newSignal (const Signals::SignalKeyType &key)

Static Public Member Functions
static bool	isTypeOf (const std::string &type)

Static Public Member Functions inherited from fwData::Object
static bool	isTypeOf (const std::string &type)

static FWDATA_API::fwData::Object::sptr	copy (const ::fwData::Object::csptr &source)
	return a copy of the source. if source is a null pointer, return a null pointer.

template<typename DATA_TYPE >
static std::shared_ptr< DATA_TYPE >	copy (const std::shared_ptr< const DATA_TYPE > &source)
	return a copy of the source. if source is a null pointer, return a null pointer.

template<typename DATA_TYPE >
static std::shared_ptr< DATA_TYPE >	copy (const std::shared_ptr< DATA_TYPE > &source)
	return a copy of the source. if source is a null pointer, return a null pointer.

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

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
Static Public Attributes inherited from fwData::Object
static FWDATA_APIconst::fwCom::Signals::SignalKeyType	s_MODIFIED_SIG = "modified"
	Key in m_signals map of signal m_sigModified.

static FWDATA_APIconst::fwCom::Signals::SignalKeyType	s_ADDED_FIELDS_SIG = "addedFields"
	Type of signal m_sigModified.

static FWDATA_APIconst::fwCom::Signals::SignalKeyType	s_CHANGED_FIELDS_SIG = "changedFields"
	Type of signal m_sigModified.

static FWDATA_APIconst::fwCom::Signals::SignalKeyType	s_REMOVED_FIELDS_SIG = "removedFields"
	Type of signal m_sigModified.

Protected Types inherited from fwTools::fwID
enum	Policy { EMPTY = 1, GENERATE, MUST_EXIST }

typedef std::string	IDType

Protected Member Functions inherited from fwData::Object
FWDATA_API void	fieldDeepCopy (const ::fwData::Object::csptr &source, DeepCopyCacheType &cache)
	Internal-use methods to implement Object's deepCopy.

virtual FWDATA_API void	cachedDeepCopy (const ::fwData::Object::csptr &source, DeepCopyCacheType &cache)=0
	Internal-use methods to implement Object's deepCopy.

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.

Protected Member Functions inherited from fwCom::HasSignals
	HasSignals (const HasSignals &)
	Copy constructor forbidden.

HasSignals &	operator= (const HasSignals &)
	Copy operator forbidden.

Static Protected Member Functions inherited from fwData::Object
static FWDATA_API::fwData::Object::sptr	copy (const ::fwData::Object::csptr &source, DeepCopyCacheType &cache)
	Internal-use methods to implement Object's deepCopy.

template<typename DATA_TYPE >
static std::shared_ptr< DATA_TYPE >	copy (const std::shared_ptr< const DATA_TYPE > &source, DeepCopyCacheType &cache)
	Internal-use methods to implement Object's deepCopy.

template<typename DATA_TYPE >
static std::shared_ptr< DATA_TYPE >	copy (const std::shared_ptr< DATA_TYPE > &source, DeepCopyCacheType &cache)
	Internal-use methods to implement Object's deepCopy.

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

Protected Attributes inherited from fwData::Object
FieldMapType	m_fields
	Fields.

mutable::fwCore::mt::ReadWriteMutex	m_mutex
	Mutex to protect object access.

Protected Attributes inherited from fwTools::Object
std::shared_ptr< ::fwTools::UUID >	m_uuid
	UUID used to identify the object, notably for serialization.

Protected Attributes inherited from fwCom::HasSignals
Signals	m_signals

Detailed Description

This class defines structure traits.

A structure traits contains :

[required] a type (ie. Skin, Liver, ...)
[required] a category (or more) : Body, Head, Neck, Thorax, Abdomen, Pelvis, Arm, Leg, Liver_segments, Other
[required] a class : Tool, Environment, Vessel, Lesion, Organ, Functional, No_constraint
[required] a color
[optional] an attachment only if class is LESION or FUNCTIONAL
[optional] a native ROI expression : ex. inter(world(type(Skin)),not(class(Organ)))
[optional] a native geometric ROI expression

Definition at line 29 of file include/fwData/StructureTraits.hpp.

Constructor & Destructor Documentation

fwData::StructureTraits::StructureTraits ( ::fwData::Object::Key key )

Constructor.

Parameters

key	Private construction key

Definition at line 19 of file src/fwData/StructureTraits.cpp.

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

Public Types

Public Member Functions

Static Public Member Functions

Friends

Demangling methods

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation