Interface Configuration::ComponentConfigurator
IDL source Global index
interface ComponentConfigurator
An interface for representing the dependencies between CORBA Objects.
- See Also:
- Factory
- addHook
-
Adds a hook to the configurator.
- deleteHook
-
Deletes a hook from the configurator.
- destroy
-
Deletes the references to all internal data structures and deactivates
the current object.
- eventOnClient
-
This implementation simply prints the event to the standard output.
- eventOnHookedComponent
-
This implementation simply prints the event to the standard output.
- getHookedComponent
-
Provides a reference to the component attached to the given hook.
- hook
-
Attaches a ComponentConfigurator to the given hook.
- implementation
- Accessor to the object that implement this component.
- info
-
Accessor for the component information string.
- listClients
- Provides a list of the clients of this component.
- listHooks
-
Provides a list of the hooks in this component.
- name
-
Accessor for the component name.
- numberOfClients
- Provides the number of clients of this component.
May be used for garbage collection.
- registerClient
-
Adds a new component to the list of clients.
- unhook
-
Detaches a ComponentConfigurator from the given hook.
- unregisterClient
-
Removes a pair (client, hook) from the list of clients.
- ElementExists
- HookBusy
- HookVacant
- invalidArgument
- NotFound
void addHook(in string hookName)
raises(ElementExists);
-
Adds a hook to the configurator.
- Parameters:
- hookName the name of the hook to be added.
- Raises:
- ElementExists if the hook already exists.
void deleteHook(in string hookName)
raises(NotFound);
-
Deletes a hook from the configurator.
- Parameters:
- hookName the name of the hook to be deleted.
- Raises:
- NotFound if the hook is not found.
void destroy();
-
Deletes the references to all internal data structures and deactivates
the current object.
void eventOnClient(in ComponentConfigurator client,
in Event e,
in unsigned short timeToLive);
-
This implementation simply prints the event to the standard output.
- Parameters:
- client the ComponentConfigurator that generated the event.
- e the event that was generated.
void eventOnHookedComponent(in ComponentConfigurator hookedComponent,
in Event e,
in unsigned short timeToLive);
-
This implementation simply prints the event to the standard output.
- Parameters:
- hookedComponent the ComponentConfigurator that generated the event.
- e the event that was generated.
ComponentConfigurator getHookedComponent(in string hookName);
-
Provides a reference to the component attached to the given hook.
- Returns:
- a reference to the ComponentConfigurator.
void hook(in string hookName,
in ComponentConfigurator cc)
raises(NotFound);
-
Attaches a ComponentConfigurator to the given hook.
- Parameters:
- hookName the name of the hook.
- cc the ComponentConfigurator to be attached to the hook.
- Raises:
- HookBusy if there is already a component attached to the hook.
- NotFound if the hook does not exist.
Object implementation();
- Accessor to the object that implement this component.
- Returns:
- a reference to the CORBA object implementing this component.
string info();
-
Accessor for the component information string.
- Returns:
- a string containing component information.
DependencyList listClients();
- Provides a list of the clients of this component.
- Returns:
- a list of DependencySpecifications.
DependencyList listHooks();
-
Provides a list of the hooks in this component.
- Returns:
- a list of DependencySpecifications.
- See Also:
- DependencySpecification
string name();
-
Accessor for the component name.
- Returns:
- a string containing the component name.
unsigned short numberOfClients();
- Provides the number of clients of this component.
May be used for garbage collection.
- Returns:
- the size of the list of clients.
void registerClient(in ComponentConfigurator client,
in string hookNameInClient)
raises(ElementExists);
-
Adds a new component to the list of clients.
- Parameters:
- client the ComponentConfigurator representing the new client.
- hookNameInClient the name of the hook to which this component is attached.
- Raises:
- ElementExists if the given pair (client, hookNameInClient) is
already present in the client list.
void unhook(in string hookName)
raises(HookVacant, NotFound);
-
Detaches a ComponentConfigurator from the given hook.
- Parameters:
- hookName the name of the hook.
- cc the ComponentConfigurator to be detached.
- Raises:
- HookVacant if there are no components attached to the hook.
- NotFound if the hook does not exist.
void unregisterClient(in ComponentConfigurator client,
in string hookNameInClient)
raises(NotFound);
-
Removes a pair (client, hook) from the list of clients.
- Parameters:
- client the ComponentConfigurator representing the new client.
- hookNameInClient the name of the hook to which this component is attached.
- Raises:
- NotFound if the given pair (client, hookNameInClient) is not
present in the client list.
exception ElementExists {
};
-
exception HookBusy {
};
-
exception HookVacant {
};
-
exception invalidArgument {
};
-
exception NotFound {
};
-
Generated by Sandia idldoc 1.0.