[Ericsson AB]

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:

Id = string()

Name = string()

Function returns the IDL typecode for object_reference.

struct(Id, Name, ElementList) -> TC

Types:

Id = string()

Name = string()
ElementList = [{MemberName, TC}]
MemberName = string()

Function returns the IDL typecode for struct.

union(Id, Name, DiscrTC, Default, ElementList) -> TC

Types:

Id = string()

Name = string()
DiscrTC = TC
Default = integer()
ElementList = [{Label, MemberName, TC}]
Label = term()
DiscrTC
MemberName = string()

Function returns the IDL typecode for union.

enum(Id, Name, ElementList) -> TC

Types:

Id = string()

Name = string()
ElementList = [MemberName]
MemberName = string()

Function returns the IDL typecode for enum.

string(Length) -> TC

Types:

Length = integer()

Function returns the IDL typecode for string.

wstring(Length) -> TC

Types:

Length = integer()

Function returns the IDL typecode for wstring.

fixed(Digits, Scale) -> TC

Types:

Digits = Scale = integer()

Function returns the IDL typecode for fixed.

sequence(ElemTC, Length) -> TC

Types:

ElemTC = TC

Length = integer()

Function returns the IDL typecode for sequence.

array(ElemTC, Length) -> TC

Types:

ElemTC = TC

Length = integer()

Function returns the IDL typecode for array.

alias(Id, Name, AliasTC) -> TC

Types:

Id = string()

Name = string()
AliasTC = TC

Function returns the IDL typecode for alias.

exception(Id, Name, ElementList) -> TC

Types:

Id = string()

Name = string()
ElementList = [{MemberName, TC}]
MemberName = string()

Function returns the IDL typecode for exception.

get_tc(Object) -> TC
get_tc(Id) -> TC

Types:

Object = record()

Id = string()

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.

orber 3.6.8
Copyright © 1991-2008 Ericsson AB