ComponentImplementation Class Reference

This class defines an generic implementation for a generic interface (with or without schema). More...

Inheritance diagram for ComponentImplementation:

Public Member Functions
	ComponentImplementation (ComponentFactory *factory=0)
unsigned int	find_property (const CoreString &name, const unsigned int &idx=0) const
	Return the index of the property.
const ComponentInterface *	get_interface () const
	Return the interface this class implements.
const ComponentSchema *	get_schema () const
	Return the schema this class implements.
virtual bool	get_components (const CoreBaseObject &instance, const CoreBasicArray< unsigned int > &indices, ComponentCollection &components) const =0
	Method used to retrieve internal data of the callee organized in a ComponentCollection.
virtual bool	get_static_components (ComponentCollection &components) const
	Method used to retrieve static internal data of the callee organized in a ComponentCollection.
virtual bool	set_components (CoreBaseObject &instance, const CoreBasicArray< unsigned int > &indices, const ComponentCollection &components) const
	Method used to set internal data of the callee.
virtual unsigned int	get_component_count (const CoreBaseObject &instance) const
	Return the number of components available for the specified interface/schema.
virtual unsigned int	get_static_component_count () const
	Return the number of static components available.
virtual bool	get_modified_components (const CoreBaseObject &instance, CoreVector< unsigned int > &modified_component_indices) const
	Return an array of the components that have been modified.
Public Member Functions inherited from CoreBaseObject
bool	is_kindof (const CoreBaseObject &object) const
virtual size_t	get_memory_size () const
CoreString	get_class_info_name () const
const unsigned long &	get_class_info_id () const
virtual bool	is_kindof (const CoreClassInfo &cinfo) const
virtual const CoreClassInfo &	get_class_info () const
template<class T >
T *	cast ()
template<class T >
const T *	cast () const
Public Member Functions inherited from CoreBaseType
bool	is_kindof (const CoreClassInfo &cinfo) const

Friends
class	ComponentFactoryHandler

Additional Inherited Members
Static Public Member Functions inherited from CoreBaseObject
static const CoreClassInfo &	class_info ()
template<class T >
static T *	cast (CoreBaseObject *object)
template<class T >
static const T *	cast (const CoreBaseObject *object)

Detailed Description

This class defines an generic implementation for a generic interface (with or without schema).

Note

The implementation destruction is handled by the ComponentFactory and ComponentInterface. Do not use the same implementation pointer for multiple interfaces or schemas.

Member Function Documentation

unsigned int ComponentImplementation::find_property ( const CoreString &  name, const unsigned int &  idx = 0  ) const

inline

Return the index of the property.

Parameters

[in]	name	name of the property
[in]	idx	starting index (useful if you need to iterate over properties sharing the same name).

Returns

The index of the property if found, otherwise return -1 (0xFFFFFFFF).

virtual unsigned int ComponentImplementation::get_component_count ( const CoreBaseObject &  instance ) const

inlinevirtual

Return the number of components available for the specified interface/schema.

Parameters

[in]

instance

instance to the object so it can access to its internal data

Reimplemented in ComponentStaticImplementation, and ComponentDebugImplementation.

virtual bool ComponentImplementation::get_components ( const CoreBaseObject &  instance, const CoreBasicArray< unsigned int > &  indices, ComponentCollection &  components  ) const

pure virtual

Method used to retrieve internal data of the callee organized in a ComponentCollection.

Parameters

[in]	instance	instance to the object so it can access to its internal data
[in]	indices	indices of requested components. Indices are assumed valid.
[out]	components	components that will be properly filled. Components are assumed to match the requested size.

Returns

false is not implemented

Implemented in ComponentStaticImplementation, and ComponentDebugImplementation.

const ComponentInterface* ComponentImplementation::get_interface ( ) const

inline

Return the interface this class implements.

Note

Make sure to never share the pointer to another interface/schema.

Returns

the interface it implements. Return null if the implementation is not bound to any schema or interface

virtual bool ComponentImplementation::get_modified_components ( const CoreBaseObject &  instance, CoreVector< unsigned int > &  modified_component_indices  ) const

inlinevirtual

Return an array of the components that have been modified.

Parameters

[in]	instance	instance to the object so it can access to its internal data
[out]	modified_component_indices	indices of components that have been modified

Note

This optionnal method is useful in order to automatically serialize modified components (to be reset after deserialization)

Returns

false if not implemented.

const ComponentSchema* ComponentImplementation::get_schema ( ) const

inline

Return the schema this class implements.

Note

Make sure to never share the pointer to another interface/schema.

Returns

the schema it implements. Return null if the implementation is not bound to any schema or interface

virtual bool ComponentImplementation::get_static_components ( ComponentCollection &  components ) const

inlinevirtual

Method used to retrieve static internal data of the callee organized in a ComponentCollection.

Parameters

[out]

components

components that will be properly filled. Components are assumed to match the requested size.

Returns

false is not implemented

virtual bool ComponentImplementation::set_components ( CoreBaseObject &  instance, const CoreBasicArray< unsigned int > &  indices, const ComponentCollection &  components  ) const

inlinevirtual

Method used to set internal data of the callee.

Parameters

[in]	instance	instance to the object so it can access to its internal data
[in]	indices	component indices that are modified. Indices are assumed valid.
[in]	components	components that have been modified. Components are assumed to match input indices size.

Returns

false is not implemented