any(3erl) Erlang Module Definition any(3erl)NAME
any - the corba any type
DESCRIPTION
This module contains functions that gives an interface to the CORBA any type.
Note that the any interface in orber does not contain a destroy function because the any type is represented as an Erlang record and there-
for will be removed by the garbage collector when not in use.
The type TC used below describes an IDL type and is a tuple according to the to the Erlang language mapping.
The type Any used below is defined as:
-record(any, {typecode, value}).
where typecode is a TC tuple and value is an Erlang term of the type defined by the typecode field.
EXPORTS
create() -> Result
create(Typecode, Value) -> Result
Types Typecode = TC
Value = term()
Result = Any
The create/0 function creates an empty any record and the create/2 function creates an initialized record.
set_typecode(A, Typecode) -> Result
Types A = Any
Typecode = TC
Result = Any
This function sets the typecode of A and returns a new any record.
get_typecode(A) -> Result
Types A = Any
Result = TC
This function returns the typecode of A .
set_value(A, Value) -> Result
Types A = Any
Value = term()
Result = Any
This function sets the value of A and returns a new any record.
get_value(A) -> Result
Types A = Any
Result = term()
This function returns the value of A .
Ericsson AB orber 3.6.20 any(3erl)
Check Out this Related Man Page
orber_tc(3erl) Erlang Module Definition orber_tc(3erl)NAME
orber_tc - Help functions for IDL typecodes
DESCRIPTION
This module contains some functions that gives support in creating IDL typecodes that can be used in for example the any types typecode
field. For the simple types it is meaningless to use this API but the functions exist to get the interface complete.
The type TC used below describes an IDL type and is a tuple according to the to the Erlang language mapping.
EXPORTS
null() -> TC
void() -> TC
short() -> TC
unsigned_short() -> TC
long() -> TC
unsigned_long() -> TC
long_long() -> TC
unsigned_long_long() -> TC
wchar() -> TC
float() -> TC
double() -> TC
boolean() -> TC
char() -> TC
octet() -> TC
any() -> TC
typecode() -> TC
principal() -> TC
These functions return the IDL typecodes for simple types.
object_reference(Id, Name) -> TC
Types Id = string()
the repository ID
Name = string()
the type name of the object
Function returns the IDL typecode for object_reference.
struct(Id, Name, ElementList) -> TC
Types Id = string()
the repository ID
Name = string()
the type name of the struct
ElementList = [{MemberName, TC}]
a list of the struct elements
MemberName = string()
the element name
Function returns the IDL typecode for struct.
union(Id, Name, DiscrTC, Default, ElementList) -> TC
Types Id = string()
the repository ID
Name = string()
the type name of the union
DiscrTC = TC
the typecode for the unions discriminant
Default = integer()
a value that indicates which tuple in the element list that is default (value < 0 means no default)
ElementList = [{Label, MemberName, TC}]
a list of the union elements
Label = term()
the label value should be of the DiscrTC type
MemberName = string()
the element name
Function returns the IDL typecode for union.
enum(Id, Name, ElementList) -> TC
Types Id = string()
the repository ID
Name = string()
the type name of the enum
ElementList = [MemberName]
a list of the enums elements
MemberName = string()
the element name
Function returns the IDL typecode for enum.
string(Length) -> TC
Types Length = integer()
the length of the string (0 means unbounded)
Function returns the IDL typecode for string.
wstring(Length) -> TC
Types Length = integer()
the length of the wstring (0 means unbounded)
Function returns the IDL typecode for wstring.
fixed(Digits, Scale) -> TC
Types Digits = Scale = integer()
the digits and scale parameters of a Fixed type
Function returns the IDL typecode for fixed.
sequence(ElemTC, Length) -> TC
Types ElemTC = TC
the typecode for the sequence elements
Length = integer()
the length of the sequence (0 means unbounded)
Function returns the IDL typecode for sequence.
array(ElemTC, Length) -> TC
Types ElemTC = TC
the typecode for the array elements
Length = integer()
the length of the array
Function returns the IDL typecode for array.
alias(Id, Name, AliasTC) -> TC
Types Id = string()
the repository ID
Name = string()
the type name of the alias
AliasTC = TC
the typecode for the type which the alias refer to
Function returns the IDL typecode for alias.
exception(Id, Name, ElementList) -> TC
Types Id = string()
the repository ID
Name = string()
the type name of the exception
ElementList = [{MemberName, TC}]
a list of the exception elements
MemberName = string()
the element name
Function returns the IDL typecode for exception.
get_tc(Object) -> TC
get_tc(Id) -> TC
Types Object = record()
an IDL specified struct, union or exception
Id = string()
the repository ID
If the get_tc/1 gets a record that is and IDL specified struct, union or exception as a parameter it returns the typecode.
If the parameter is a repository ID it uses the Interface Repository to get the typecode.
check_tc(TC) -> boolean()
Function checks the syntax of an IDL typecode.
Ericsson AB orber 3.6.20 orber_tc(3erl)