Interface Configuration::ComponentConfigurator

IDL source    Global index
interface ComponentConfigurator

An interface for representing the dependencies between CORBA Objects.

See Also:
Factory


Operation index.

  • addHook
    Adds a hook to the configurator.
  • deleteHook
    Deletes a hook from the configurator.
  • destroy
    Deletes the references to all internal data structures and
  • 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.
  • Exception index.

  • ElementExists
  • HookBusy
  • HookVacant
  • invalidArgument
  • NotFound
  • Operations.

  • addHook

      void addHook(in string hookName)
        raises(ElementExists);
    Adds a hook to the configurator.

  • deleteHook

      void deleteHook(in string hookName)
        raises(NotFound);
    Deletes a hook from the configurator.

  • destroy

      void destroy();
    Deletes the references to all internal data structures and

  • eventOnClient

      void eventOnClient(in ComponentConfigurator client,
          in Event e,
          in unsigned short timeToLive);
    This implementation simply prints the event to the standard output.

  • eventOnHookedComponent

      void eventOnHookedComponent(in ComponentConfigurator hookedComponent,
          in Event e,
          in unsigned short timeToLive);
    This implementation simply prints the event to the standard output.

  • getHookedComponent

      ComponentConfigurator getHookedComponent(in string hookName);
    Provides a reference to the component attached to the given hook.
    Returns:
    a reference to the ComponentConfigurator.
    See Also:
    DependencySpecification

  • hook

      void hook(in string hookName,
          in ComponentConfigurator cc)
        raises(NotFound);
    Attaches a ComponentConfigurator to the given hook.

  • implementation

      Object implementation();
    Accessor to the object that implement this component.
    Returns:
    a reference to the CORBA object implementing this component.

  • info

      string info();
    Accessor for the component information string.

  • listClients

      DependencyList listClients();
    Provides a list of the clients of this component.
    Returns:
    a list of DependencySpecifications.

  • listHooks

      DependencyList listHooks();
    Provides a list of the hooks in this component.
    Returns:
    a list of DependencySpecifications.
    See Also:
    DependencySpecification

  • name

      string name();
    Accessor for the component name.

  • numberOfClients

      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.

  • registerClient

      void registerClient(in ComponentConfigurator client,
          in string hookNameInClient)
        raises(ElementExists);
    Adds a new component to the list of clients.

  • unhook

      void unhook(in string hookName)
        raises(HookVacant, NotFound);
    Detaches a ComponentConfigurator from the given hook.

  • unregisterClient

      void unregisterClient(in ComponentConfigurator client,
          in string hookNameInClient)
        raises(NotFound);
    Removes a pair (client, hook) from the list of clients.

    Exceptions.

  • ElementExists

      exception ElementExists {
      }; 
    

  • HookBusy

      exception HookBusy {
      }; 
    

  • HookVacant

      exception HookVacant {
      }; 
    

  • invalidArgument

      exception invalidArgument {
      }; 
    

  • NotFound

      exception NotFound {
      }; 
    


    Generated by Sandia idldoc 1.0.