Provides the notion of Process Object: object having inputs and outputs. More...

#include <ProcessObject.hpp>

Inheritance diagram for fwData::ProcessObject:

Collaboration diagram for fwData::ProcessObject:

Public Types
typedef std::string	ParamNameType

typedef std::vector< std::string >	ParamNameVectorType

typedef std::map< ParamNameType,::fwData::Object::sptr >	ProcessObjectMapType

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	ProcessObject (::fwData::Object::Key key)
	Constructor. More...

virtual FWDATA_API	~ProcessObject ()
	Destructor.

FWDATA_API::fwData::Object::sptr	getInput (const ParamNameType &name)
	Retrieves the input data associated with specified name (null if non exist). More...

template<class OBJECTTYPE >
OBJECTTYPE::sptr	getInput (const ParamNameType &name)
	Retrieves the input data associated with specified name type OBJECTTYPE (null if non exist). More...

FWDATA_API::fwData::Object::sptr	getOutput (const ParamNameType &name)
	Retrieves the output data associated with specified name (null if non exist). More...

template<class OBJECTTYPE >
OBJECTTYPE::sptr	getOutput (const ParamNameType &name)
	Retrieves the output data associated with specified name type OBJECTTYPE (null if non exist). More...

FWDATA_API void	setInputValue (const ParamNameType &name,::fwData::Object::sptr object)
	Register input value with specified name. If the name does already exist, the matching value will be replaced. More...

FWDATA_API void	setOutputValue (const ParamNameType &name,::fwData::Object::sptr object)
	Register output value with specified name. If the name does already exist, the matching value will be replaced. More...

FWDATA_API ParamNameVectorType	getInputsParamNames () const
	Returns vector of input parameters names.

FWDATA_API ParamNameVectorType	getOutputsParamNames () const
	Returns vector of output parameters names.

FWDATA_API void	clearInputs ()
	Unregister all inputs parameters.

FWDATA_API void	clearOutputs ()
	Unregister all output parameters.

FWDATA_API void	shallowCopy (const Object::csptr &source) override
	Defines shallow copy.

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


const ProcessObjectMapType &	getInputs () const
	Retrieve the input data.

void	setInputs (const ProcessObjectMapType &val)
	Retrieve the input data.


const ProcessObjectMapType &	getOutputs () const

void	setOutputs (const ProcessObjectMapType &val)

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

Protected Member Functions
FWDATA_API ParamNameVectorType	getParamNames (const ProcessObjectMapType &params) const
	Returns vector of parameters names from params map.

FWDATA_API void	setValue (const ParamNameType &name,::fwData::Object::sptr object, ProcessObjectMapType &params)
	Register value with specified name in params map. If the name does already exist, the matching value will be replaced. More...

FWDATA_API::fwData::Object::sptr	getValue (const ParamNameType &name, const ProcessObjectMapType &params)
	Retrieves data associated with specified name in params map (null if non exist). More...

FWDATA_API void	clearParams (ProcessObjectMapType &params)
	Unregister all parameters in params map.

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.

Protected Attributes
ProcessObjectMapType	m_inputs
	Inputs values map.

ProcessObjectMapType	m_outputs
	Outputs values map.

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

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

Provides the notion of Process Object: object having inputs and outputs.

Definition at line 29 of file ProcessObject.hpp.

Constructor & Destructor Documentation

fwData::ProcessObject::ProcessObject ( ::fwData::Object::Key key )

Constructor.

Parameters

key	Private construction key

Definition at line 23 of file src/fwData/ProcessObject.cpp.

Member Function Documentation

fwData::Object::sptr fwData::ProcessObject::getInput ( const ParamNameType & name )

Retrieves the input data associated with specified name (null if non exist).

Parameters

[in] name Input name

Returns: null sptr if input is not found

Definition at line 48 of file src/fwData/ProcessObject.cpp.

References getValue(), and m_inputs.

Here is the call graph for this function:

template<class OBJECTTYPE >

OBJECTTYPE::sptr fwData::ProcessObject::getInput ( const ParamNameType & name )

inline

Retrieves the input data associated with specified name type OBJECTTYPE (null if non exist).

Parameters

[in] name Input name

Returns: null sptr if input is not found

Definition at line 181 of file ProcessObject.hpp.

fwData::Object::sptr fwData::ProcessObject::getOutput ( const ParamNameType & name )

Retrieves the output data associated with specified name (null if non exist).

Parameters

[in] name Output name

Returns: null sptr if output is not found

Definition at line 55 of file src/fwData/ProcessObject.cpp.

References getValue(), and m_outputs.

Here is the call graph for this function:

template<class OBJECTTYPE >

OBJECTTYPE::sptr fwData::ProcessObject::getOutput ( const ParamNameType & name )

inline

Retrieves the output data associated with specified name type OBJECTTYPE (null if non exist).

Parameters

[in] name Output name

Returns: null sptr if output is not found

Definition at line 189 of file ProcessObject.hpp.

const ProcessObject::ProcessObjectMapType & fwData::ProcessObject::getOutputs ( ) const

inline

the output data.

Definition at line 210 of file ProcessObject.hpp.

fwData::Object::sptr fwData::ProcessObject::getValue	(	const ParamNameType &	name,
		const ProcessObjectMapType &	params
	)

protected

Retrieves data associated with specified name in params map (null if non exist).

Parameters

[in]	name	Param name
	params	parameters map containing the data

Returns: null sptr if param is not found

Definition at line 35 of file src/fwData/ProcessObject.cpp.

Referenced by getInput(), and getOutput().

Here is the caller graph for this function:

void fwData::ProcessObject::setInputValue	(	const ParamNameType &	name,
		::fwData::Object::sptr	object
	)

Register input value with specified name. If the name does already exist, the matching value will be replaced.

Parameters

[in]	name	Input name
[in]	object	Input value

Definition at line 74 of file src/fwData/ProcessObject.cpp.

References m_inputs, and setValue().

Here is the call graph for this function:

void fwData::ProcessObject::setOutputs ( const ProcessObjectMapType & val )

inline

the output data.

Definition at line 217 of file ProcessObject.hpp.

void fwData::ProcessObject::setOutputValue	(	const ParamNameType &	name,
		::fwData::Object::sptr	object
	)

Register output value with specified name. If the name does already exist, the matching value will be replaced.

Parameters

[in]	name	Output name
[in]	object	Output value

Definition at line 81 of file src/fwData/ProcessObject.cpp.

References m_outputs, and setValue().

Here is the call graph for this function:

void fwData::ProcessObject::setValue	(	const ParamNameType &	name,
		::fwData::Object::sptr	object,
		ProcessObjectMapType &	params
	)

protected

Register value with specified name in params map. If the name does already exist, the matching value will be replaced.

Parameters

[in]	name	Param name
[in]	object	Param
	params	parameters map to insert object

Definition at line 62 of file src/fwData/ProcessObject.cpp.

Referenced by setInputValue(), and setOutputValue().

Here is the caller graph for this function:

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Demangling methods

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation