adtf::ucom::ant::IClassFactory Class Reference

#include <class_factory_intf.h>

Inherits adtf::ucom::ant::IObject.

Public Member Functions
	ADTF_IID (IClassFactory, "class_factory.ant.ucom.adtf.iid")
virtual tResult	CreateInstance (const char *strCID, iobject_ptr< IObject > &oObject, const tChar *strNameOfObject="") const =0
virtual tResult	GetClasses (iobject_enum< const IClassInfo > &lstOfClasses) const =0
	Enumerates all classes supported by the class factory and pushes it to lstOfClasses This method should be used for debugging or testing purposes only.
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	~IClassFactory ()=default
	Protected destructor --> Only the final implementation can be destroyed!
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

The IClassFactory interface provides methods for creating new class instances.

Member Function Documentation

ADTF_IID()

adtf::ucom::ant::IClassFactory::ADTF_IID	(	IClassFactory	,
		"class_factory.ant.ucom.adtf.iid"	)

Marks the IClassFactory to be castable with the ucom_cast<>

See also

ADTF_IID(_interface, _striid)

CreateInstance()

virtual tResult adtf::ucom::ant::IClassFactory::CreateInstance ( const char * strCID, iobject_ptr< IObject > & oObject, const tChar * strNameOfObject = "" ) const

pure virtual

Creates a new instance. The CreateInstance method creates a single uninitialized object of the class associated with a specified class identifier.

Parameters

[in]	strCID	Class identifier of the object to create!
[in]	strNameOfObject	ObjectName identifier (will be relevant only if the ClassFactory can handle this).
[in,out]	oObject	Object to create to be used to communicate with the object.

Returns

Returns a standard result code.

Return values

ERR_ERR_INVALID_LICENSE	no valid license found
Return	Value of iobject_ptr<IObject>::Reset()

GetClasses()

virtual tResult adtf::ucom::ant::IClassFactory::GetClasses ( iobject_enum< const IClassInfo > & lstOfClasses ) const

pure virtual

Enumerates all classes supported by the class factory and pushes it to lstOfClasses This method should be used for debugging or testing purposes only.

Parameters

[in,out]

lstOfClasses

List to return the class information to. Use object_list or object_vector.

Returns

Returns a standard result code.

See also

object_list, object_vector.

---

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

• src/libraries/ucom3/include/adtfucom3/interfaces/class_factory_intf.h