Class services. More...

#include <cmnClassServices.h>

Inheritance diagram for cmnClassServices< _dynamicCreation, _class, _argType >:

Public Types
typedef cmnClassServicesBase	BaseType
typedef cmnGenericObject *	generic_pointer
Public Types inherited from cmnClassServicesBase
typedef cmnGenericObject *	generic_pointer

Public Member Functions
	cmnClassServices (const std::string &className, const std::type_info typeInfo, const cmnClassServicesBase parentServices, const std::string &libraryName, cmnLogMask mask=CMN_LOG_ALLOW_DEFAULT)
virtual cmnGenericObject *	Create (void) const
virtual cmnGenericObject *	Create (const cmnGenericObject &other) const
virtual cmnGenericObject *	CreateWithArg (const cmnGenericObject &arg) const
virtual bool	Create (cmnGenericObject *existing, const cmnGenericObject &other) const
virtual cmnGenericObject *	CreateArray (size_t size) const
virtual cmnGenericObject *	CreateArray (size_t size, const cmnGenericObject &other) const
virtual bool	DeleteArray (generic_pointer &data, size_t &size) const
virtual bool	Delete (cmnGenericObject *existing) const
virtual size_t	GetSize (void) const
bool	HasDynamicCreation (void) const
bool	DefaultConstructorAvailable (void) const
bool	CopyConstructorAvailable (void) const
bool	OneArgConstructorAvailable (void) const
const cmnClassServicesBase *	GetConstructorArgServices (void) const
Public Member Functions inherited from cmnClassServicesBase
	cmnClassServicesBase (const std::string &className, const std::type_info typeInfo, const cmnClassServicesBase parentServices, const std::string &libraryName, cmnLogMask mask=CMN_LOG_ALLOW_DEFAULT)
virtual	~cmnClassServicesBase ()
const std::string &	GetName (void) const
const std::type_info *	TypeInfoPointer (void) const
const cmnLogMask &	GetLogMask (void) const
const cmnLogMask &	GetLoD (void) const
void	SetLogMask (cmnLogMask mask)
void CISST_DEPRECATED	SetLoD (cmnLogMask mask)
const cmnClassServicesBase *	GetParentServices (void) const
bool	IsDerivedFrom (const cmnClassServicesBase *parentServices) const
template<class _Parent>
bool	IsDerivedFrom (void) const
const std::string &	GetLibraryName (void) const

Detailed Description

template<int _dynamicCreation, class _class, class _argType = _class>
class cmnClassServices< _dynamicCreation, _class, _argType >

Class services.

If dynamic creation is enabled, class must have public default constructor and copy constructor.

See also: cmnClassRegister cmnClassServicesBase

Member Typedef Documentation

◆ BaseType

template<int _dynamicCreation, class _class, class _argType = _class>

typedef cmnClassServicesBase cmnClassServices< _dynamicCreation, _class, _argType >::BaseType

Type of the base class, i.e. cmnClassServicesBase.

◆ generic_pointer

template<int _dynamicCreation, class _class, class _argType = _class>

typedef cmnGenericObject* cmnClassServices< _dynamicCreation, _class, _argType >::generic_pointer

Constructor & Destructor Documentation

◆ cmnClassServices()

template<int _dynamicCreation, class _class, class _argType = _class>

cmnClassServices< _dynamicCreation, _class, _argType >::cmnClassServices	(	const std::string &	className,
		const std::type_info *	typeInfo,
		const cmnClassServicesBase *	parentServices,
		const std::string &	libraryName,
		cmnLogMask	mask = CMN_LOG_ALLOW_DEFAULT )

inline

Constructor. Sets the name of the class and the Level of Detail setting for the class.

Parameters

className	The name to be associated with the class.
typeInfo	Type information as defined by typeid() (see C++ RTTI)
mask	The log mask to be used with this class.

Member Function Documentation

◆ CopyConstructorAvailable()

template<int _dynamicCreation, class _class, class _argType = _class>

bool cmnClassServices< _dynamicCreation, _class, _argType >::CopyConstructorAvailable ( void ) const

inlinevirtual

Implements cmnClassServicesBase.

◆ Create() [1/3]

template<int _dynamicCreation, class _class, class _argType = _class>

virtual bool cmnClassServices< _dynamicCreation, _class, _argType >::Create	(	cmnGenericObject *	existing,
		const cmnGenericObject &	other ) const

inlinevirtual

Placement new using copy constructor

Implements cmnClassServicesBase.

◆ Create() [2/3]

template<int _dynamicCreation, class _class, class _argType = _class>

virtual cmnGenericObject * cmnClassServices< _dynamicCreation, _class, _argType >::Create ( const cmnGenericObject & other ) const

inlinevirtual

Create a new empty object of the same type as represented by this object using the copy constructor. This can be used whenever an object needs to be dynamically created (e.g. deserialization, object factory). This method uses the C++ "new" operator and the programmers should remember to use a matching "delete" if needed.

Parameters

other A object derived from cmnGenericObject which should be of the same type as the type represented by this cmnClassServices object.

Returns: a pointer to the newly created object or null if object cannot be created. This could happen when the class services where created with CMN_NO_DYNAMIC_CREATION or if the object provided is not of the right type and the copy constructor can not be called.

Implements cmnClassServicesBase.

◆ Create() [3/3]

template<int _dynamicCreation, class _class, class _argType = _class>

virtual cmnGenericObject * cmnClassServices< _dynamicCreation, _class, _argType >::Create ( void ) const

inlinevirtual

Create a new empty object of the same type as represented by this object. This can be used whenever an object needs to be dynamically created (e.g. deserialization, object factory). This method uses the C++ "new" operator and the programmers should remember to use a matching "delete" if needed.

Returns: a pointer to the newly created object or null if object cannot be created. This could happen when the class services where created with CMN_NO_DYNAMIC_CREATION.

Implements cmnClassServicesBase.

◆ CreateArray() [1/2]

template<int _dynamicCreation, class _class, class _argType = _class>

virtual cmnGenericObject * cmnClassServices< _dynamicCreation, _class, _argType >::CreateArray ( size_t size ) const

inlinevirtual

Create a new empty array of objects of the same type as represented by this object. This can be used whenever an object needs to be dynamically created (e.g. deserialization, object factory). This method uses the C++ "new[size]" operator and the programmers should remember to use a matching "delete" if needed.

Returns: a pointer to the newly created object or null if object cannot be created. This could happen when the class services where created with CMN_NO_DYNAMIC_CREATION.

Implements cmnClassServicesBase.

◆ CreateArray() [2/2]

template<int _dynamicCreation, class _class, class _argType = _class>

virtual cmnGenericObject * cmnClassServices< _dynamicCreation, _class, _argType >::CreateArray	(	size_t	size,
		const cmnGenericObject &	other ) const

inlinevirtual

Create an array and fill with an existing object

Implements cmnClassServicesBase.

◆ CreateWithArg()

template<int _dynamicCreation, class _class, class _argType = _class>

virtual cmnGenericObject * cmnClassServices< _dynamicCreation, _class, _argType >::CreateWithArg ( const cmnGenericObject & arg ) const

inlinevirtual

Create with argument

Implements cmnClassServicesBase.

◆ DefaultConstructorAvailable()

template<int _dynamicCreation, class _class, class _argType = _class>

bool cmnClassServices< _dynamicCreation, _class, _argType >::DefaultConstructorAvailable ( void ) const

inlinevirtual

returns information about what types of constructors are available

Implements cmnClassServicesBase.

◆ Delete()

template<int _dynamicCreation, class _class, class _argType = _class>

virtual bool cmnClassServices< _dynamicCreation, _class, _argType >::Delete ( cmnGenericObject * existing ) const

inlinevirtual

Call destructor explicitly

Implements cmnClassServicesBase.

◆ DeleteArray()

template<int _dynamicCreation, class _class, class _argType = _class>

virtual bool cmnClassServices< _dynamicCreation, _class, _argType >::DeleteArray	(	generic_pointer &	data,
		size_t &	size ) const

inlinevirtual

Implements cmnClassServicesBase.

◆ GetConstructorArgServices()

template<int _dynamicCreation, class _class, class _argType = _class>

const cmnClassServicesBase * cmnClassServices< _dynamicCreation, _class, _argType >::GetConstructorArgServices ( void ) const

inlinevirtual

return class services for constructor argument (0 if no class services or does not exist)

Implements cmnClassServicesBase.

◆ GetSize()

template<int _dynamicCreation, class _class, class _argType = _class>

virtual size_t cmnClassServices< _dynamicCreation, _class, _argType >::GetSize ( void ) const

inlinevirtual

Get the size of the class

Implements cmnClassServicesBase.

◆ HasDynamicCreation()

template<int _dynamicCreation, class _class, class _argType = _class>

bool cmnClassServices< _dynamicCreation, _class, _argType >::HasDynamicCreation ( void ) const

inlinevirtual

Returns whether dynamic creation is available

Implements cmnClassServicesBase.

◆ OneArgConstructorAvailable()

template<int _dynamicCreation, class _class, class _argType = _class>

bool cmnClassServices< _dynamicCreation, _class, _argType >::OneArgConstructorAvailable ( void ) const

inlinevirtual

Implements cmnClassServicesBase.

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

tmp/cisst-saw/cisst/cisstCommon/cmnClassServices.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ BaseType

◆ generic_pointer

Constructor & Destructor Documentation

◆ cmnClassServices()

Member Function Documentation

◆ CopyConstructorAvailable()

◆ Create() [1/3]

◆ Create() [2/3]

◆ Create() [3/3]

◆ CreateArray() [1/2]

◆ CreateArray() [2/2]

◆ CreateWithArg()

◆ DefaultConstructorAvailable()

◆ Delete()

◆ DeleteArray()

◆ GetConstructorArgServices()

◆ GetSize()

◆ HasDynamicCreation()

◆ OneArgConstructorAvailable()