Classes | |
| class | FactoryEntry |
| FactoryEntry class. More... | |
Public Member Functions | |
| def | hasFactory (self, id) |
| bool hasFactory(const Identifier& id) | |
| def | getIdentifiers (self) |
| std::vector<Identifier> getIdentifiers() | |
| def | addFactory (self, id, creator, destructor) |
| ReturnCode addFactory(const Identifier& id, Creator creator, Destructor destructor) | |
| def | removeFactory (self, id) |
| ReturnCode removeFactory(const Identifier& id) | |
| def | createObject (self, id) |
| AbstractClass* createObject(const Identifier& id) | |
| def | deleteObject (self, obj, id=None) |
| ReturnCode deleteObject(const Identifier& id, AbstractClass*& obj) | |
| def | createdObjects (self) |
| Getting created objects. More... | |
| def | isProducerOf (self, obj) |
| Whether a object is a product of this factory. More... | |
| def | objectToIdentifier (self, obj, id) |
| Getting class identifier (ID) from a object. More... | |
| def | objectToCreator (self, obj) |
| Getting destructor of the object. More... | |
| def | objectToDestructor (self, obj) |
| Getting destructor of the object. More... | |
Detailed Description
Member Function Documentation
| def OpenRTM_aist.GlobalFactory.Factory.createdObjects | ( | self | ) |
Getting created objects.
This operation returns a list of created objects by the factory.
- Returns
- created object list
std::vector<AbstractClass*> createdObjects()
| def OpenRTM_aist.GlobalFactory.Factory.isProducerOf | ( | self, | |
| obj | |||
| ) |
Whether a object is a product of this factory.
- Parameters
-
obj A target object
- Returns
- true: The object is a product of the factory false: The object is not a product of the factory
- created object list
bool isProducerOf(AbstractClass* obj)
| def OpenRTM_aist.GlobalFactory.Factory.objectToCreator | ( | self, | |
| obj | |||
| ) |
Getting destructor of the object.
This operation returns a constructor of the object created by the factory. obj must be a product of the factory. User must check if the object is a product of the factory by using isProducerOf()-function, before using this function.
- Returns
- destructor of the object
Creator objectToCreator(AbstractClass* obj)
| def OpenRTM_aist.GlobalFactory.Factory.objectToDestructor | ( | self, | |
| obj | |||
| ) |
Getting destructor of the object.
This operation returns a destructor of the object created by the factory. obj must be a product of the factory. User must check if the object is a product of the factory by using isProducerOf()-function, before using this function.
- Returns
- destructor of the object
Destructor objectToDestructor(AbstractClass* obj)
| def OpenRTM_aist.GlobalFactory.Factory.objectToIdentifier | ( | self, | |
| obj, | |||
| id | |||
| ) |
Getting class identifier (ID) from a object.
This operation returns a class identifier (ID) from a object.
- Parameters
-
obj [in] An object to investigate its class ID. id [out] Class identifier (ID)
- Returns
- Return code NOT_FOUND: ID not found FACTORY_OK: normal return ReturnCode objectToIdentifier(AbstractClass* obj, Identifier& id)
The documentation for this class was generated from the following file:
- /home/openrtm/git-src/OpenRTM-aist-Python/OpenRTM_aist/GlobalFactory.py
