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

NAME

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

DESCRIPTION

9       This interface is a part of the name 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 de‐
12       sirable that the clients uses the names library so they will not be de‐
13       pendent  of  the representation. The lname_component interface supports
14       handling of name components e.g. set and get of the struct members.
15
16       Note that the lname_component interface in orber does not contain a de‐
17       stroy  function  because  the  NameComponents are represented as Erlang
18       records and therefor will be removed by the garbage collector when  not
19       in use.
20
21       The type NameComponent used below is defined as:
22
23       -record('CosNaming_NameComponent', {id, kind=""}).
24
25
26       id and kind are strings.
27
28       The  record  is  defined  in  the file CosNaming.hrl and it is included
29       with:
30
31       -include_lib("orber/COSS/CosNaming/CosNaming.hrl").
32
33

EXPORTS

35       create() -> Return
36
37              Types:
38
39                 Return = NameComponent
40
41              This function returns a new name component.
42
43       get_id(NameComponent) -> Return
44
45              Types:
46
47                 Return = string()
48
49              This function returns the id string of a name component.
50
51       set_id(NameComponent, Id) -> Return
52
53              Types:
54
55                 Id = string()
56                 Return = NameComponent
57
58              This function sets the id string of a name component and returns
59              the component.
60
61       get_kind(NameComponent) -> Return
62
63              Types:
64
65                 Return = string()
66
67              This function returns the id string of a name component.
68
69       set_kind(NameComponent, Kind) -> Return
70
71              Types:
72
73                 Kind = string()
74                 Return = NameComponent
75
76              This  function  sets the kind string of a name component and re‐
77              turns the component.
78
79
80
81Ericsson AB                        orber 5.1                lname_component(3)
Impressum