Base class for class services. More...

#include <cmnClassServicesBase.h>

Inheritance diagram for cmnClassServicesBase:

Public Types
typedef cmnGenericObject *	generic_pointer

Public Member Functions
	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 ()
virtual cmnGenericObject *	Create (void) const =0
virtual cmnGenericObject *	Create (const cmnGenericObject &other) const =0
virtual cmnGenericObject *	CreateWithArg (const cmnGenericObject &arg) const =0
virtual bool	Create (cmnGenericObject *existing, const cmnGenericObject &other) const =0
virtual cmnGenericObject *	CreateArray (size_t size) const =0
virtual cmnGenericObject *	CreateArray (size_t size, const cmnGenericObject &other) const =0
virtual bool	DeleteArray (generic_pointer &data, size_t &size) const =0
virtual bool	Delete (cmnGenericObject *existing) const =0
virtual size_t	GetSize (void) const =0
virtual bool	HasDynamicCreation (void) const =0
virtual bool	DefaultConstructorAvailable (void) const =0
virtual bool	CopyConstructorAvailable (void) const =0
virtual bool	OneArgConstructorAvailable (void) const =0
virtual const cmnClassServicesBase *	GetConstructorArgServices (void) const =0
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

Base class for class services.

See also: cmnClassServices

Member Typedef Documentation

◆ generic_pointer

typedef cmnGenericObject* cmnClassServicesBase::generic_pointer

Type used to refer to cmnGenericObject by pointer, convenient to pass a pointer by reference

Constructor & Destructor Documentation

◆ cmnClassServicesBase()

cmnClassServicesBase::cmnClassServicesBase	(	const std::string &	className,
		const std::type_info *	typeInfo,
		const cmnClassServicesBase *	parentServices,
		const std::string &	libraryName,
		cmnLogMask	mask = CMN_LOG_ALLOW_DEFAULT )

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	Runtime type as defined by C++ RTTI
mask	The log mask to be used with this class.

◆ ~cmnClassServicesBase()

virtual cmnClassServicesBase::~cmnClassServicesBase ( )

inlinevirtual

Virtual destructor. Does nothing.

Member Function Documentation

◆ CopyConstructorAvailable()

virtual bool cmnClassServicesBase::CopyConstructorAvailable ( void ) const

pure virtual

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ Create() [1/3]

virtual bool cmnClassServicesBase::Create	(	cmnGenericObject *	existing,
		const cmnGenericObject &	other ) const

pure virtual

Placement new using copy constructor

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ Create() [2/3]

virtual cmnGenericObject * cmnClassServicesBase::Create ( const cmnGenericObject & other ) const

pure virtual

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.

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ Create() [3/3]

virtual cmnGenericObject * cmnClassServicesBase::Create ( void ) const

pure virtual

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.

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ CreateArray() [1/2]

virtual cmnGenericObject * cmnClassServicesBase::CreateArray ( size_t size ) const

pure virtual

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.

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ CreateArray() [2/2]

virtual cmnGenericObject * cmnClassServicesBase::CreateArray	(	size_t	size,
		const cmnGenericObject &	other ) const

pure virtual

Create an array and fill with an existing object

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ CreateWithArg()

virtual cmnGenericObject * cmnClassServicesBase::CreateWithArg ( const cmnGenericObject & arg ) const

pure virtual

Create with argument

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ DefaultConstructorAvailable()

virtual bool cmnClassServicesBase::DefaultConstructorAvailable ( void ) const

pure virtual

returns information about what types of constructors are available

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ Delete()

virtual bool cmnClassServicesBase::Delete ( cmnGenericObject * existing ) const

pure virtual

Call destructor explicitly

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ DeleteArray()

virtual bool cmnClassServicesBase::DeleteArray	(	generic_pointer &	data,
		size_t &	size ) const

pure virtual

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ GetConstructorArgServices()

virtual const cmnClassServicesBase * cmnClassServicesBase::GetConstructorArgServices ( void ) const

pure virtual

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

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ GetLibraryName()

const std::string & cmnClassServicesBase::GetLibraryName ( void ) const

Get the name of library likely to contain the symbol.

◆ GetLoD()

const cmnLogMask & cmnClassServicesBase::GetLoD ( void ) const

inline

◆ GetLogMask()

const cmnLogMask & cmnClassServicesBase::GetLogMask ( void ) const

Get the log Level of Detail associated with the class. This is the level used to filter the log messages.

Returns: The log Level of Detail.

◆ GetName()

const std::string & cmnClassServicesBase::GetName ( void ) const

Get the name associated with the class.

Returns: The name of the class as a string.

◆ GetParentServices()

const cmnClassServicesBase * cmnClassServicesBase::GetParentServices ( void ) const

inline

◆ GetSize()

virtual size_t cmnClassServicesBase::GetSize ( void ) const

pure virtual

Get the size of the class

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ HasDynamicCreation()

virtual bool cmnClassServicesBase::HasDynamicCreation ( void ) const

pure virtual

Returns whether dynamic creation is available

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ IsDerivedFrom() [1/2]

bool cmnClassServicesBase::IsDerivedFrom ( const cmnClassServicesBase * parentServices ) const

◆ IsDerivedFrom() [2/2]

template<class _Parent>

bool cmnClassServicesBase::IsDerivedFrom ( void ) const

inline

◆ OneArgConstructorAvailable()

virtual bool cmnClassServicesBase::OneArgConstructorAvailable ( void ) const

pure virtual

Implemented in cmnClassServices< _dynamicCreation, _class, _argType >.

◆ SetLoD()

void CISST_DEPRECATED cmnClassServicesBase::SetLoD ( cmnLogMask mask )

inline

◆ SetLogMask()

void cmnClassServicesBase::SetLogMask ( cmnLogMask mask )

Change the log mask for the class.

Parameters

mask	The log mask.

◆ TypeInfoPointer()

const std::type_info * cmnClassServicesBase::TypeInfoPointer ( void ) const

Get the type_info corresponding to the registered class.

Returns: Pointer to the class type_info as defined by C++ RTTI.

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

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

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ generic_pointer

Constructor & Destructor Documentation

◆ cmnClassServicesBase()

◆ ~cmnClassServicesBase()

Member Function Documentation

◆ CopyConstructorAvailable()

◆ Create() [1/3]

◆ Create() [2/3]

◆ Create() [3/3]

◆ CreateArray() [1/2]

◆ CreateArray() [2/2]

◆ CreateWithArg()

◆ DefaultConstructorAvailable()

◆ Delete()

◆ DeleteArray()

◆ GetConstructorArgServices()

◆ GetLibraryName()

◆ GetLoD()

◆ GetLogMask()

◆ GetName()

◆ GetParentServices()

◆ GetSize()

◆ HasDynamicCreation()

◆ IsDerivedFrom() [1/2]

◆ IsDerivedFrom() [2/2]

◆ OneArgConstructorAvailable()

◆ SetLoD()

◆ SetLogMask()

◆ TypeInfoPointer()