1lname(3)                   Erlang Module Definition                   lname(3)
2
3
4

NAME

6       lname - Interface that supports the name pseudo-objects.
7

DESCRIPTION

9       This interface is a part of the names library which is used to hide the
10       representation of names. In Orbers  Erlang  mapping  the  pseudo-object
11       names  and  the  real  IDL names have the same representation but it is
12       desirable that the clients uses the names library so they will  not  be
13       dependent  of the representation. The lname interface supports handling
14       of names e.g. adding and removing name components.
15
16       Note that the lname interface in orber does not contain a destroy func‐
17       tion  because  the  Names  are represented as standard Erlang lists and
18       therefor will be removed by the garbage collector when not in use.
19
20       The type NameComponent used below is defined as:
21
22       -record('CosNaming_NameComponent', {id, kind=""}).
23
24
25       id and kind are strings.
26
27       The record is defined in the file  CosNaming.hrl  and  it  is  included
28       with:
29
30       -include_lib("orber/COSS/CosNaming/CosNaming.hrl").
31
32

EXPORTS

34       create() -> Return
35
36              Types:
37
38                 Return = [NameComponent]
39
40              This function returns a new name.
41
42       insert_component(Name, N, NameComponent) -> Return
43
44              Types:
45
46                 Name = [NameComponent]
47                 N = int()
48                 Return = Name
49
50              This  function  returns  a name where the new name component has
51              been inserted as component N in Name.
52
53       get_component(Name, N) -> Return
54
55              Types:
56
57                 Name = [NameComponent]
58                 N = int()
59                 Return = NameComponent
60
61              This function returns the N:th name component in Name.
62
63       delete_component(Name, N) -> Return
64
65              Types:
66
67                 Name = [NameComponent]
68                 N = int()
69                 Return = Name
70
71              This function deletes the N:th  name  component  from  Name  and
72              returns the new name.
73
74       num_component(Name) -> Return
75
76              Types:
77
78                 Name = [NameComponent]
79                 Return = int()
80
81              This function returns a the number of name components in Name.
82
83       equal(Name1, Name2) -> Return
84
85              Types:
86
87                 Name1 = Name2 = [NameComponent]
88                 Return = bool()
89
90              This  function returns true if the two names are equal and false
91              otherwise.
92
93       less_than(Name1, Name2) -> Return
94
95              Types:
96
97                 Name1 = Name2 = [NameComponent]
98                 Return = bool()
99
100              This function returns true if Name1 are lesser  than  Name2  and
101              false otherwise.
102
103       to_idl_form(Name) -> Return
104
105              Types:
106
107                 Name = [NameComponent]
108                 Return = Name
109
110              This  function  just checks if Name is a correct IDL name before
111              returning it because the name representation  is  the  same  for
112              pseudo and IDL names in orber.
113
114       from_idl_form(Name) -> Return
115
116              Types:
117
118                 Name = [NameComponent]
119                 Return = Name
120
121              This function just returns the Name because the name representa‐
122              tion is the same for pseudo and IDL names in orber.
123
124
125
126Ericsson AB                        orber 5.0                          lname(3)