Holds navigation information. More...

#include <NavigationSeries.hpp>

Inheritance diagram for fwMedData::NavigationSeries:

Collaboration diagram for fwMedData::NavigationSeries:

Public Types
typedef std::array< double, 3 >	CoordinateType

typedef double	TimestampType

typedef std::map< TimestampType, CoordinateType >	ContainerType

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

FWMEDDATA_API	NavigationSeries (::fwData::Object::Key key)
	Constructor. More...

virtual FWMEDDATA_API	~NavigationSeries ()
	Destructor.

FWMEDDATA_API void	shallowCopy (const ::fwData::Object::csptr &_source) override
	Defines shallow copy.

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

FWMEDDATA_API void	addPosition (TimestampType time, const CoordinateType &pos)
	Adds a position associate with the specified timestamp.

FWMEDDATA_API void	addMove (TimestampType time, const CoordinateType &dir)
	Adds a move direction associate with the specified timestamp.

FWMEDDATA_API void	addLookAt (TimestampType time, const CoordinateType &point)
	Adds a lookAt point associate with the specified timestamp.

FWMEDDATA_API void	erasePosition (TimestampType time)
	Removes the position (if one exists) associate with the specified timestamp.

FWMEDDATA_API void	eraseMove (TimestampType time)
	Removes the move direction (if one exists) associate with the specified timestamp.

FWMEDDATA_API void	eraseLookAt (TimestampType time)
	Removes the lookAt point (if one exists) associate with the specified timestamp.

FWMEDDATA_API void	clearPosition ()
	Clear all positions.

FWMEDDATA_API void	clearMove ()
	Clear all move directions.

FWMEDDATA_API void	clearLookAt ()
	Clear all lookAt points.

FWMEDDATA_API const ContainerType &	getPositionMap () const
	Returns positions map container.

FWMEDDATA_API const ContainerType &	getMoveMap () const
	Returns move map container.

FWMEDDATA_API const ContainerType &	getLookAtMap () const
	Returns lokAt map container.

Public Member Functions inherited from fwMedData::Series
FWMEDDATA_API	Series (::fwData::Object::Key key)
	Constructor. More...

virtual FWMEDDATA_API	~Series ()
	Destructor.

FWMEDDATA_API void	shallowCopy (const ::fwData::Object::csptr &_source) override
	Defines shallow copy.

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

std::shared_ptr< ::fwMedData::Patient >	getPatient () const
	Referring Patient.

void	setPatient (const std::shared_ptr< ::fwMedData::Patient > &val)
	Referring Patient.

std::shared_ptr< ::fwMedData::Study >	getStudy () const
	Referring Study.

void	setStudy (const std::shared_ptr< ::fwMedData::Study > &val)
	Referring Study.

std::shared_ptr< ::fwMedData::Equipment >	getEquipment () const
	Related Equipment.

void	setEquipment (const std::shared_ptr< ::fwMedData::Equipment > &val)
	Related Equipment.

const DicomValueType &	getInstanceUID () const
	Unique identifier of the Series (0020,000E)

void	setInstanceUID (const DicomValueType &val)
	Unique identifier of the Series (0020,000E)

const DicomValueType &	getModality () const
	Type of equipment that originally acquired the data used to create this Series (0008,0060)

void	setModality (const DicomValueType &val)
	Type of equipment that originally acquired the data used to create this Series (0008,0060)

const DicomValueType &	getDate () const
	Date the Series started (0008,0021)

void	setDate (const DicomValueType &val)
	Date the Series started (0008,0021)

const DicomValueType &	getTime () const
	Time the Series started (0008,0031)

void	setTime (const DicomValueType &val)
	Time the Series started (0008,0031)

const DicomValueType &	getDescription () const
	Description of the Series (0008,103E)

void	setDescription (const DicomValueType &val)
	Description of the Series (0008,103E)

const DicomValuesType &	getPerformingPhysiciansName () const
	Name of the physician(s) administering the Series (0008,1050)

void	setPerformingPhysiciansName (const DicomValuesType &val)
	Name of the physician(s) administering the Series (0008,1050)

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...

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 fwMedData::Series
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 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

Protected Attributes
ContainerType	m_position

ContainerType	m_move

ContainerType	m_lookAt

Protected Attributes inherited from fwMedData::Series
std::shared_ptr< Patient >	m_patient
	Referring Patient.

std::shared_ptr< Study >	m_study
	Referring Study.

std::shared_ptr< Equipment >	m_equipment
	Related Equipment.

DicomValueType	m_instanceUID
	Series unique identifier.

DicomValueType	m_modality
	Modality.

DicomValueType	m_date
	Date.

DicomValueType	m_time
	Time.

DicomValueType	m_description
	Description.

DicomValuesType	m_performingPhysiciansName
	Performing physicians name.

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

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.

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

Detailed Description

Holds navigation information.

Definition at line 28 of file NavigationSeries.hpp.

Constructor & Destructor Documentation

fwMedData::NavigationSeries::NavigationSeries ( ::fwData::Object::Key key )

Constructor.

Parameters

key	Private construction key

Definition at line 17 of file src/fwMedData/NavigationSeries.cpp.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Demangling methods

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation