Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

GaiaCM Class Reference

GaiaCM - Gaia Component Manager. More...

List of all members.

Public Methods

char init ()
long createContainer_ (char *hostName, char *parameters)
char * createComponent_ (char *hostName, char *className, char *params, long containerID=-1)
char * createComponent_ (Object *execNode, char *className, char *params, long containerID=-1)
char * createComponentInContainer_ (Object *container, char *className, char *params, bool noWait)
Object * getExecutionNode_ (char *hostName)
Object * getObject_ (char *name, char *hostName, int port)
Object * getObject_ (char *ior)
Object * getExecutionNodeFromUCR_ (char *ucr)
Object * getContainer_ (char *hostName, long containerID)
Object * getContainerFromUCR_ (char *ucr)
char deleteComponent_ (char *ucr)
char deleteContainer_ (Object *container)

Static Public Methods

long createContainer (char *hostName, char *parameters)
 Creates a component container.

char * createComponent (char *hostName, char *className, char *params, long containerID=-1)
 Creates a new component.

char * createComponent (Object *execNode, char *className, char *params, long containerID=-1)
 Creates a new component.

char * createComponentInContainer (Object *container, char *className, char *params, bool noWait=false)
 Creates a new component in the specified container.

Object * getExecutionNode (char *hostName)
 Returns a reference (CORBA Object) to an execution node.

Object * getObject (char *name, char *hostName, int port)
 Returns a reference (CORBA Object) to an object (CORBALOC).

Object * getObject (char *ior)
 Returns a reference (CORBA Object) to an object (IOR).

Object * getExecutionNodeFromUCR (char *ucr)
 Returns a reference (CORBA Object) to an execution node.

Object * getContainer (char *hostName, long containerID)
 Returns a reference (CORBA Object) to a component container.

Object * getContainerFromUCR (char *ucr)
 Returns a reference (CORBA Object) to a component container.

char deleteComponent (char *ucr)
 Deletes the specified component.

char deleteContainer (Object *container)
 Deletes the specified container.

Detailed Description

GaiaCM - Gaia Component Manager.

This class provides access to the component manager. These methods allow components to be manipulated on remote execution nodes.

Member Function Documentation

char* GaiaCM::createComponent (  Object *    execNode,
char *    className,
char *    params,
long    containerID = -1
)  [static]
 

Creates a new component.

Parameters:
execnode  Pointer to the execution node object.
className  Name of the component to be created. This name includes de component type and the component name. Ex: Exec/EntryViewer
params  Parameters that will be passed to the new component. Note that the name of the component is compulsory. Ex: -n ComponentName. type and the component name. Ex: Exec/EntryViewer
containerID  ID of the container that will host the component. If no value is passed, the execution node will use a default container.
Returns:
UCR (Unique Component Reference) of the component, or NULL if the component could not be created.

char* GaiaCM::createComponent (  char *    hostName,
char *    className,
char *    params,
long    containerID = -1
)  [static]
 

Creates a new component.

Parameters:
hostName  Name of the execution node that will create the component.
className  Name of the component to be created. This name includes de component type and the component name. Ex: Exec/EntryViewer
params  Parameters that will be passed to the new component. Note that the name of the component is compulsory. Ex: -n ComponentName. type and the component name. Ex: Exec/EntryViewer
containerID  ID of the container that will host the component. If no value is passed, the execution node will use a default container.
Returns:
UCR (Unique Component Reference) of the component, or NULL if the component could not be created.

char* GaiaCM::createComponentInContainer (  Object *    container,
char *    className,
char *    params,
bool    noWait = false
)  [static]
 

Creates a new component in the specified container.

Parameters:
container  Container that will host the execution of the component.
className  Name of the component to be created. This name includes de component type and the component name. Ex: Exec/EntryViewer
params  Parameters that will be passed to the new component. Note that the name of the component is compulsory. Ex: -n ComponentName. type and the component name. Ex: Exec/EntryViewer
Returns:
UCR (Unique Component Reference) of the component, or NULL if the component could not be created.

long GaiaCM::createContainer (  char *    hostName,
char *    parameters
)  [static]
 

Creates a component container.

Parameters:
hostName  Name of the execution node that will create the container.
parameters  List of parameters that will be passed to the container at creation time.
Returns:
Container ID if no problems are found. <0 otherwise.

char GaiaCM::deleteComponent (  char *    ucr )  [static]
 

Deletes the specified component.

Parameters:
ucr  UCR of the component to be deleted.
Returns:
>0 if the operation completed properly. <0 otherwise

char GaiaCM::deleteContainer (  Object *    container )  [static]
 

Deletes the specified container.

Parameters:
container  Pointer to the container to be deleted
Returns:
>0 if the operation completed properly. <0 otherwise

Object* GaiaCM::getContainer (  char *    hostName,
long    containerID
)  [static]
 

Returns a reference (CORBA Object) to a component container.

Parameters:
hostName  Name of the execution node that manages the component container.
containerID  ID of the container to be resolved.
Returns:
A pointer to an object, or 0 if the component container could not be resolved.

Object* GaiaCM::getContainerFromUCR (  char *    ucr )  [static]
 

Returns a reference (CORBA Object) to a component container.

The method uses a UCR as the input and returns the container specified in the UCR.

Parameters:
ucr  Component UCR. TheName of the execution node that manages the component container.
Returns:
A pointer to an object, or 0 if the component container could not be resolved.

Object* GaiaCM::getExecutionNode (  char *    hostName )  [static]
 

Returns a reference (CORBA Object) to an execution node.

Parameters:
hostName  Name of the execution node that we want to obtain.
Returns:
A pointer to an object, or 0 if the execution node could not be resolved. if the component could not be created.

Object* GaiaCM::getExecutionNodeFromUCR (  char *    ucr )  [static]
 

Returns a reference (CORBA Object) to an execution node.

This method uses a UCR as the input and parses it to obtain the name of the execution node.

Parameters:
ucr  The method parses the ucr to obtain the name of the execution node.
Returns:
A pointer to an object, or 0 if the execution node could not be resolved. if the component could not be created.

Object* GaiaCM::getObject (  char *    ior )  [static]
 

Returns a reference (CORBA Object) to an object (IOR).

Parameters:
IOR  String IOR of the object
Returns:
A pointer to an object, or 0 if the object could not be resolved. if the component could not be created.

Object* GaiaCM::getObject (  char *    name,
char *    hostName,
int    port
)  [static]
 

Returns a reference (CORBA Object) to an object (CORBALOC).

Parameters:
name  Name of the remote object
hostName  Name of the host where the object runs.
port  Port where the object listens to requests.
Returns:
A pointer to an object, or 0 if the objec could not be resolved. if the component could not be created.

The documentation for this class was generated from the following file:
Generated on Wed Sep 18 18:10:51 2002 for Gaia by doxygen1.2.16