lname_component(3)

MODULE
lname_component - Interface that supports the name pseudo-objects.

DESCRIPTION

This interface is a part of the name library, which is used to hide the representation of names. In Orbers Erlang mapping the pseudo-object names and the real IDL names have the same representation but it is desirable that the clients uses the names library so they will not be dependent of the representation. The lname_component interface supports handling of name components e.g. set and get of the struct members.

Note that the lname_component interface in orber does not contain a destroy function because the NameComponents are represented as Erlang records and therefor will be removed by the garbage collector when not in use.

The type NameComponent used below is defined as:
      -record('CosNaming_NameComponent', {id, kind=""}).

id and kind are strings.

The record is defined in the file CosNaming.hrl and it is included with:
      -include_lib("orber/COSS/CosNaming/CosNaming.hrl").

EXPORTS

create() -> Return

    Types
        Return = NameComponent

    This function returns a new name component.

get_id(NameComponent) -> Return

    Types
        Return = string()

    This function returns the id string of a name component.

set_id(NameComponent, Id) -> Return

    Types
        Id = string()
        Return = NameComponent

    This function sets the id string of a name component and returns the component.

get_kind(NameComponent) -> Return

    Types
        Return = string()

    This function returns the id string of a name component.

set_kind(NameComponent, Kind) -> Return

    Types
        Kind = string()
        Return = NameComponent

    This function sets the kind string of a name component and returns the component.