orber_tc
Module
orber_tc
Module Summary
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
the repository ID
the type name of the object
Function returns the IDL typecode for object_reference.
struct(Id, Name, ElementList) -> TC
Types
the repository ID
the type name of the struct
a list of the struct elements
the element name
Function returns the IDL typecode for struct.
union(Id, Name, DiscrTC, Default, ElementList) -> TC
Types
the repository ID
the type name of the union
the typecode for the unions discriminant
a value that indicates which tuple in the element list that is default (value < 0 means no default)
a list of the union elements
the label value should be of the DiscrTCtypethe element name
Function returns the IDL typecode for union.
enum(Id, Name, ElementList) -> TC
Types
the repository ID
the type name of the enum
a list of the enums elements
the element name
Function returns the IDL typecode for enum.
string(Length) -> TC
Types
the length of the string (0 means unbounded)
Function returns the IDL typecode for string.
wstring(Length) -> TC
Types
the length of the wstring (0 means unbounded)
Function returns the IDL typecode for wstring.
fixed(Digits, Scale) -> TC
Types
the digits and scale parameters of a Fixed type
Function returns the IDL typecode for fixed.
sequence(ElemTC, Length) -> TC
Types
the typecode for the sequence elements
the length of the sequence (0 means unbounded)
Function returns the IDL typecode for sequence.
array(ElemTC, Length) -> TC
Types
the typecode for the array elements
the length of the array
Function returns the IDL typecode for array.
alias(Id, Name, AliasTC) -> TC
Types
the repository ID
the type name of the alias
the typecode for the type which the alias refer to
Function returns the IDL typecode for alias.
exception(Id, Name, ElementList) -> TC
Types
the repository ID
the type name of the exception
a list of the exception elements
the element name
Function returns the IDL typecode for exception.
get_tc(Object) -> TC
get_tc(Id) -> TC
Types
an IDL specified struct, union or exception
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.
© 2010–2017 Ericsson AB
Licensed under the Apache License, Version 2.0.