OpenRTM-aist-Python 1.1.2
Classes | Public Member Functions | List of all members
OpenRTM_aist.Manager.Manager Class Reference

Manager class. More...

Classes

class  ECFactoryPredicate
 
class  FactoryPredicate
 
class  Finalized
 
class  InstanceName
 
class  ModulePredicate
 
class  OrbRunner
 OrbRunner class. More...
 
class  Term
 
class  Terminator
 

Public Member Functions

def __init__
 Protected Copy Constructor. More...
 
def init
 Initializa manager. More...
 
def instance
 Get instance of the manager. More...
 
def setModuleInitProc
 Run the Manager. More...
 
def activateManager
 Activate Manager. More...
 
def runManager
 Run the Manager. More...
 
def load
 [CORBA interface] Load module More...
 
def unload
 Unload module. More...
 
def unloadAll
 Unload module. More...
 
def getLoadedModules
 Get loaded module names std::vector<coil::Properties> getLoadedModules();.
 
def getLoadableModules
 Get loadable module names.
 
def registerFactory
 Register RT-Component Factory.
 
def getFactoryProfiles
 Get profiles of factories. More...
 
def registerECFactory
 Register ExecutionContext Factory.
 
def getModulesFactories
 Get the list of all RT-Component Factory.
 
def createComponent
 Create RT-Components. More...
 
def registerComponent
 Register RT-Component directly without Factory.
 
def unregisterComponent
 Register RT-Component directly without Factory.
 
def createContext
 Create Context. More...
 
def deleteComponent
 Unregister RT-Component that is registered in the Manager.
 
def getComponent
 Get RT-Component's pointer.
 
def getComponents
 Get all RT-Component's pointer.
 
def getORB
 Get the pointer to the ORB.
 
def getPOA
 Get the pointer to the RootPOA.
 
def initManager
 Manager internal initialization.
 
def shutdownOnNoRtcs
 Shutdown Manager. More...
 
def initLogger
 System logger initialization.
 
def shutdownLogger
 System Logger finalization.
 
def initORB
 CORBA ORB initialization.
 
def createORBOptions
 ORB command option creation.
 
def createORBEndpoints
 Create Endpoints. More...
 
def createORBEndpointOption
 Create a command optional line of Endpoint of ORB. More...
 
def shutdownORB
 ORB finalization.
 
def initComposite
 PeriodicECSharedComposite initialization. More...
 
def initFactories
 Factories initialization. More...
 
def initManagerServant
 ManagerServant initialization. More...
 
def cleanupComponents
 This method deletes RT-Components. More...
 
def notifyFinalized
 This method deletes RT-Components. More...
 
def procComponentArgs
 bool procComponentArgs(const char* comp_arg, coil::Properties& comp_id, coil::Properties& comp_conf)
 
def configureComponent
 void configureComponent(RTObject_impl* comp, const coil::Properties& prop);
 

Detailed Description

Manager class.

 

Constructor & Destructor Documentation

def OpenRTM_aist.Manager.Manager.__init__ (   self,
  _manager = None 
)

Protected Copy Constructor.

Member Function Documentation

def OpenRTM_aist.Manager.Manager.activateManager (   self)

Activate Manager.

This operation do the following,

  • Activate CORBA POAManager
  • Activate Manager CORBA object
  • Execute the initial procedure call of the Manager

This operationo should be invoked after Manager:init(), and before tunManager().

def OpenRTM_aist.Manager.Manager.cleanupComponents (   self)

This method deletes RT-Components.

This method deletes RT-Components registered by notifyFinalized().

void cleanupComponents();

def OpenRTM_aist.Manager.Manager.createComponent (   self,
  comp_args 
)

Create RT-Components.

Create specified RT-Component's instances via registered Factory. When its instances have been created successfully, the following processings are also executed.

  • Read and set configuration information that was set by external file.
  • Bind ExecutionContext and start operation.
  • Register to naming service.
Parameters
module_nameTarget RT-Component names for the creation
Returns
Created RT-Component's instances
def OpenRTM_aist.Manager.Manager.createContext (   self,
  ec_args 
)

Create Context.

Returns
Created Context's instances

ExecutionContextBase* createContext(const char* ec_args);

def OpenRTM_aist.Manager.Manager.createORBEndpointOption (   self,
  opt,
  endpoints 
)

Create a command optional line of Endpoint of ORB.

Parameters
optORB options
endpointsEndpoints list

void createORBEndpointOption(std::string& opt, coil::vstring& endpoints);

def OpenRTM_aist.Manager.Manager.createORBEndpoints (   self,
  endpoints 
)

Create Endpoints.

Create Endpoints from the configuration.

Parameters
endpointsEndpoints list

void createORBEndpoints(coil::vstring& endpoints);

def OpenRTM_aist.Manager.Manager.getFactoryProfiles (   self)

Get profiles of factories.

Get profiles of factories.

Returns
profiles of factories
def OpenRTM_aist.Manager.Manager.init (   arg)

Initializa manager.

This is the static function to tintialize the Manager. The Manager is initialized by given arguments. At the starting the manager, this static function "must" be called from application program. The manager has two static functions to get the instance, "init()" and "instance()". Since initializing process is only performed by the "init()" function, the "init()" has to be called at the beginning of the lifecycle of the Manager. function.

Parameters
argvThe array of the command line arguments.
def OpenRTM_aist.Manager.Manager.initComposite (   self)

PeriodicECSharedComposite initialization.

Returns
PeriodicECSharedComposite initialization result (Successful:true, Failed:false)
def OpenRTM_aist.Manager.Manager.initFactories (   self)

Factories initialization.

Initialize buffer factories, thread factories, publisher factories, provider factories, and consumer factories.

Returns
PeriodicECSharedComposite initialization result (Successful:true, Failed:false)
def OpenRTM_aist.Manager.Manager.initManagerServant (   self)

ManagerServant initialization.

Returns
Timer Initialization result (Successful:true, Failed:false)
def OpenRTM_aist.Manager.Manager.instance ( )

Get instance of the manager.

This is the static function to get the instance of the Manager. Before calling this function, ensure that the initialization function "init()" is called.

Returns
The only instance reference of the manager
def OpenRTM_aist.Manager.Manager.load (   self,
  fname,
  initfunc 
)

[CORBA interface] Load module

Load module (shared library, DLL etc..) by file name, and invoke initialize function.

Parameters
fnameThe module file name
initfuncThe initialize function name
def OpenRTM_aist.Manager.Manager.notifyFinalized (   self,
  comp 
)

This method deletes RT-Components.

The deleted RT-Component is registered. The registered RT-Components are deleted by cleanupComponents().

Parameters
DeletedRT component

void notifyFinalized(RTObject_impl* comp);

def OpenRTM_aist.Manager.Manager.runManager (   self,
  no_block = None 
)

Run the Manager.

This operation processes the main event loop of the Manager. In this main loop, CORBA's ORB event loop or other processes are performed. As the default behavior, this operation is going to blocking mode and never returns until manager::destroy() is called. When the given argument "no_block" is set to "true", this operation creates a thread to process the event loop internally, and it doesn't block and returns.

Parameters
no_blockfalse: Blocking mode, true: non-blocking mode.
def OpenRTM_aist.Manager.Manager.setModuleInitProc (   self,
  proc 
)

Run the Manager.

This operation sets the initial procedure call to process module initialization, other user defined initialization and so on. The given procedure will be called at the proper timing after the manager initialization, activation and run.

Parameters
procA function pointer to the initial procedure call
def OpenRTM_aist.Manager.Manager.shutdownOnNoRtcs (   self)

Shutdown Manager.

This method shutdowns Manager as follows.

  • "Manager.shutdown_on_nortcs" of configuration is YES.
  • The component is not registered.

void shutdownOnNoRtcs();

def OpenRTM_aist.Manager.Manager.unload (   self,
  fname 
)

Unload module.

Unload shared library.

Parameters
pathnameModule file name
def OpenRTM_aist.Manager.Manager.unloadAll (   self)

Unload module.

Unload all loaded shared library.


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