RTI Connext Java API
Version 5.3.1
|
The definition of a particular data type, which you can use to inspect the name, members, and other properties of types generated with rtiddsgen or to modify types you define yourself at runtime. More...
Inherits Serializable.
Public Member Functions | |
TCKind | kind () |
Gets the com.rti.dds.typecode.TCKind value of a type code. | |
ExtensibilityKind | extensibility_kind () |
Gets the com.rti.dds.typecode.ExtensibilityKind value of a type code. | |
boolean | equal (TypeCode tc) |
Compares two com.rti.dds.typecode.TypeCode objects for equality. | |
boolean | equals (Object tc) |
Compares two com.rti.dds.typecode.TypeCode objects for equality. | |
boolean | assignable (TypeCode from) |
Checks if this com.rti.dds.typecode.TypeCode is assignable from the input com.rti.dds.typecode.TypeCode. | |
int | length () throws BadKind |
Returns the number of elements in the type described by this type code. | |
String | name () throws BadKind |
Retrieves the simple name identifying this com.rti.dds.typecode.TypeCode object within its enclosing scope. | |
boolean | is_alias_pointer () throws BadKind |
Function that tells if an alias is a pointer or not. | |
short | type_modifier () throws BadKind |
Returns a constant indicating the modifier of the value type that this com.rti.dds.typecode.TypeCode object describes. | |
TypeCode | concrete_base_type () throws BadKind |
Returns the com.rti.dds.typecode.TypeCode that describes the concrete base type of the value type that this com.rti.dds.typecode.TypeCode object describes. | |
TypeCode | content_type () throws BadKind |
Returns the com.rti.dds.typecode.TypeCode object representing the type for the members of the object described by this com.rti.dds.typecode.TypeCode object. | |
int | array_dimension_count () throws BadKind |
This function returns the number of dimensions of an array type code. | |
int | array_dimension (int index) throws BadKind,Bounds |
This function returns the index-th dimension of an array type code. | |
int | element_count () throws BadKind |
The number of elements in an array. | |
int | member_count () throws BadKind |
Returns the number of members of the type code. | |
String | member_name (int index) throws BadKind,Bounds |
Returns the name of a type code member identified by the given index. | |
TypeCode | member_type (int index) throws BadKind,Bounds |
Retrieves the com.rti.dds.typecode.TypeCode object describing the type of the member identified by the given index. | |
int | member_id (int index) throws BadKind,Bounds |
Returns the ID of the TypeCode member identified by the given index. | |
int | member_label_count (int index) throws BadKind,Bounds |
Returns the number of labels associated to the index-th union member. | |
int | member_label (int member_index, int label_index) throws BadKind,Bounds |
Return the label_index-th label associated to the member_index-th member. | |
int | member_ordinal (int index) throws BadKind,Bounds |
Returns the ordinal that corresponds to the index-th enum value. | |
boolean | is_member_key (int index) throws BadKind,Bounds |
Function that tells if a member is a key or not. | |
boolean | is_member_required (int index) throws BadKind,Bounds |
Indicates whether a given member of a type is required to be present in every sample of that type. | |
boolean | is_member_pointer (int index) throws BadKind,Bounds |
Function that tells if a member is a pointer or not. | |
boolean | is_member_bitfield (int index) throws BadKind,Bounds |
Function that tells if a member is a bitfield or not. | |
short | member_bitfield_bits (int index) throws BadKind,Bounds |
Returns the number of bits of a bitfield member. | |
short | member_visibility (int index) throws BadKind,Bounds |
Returns the constant that indicates the visibility of the index-th member. | |
TypeCode | discriminator_type () throws BadKind |
Returns the discriminator type code. | |
int | default_index () throws BadKind |
Returns the index of the default member, or -1 if there is no default member. | |
int | find_member_by_id (int id) throws BadKind |
Get the index of the member of the given ID. | |
int | find_member_by_name (String name) throws BadKind |
Get the index of the member of the given name. | |
void | print_IDL (int indent) |
Prints a com.rti.dds.typecode.TypeCode in a pseudo-IDL notation. | |
void | print_IDL (int indent, Writer out) throws IOException |
Prints a com.rti.dds.typecode.TypeCode in a pseudo-IDL notation. | |
void | print_complete_IDL (Writer writer) throws IOException |
int | add_member (String name, int id, TypeCode tc, byte member_flags) throws BadKind,BadMemberName,BadMemberId |
Add a new member to this com.rti.dds.typecode.TypeCode. | |
synchronized int | add_member (String name, int id, TypeCode tc, byte member_flags, short visibility, boolean is_pointer, short bits) throws BadKind,BadMemberName,BadMemberId,BAD_PARAM,IllegalStateException |
Add a new member to this com.rti.dds.typecode.TypeCode. | |
synchronized int | add_member_to_enum (String name, int ordinal) throws BadKind,BadMemberName |
Add a new enumerated constant to this enum com.rti.dds.typecode.TypeCode. | |
synchronized int | add_member_to_union (String name, int id, int labels_in[], TypeCode tc, boolean is_pointer) throws BadKind,BadMemberName, BadMemberId |
Add a new member to a union com.rti.dds.typecode.TypeCode. | |
String | signature () throws RETCODE_ERROR |
Gets an MD5 signature of the com.rti.dds.typecode.TypeCode. | |
long | get_type_object_serialized_size () |
Gets the serialized size of the TypeObject created from this com.rti.dds.typecode.TypeCode. | |
Static Public Attributes | |
static final TypeCode | TC_NULL |
Basic null type. | |
static final TypeCode | TC_SHORT |
Basic 16-bit signed integer type. | |
static final TypeCode | TC_LONG |
Basic 32-bit signed integer type. | |
static final TypeCode | TC_USHORT |
Basic unsigned 16-bit integer type. | |
static final TypeCode | TC_ULONG |
Basic unsigned 32-bit integer type. | |
static final TypeCode | TC_FLOAT |
Basic 32-bit floating point type. | |
static final TypeCode | TC_DOUBLE |
Basic 64-bit floating point type. | |
static final TypeCode | TC_BOOLEAN |
Basic Boolean type. | |
static final TypeCode | TC_CHAR |
Basic single-byte character type. | |
static final TypeCode | TC_OCTET |
Basic octet/byte type. | |
static final TypeCode | TC_LONGLONG |
Basic 64-bit integer type. | |
static final TypeCode | TC_ULONGLONG |
Basic unsigned 64-bit integer type. | |
static final TypeCode | TC_LONGDOUBLE |
Basic 128-bit floating point type. | |
static final TypeCode | TC_WCHAR |
Basic four-byte character type. | |
static final int | MEMBER_ID_INVALID |
A sentinel indicating an invalid com.rti.dds.typecode.TypeCode member ID. | |
static final int | MAX_MEMBER_ID |
Maximum value for member id. ID. | |
static final int | INDEX_INVALID |
A sentinel indicating an invalid com.rti.dds.typecode.TypeCode member index. | |
static final byte | NONKEY_MEMBER |
A flag indicating that a type member is optional and not part of the key. | |
static final byte | KEY_MEMBER |
A flag indicating that a type member is part of the key for that type, and therefore required. | |
static final byte | NONKEY_REQUIRED_MEMBER |
A flag indicating that a type member is not part of the key but is nevertheless required. | |
static final short | NOT_BITFIELD |
Indicates that a member of a type is not a bitfield. | |
The definition of a particular data type, which you can use to inspect the name, members, and other properties of types generated with rtiddsgen or to modify types you define yourself at runtime.
You create com.rti.dds.typecode.TypeCode objects using the com.rti.dds.typecode.TypeCodeFactory singleton. Then you can use the methods on this class to inspect and modify the data type definition.
This class is based on a similar class from CORBA.
TCKind kind | ( | ) |
Gets the com.rti.dds.typecode.TCKind value of a type code.
Retrieves the kind of this com.rti.dds.typecode.TypeCode object. The kind of a type code determines which com.rti.dds.typecode.TypeCode methods may legally be invoked on it.
ExtensibilityKind extensibility_kind | ( | ) |
Gets the com.rti.dds.typecode.ExtensibilityKind value of a type code.
Retrieves the extensibility kind of this com.rti.dds.typecode.TypeCode object.
In some cases, it is desirable for types to evolve without breaking interoperability with deployed components already using those types. For example:
A new set of applications to be integrated into an existing system may want to introduce additional fields into a structure. These new fields can be safely ignored by already deployed applications, but applications that do understand the new fields can benefit from their presence.
In order to support use cases such as these, the type system introduces the concept of extensible and mutable types.
A type may be final, indicating that the range of its possible data values is strictly defined. In particular, it is not possible to add elements to members of collection or aggregated types while maintaining type assignability.
A type may be extensible, indicating that two types, where one contains all of the elements/members of the other plus additional elements/members appended to the end, may remain assignable.
The extensibility of com.rti.dds.typecode.TCKind.TK_STRUCT, com.rti.dds.typecode.TCKind.TK_UNION, com.rti.dds.typecode.TCKind.TK_VALUE, and com.rti.dds.typecode.TCKind.TK_ENUM can be change using the built-in "Extensibility" annotation when the type is declared.
IDL examples:
XML example:
XSD example:
For TypeCodes built at run-time using the com.rti.dds.typecode.TypeCodeFactory API, the extensibility can be provided as a parameter of the following APIs:
boolean equal | ( | TypeCode | tc | ) |
Compares two com.rti.dds.typecode.TypeCode objects for equality.
For equality and assignability purposes, com.rti.dds.typecode.TCKind.TK_STRUCT and com.rti.dds.typecode.TCKind.TK_VALUE are considered equivalent.
The com.rti.dds.typecode.TypeCode of structs inheriting from other structs has a com.rti.dds.typecode.TCKind.TK_VALUE kind.
For example:
The code generation for the previous type will generate a com.rti.dds.typecode.TypeCode with com.rti.dds.typecode.TCKind.TK_VALUE kind.
tc | <<in>> Type code that will be compared with this com.rti.dds.typecode.TypeCode. |
com.rti.dds.infrastructure.ExceptionCode_t.BAD_PARAM | if tc is null. |
boolean equals | ( | Object | tc | ) |
Compares two com.rti.dds.typecode.TypeCode objects for equality.
tc | <<in>> Type code that will be compared with this com.rti.dds.typecode.TypeCode. |
boolean assignable | ( | TypeCode | from | ) |
Checks if this com.rti.dds.typecode.TypeCode is assignable from the input com.rti.dds.typecode.TypeCode.
This method checks if this type code is assignable from the type code provided as a parameter.
In order to maintain the loose coupling between data producers and consumers, especially as systems change over time, it is desirable that the two be permitted to use slightly different versions of a type, and that the infrastructure perform any necessary translation. To support type evolution and inheritance the type system defines the "is-assignable-from" directed binary relationship between every pair of types in the Type System.
Intuitively, if T1 is-assignable-from T2, it means that in general it is possible, in a structural way, to set the contents of an object of type T1 to the contents of an object of T2 (or perhaps a subset of those contents) without leading to incorrect interpretations of that information.
For example:
The previous two types that are related to each other by an inheritance relationship are assignable.
For additional information on type assignability refer to the OMG Extensible and Dynamic Topic Types for DDS Specification.
from | <<in>> From type code |
int length | ( | ) | throws BadKind |
Returns the number of elements in the type described by this type code.
Length is:
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
String name | ( | ) | throws BadKind |
Retrieves the simple name identifying this com.rti.dds.typecode.TypeCode object within its enclosing scope.
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
boolean is_alias_pointer | ( | ) | throws BadKind |
Function that tells if an alias is a pointer or not.
This function is an RTI Connext extension to the CORBA Type Code Specification.
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
short type_modifier | ( | ) | throws BadKind |
Returns a constant indicating the modifier of the value type that this com.rti.dds.typecode.TypeCode object describes.
For com.rti.dds.typecode.TCKind.TK_STRUCT, this method always returns com.rti.dds.typecode.ValueModifier.VM_NONE.
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
Returns the com.rti.dds.typecode.TypeCode that describes the concrete base type of the value type that this com.rti.dds.typecode.TypeCode object describes.
For com.rti.dds.typecode.TCKind.TK_STRUCT, this method always returns com.rti.dds.typecode.TCKind.TK_NULL.
The com.rti.dds.typecode.TypeCode of structs inheriting from other structs has a com.rti.dds.typecode.TCKind.TK_VALUE kind.
For example:
The code generation for the previous type will generate a com.rti.dds.typecode.TypeCode with com.rti.dds.typecode.TCKind.TK_VALUE kind.
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
Returns the com.rti.dds.typecode.TypeCode object representing the type for the members of the object described by this com.rti.dds.typecode.TypeCode object.
For sequences and arrays, it returns the element type. For aliases, it returns the original type.
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
int array_dimension_count | ( | ) | throws BadKind |
This function returns the number of dimensions of an array type code.
This function is an RTI Connext extension to the CORBA Type Code Specification.
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
This function returns the index-th dimension of an array type code.
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Dimension index in the interval [0,(dimensions count-1)]. |
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
com.rti.dds.infrastructure.ExceptionCode_t.Bounds | - if the index parameter/s are out of range. |
int element_count | ( | ) | throws BadKind |
The number of elements in an array.
This operation isn't relevant for other kinds of types.
int member_count | ( | ) | throws BadKind |
Returns the number of members of the type code.
The method member_count can be invoked on structure, union, and enumeration com.rti.dds.typecode.TypeCode objects.
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
Returns the name of a type code member identified by the given index.
The method member_name can be invoked on structure, union, and enumeration com.rti.dds.typecode.TypeCode objects.
index | <<in>> Member index in the interval [0,(member count-1)]. |
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
com.rti.dds.infrastructure.ExceptionCode_t.Bounds | - if the index parameter/s are out of range. |
Retrieves the com.rti.dds.typecode.TypeCode object describing the type of the member identified by the given index.
The method member_type can be invoked on structure and union type codes.
index | <<in>> Member index in the interval [0,(member count-1)]. |
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
com.rti.dds.infrastructure.ExceptionCode_t.Bounds | - if the index parameter/s are out of range. |
Returns the ID of the TypeCode member identified by the given index.
This function is an RTI Connext extension to the CORBA Type Code Specification.
The method can be invoked on aggregation com.rti.dds.typecode.TypeCode objects.
All members of aggregated types have an integral member ID that uniquely identifies them within their defining type.
In IDL, you can specify the member ID using the built-in annotation ID. For example:
In XML, you can specify the member ID using the attribute 'id':
In XSD, you can specify the member ID using the built-in annotation ID
index | <<in>> Member index in the interval [0,(member count-1)]. |
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
com.rti.dds.infrastructure.ExceptionCode_t.Bounds | - if the index parameter/s are out of range. |
Returns the number of labels associated to the index-th union member.
The method can be invoked on union com.rti.dds.typecode.TypeCode objects.
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Member index in the interval [0,(member count-1)]. |
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
com.rti.dds.infrastructure.ExceptionCode_t.Bounds | - if the index parameter/s are out of range. |
Return the label_index-th label associated to the member_index-th member.
This method has been modified for RTI Connext from the CORBA Type code Specification.
Example:
case 1: Label index 0
case 2: Label index 1
short short_member;
The method can be invoked on union com.rti.dds.typecode.TypeCode objects.
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
com.rti.dds.infrastructure.ExceptionCode_t.Bounds | - if the index parameter/s are out of range. |
Returns the ordinal that corresponds to the index-th enum value.
The method can be invoked on enum com.rti.dds.typecode.TypeCode objects.
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Member index in the interval [0,(member count-1)]. |
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
com.rti.dds.infrastructure.ExceptionCode_t.Bounds | - if the index parameter/s are out of range. |
Function that tells if a member is a key or not.
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Member index in the interval [0,(member count-1)]. |
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
com.rti.dds.infrastructure.ExceptionCode_t.Bounds | - if the index parameter/s are out of range. |
Indicates whether a given member of a type is required to be present in every sample of that type.
A non-key member is required if it has not been marked as optional. All key members are required.
Function that tells if a member is a pointer or not.
The method is_member_pointer can be invoked on union and structs type objects
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Index of the member for which type information is begin requested. |
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
com.rti.dds.infrastructure.ExceptionCode_t.Bounds | - if the index parameter/s are out of range. |
Function that tells if a member is a bitfield or not.
The method can be invoked on struct type objects.
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Member index in the interval [0,(member count-1)]. |
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
com.rti.dds.infrastructure.ExceptionCode_t.Bounds | - if the index parameter/s are out of range. |
Returns the number of bits of a bitfield member.
The method can be invoked on struct type objects.
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Member index in the interval [0,(member count-1)]. |
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
com.rti.dds.infrastructure.ExceptionCode_t.Bounds | - if the index parameter/s are out of range. |
Returns the constant that indicates the visibility of the index-th member.
For com.rti.dds.typecode.TCKind.TK_STRUCT, this method always returns com.rti.dds.typecode.Visibility.PUBLIC_MEMBER.
index | <<in>> Member index in the interval [0,(member count-1)]. |
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
com.rti.dds.infrastructure.ExceptionCode_t.Bounds | - if the index parameter/s are out of range. |
Returns the discriminator type code.
The method discriminator_type can be invoked only on union com.rti.dds.typecode.TypeCode objects.
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
int default_index | ( | ) | throws BadKind |
Returns the index of the default member, or -1 if there is no default member.
The method default_index can be invoked only on union com.rti.dds.typecode.TypeCode objects.
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
int find_member_by_id | ( | int | id | ) | throws BadKind |
Get the index of the member of the given ID.
This method is applicable to com.rti.dds.typecode.TypeCode objects representing structs (com.rti.dds.typecode.TCKind.TK_STRUCT and union (com.rti.dds.typecode.TCKind.TK_UNION) types.
id | <<in>> The member ID. |
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | if the method is invoked on an inappropriate kind of TypeCode object. |
int find_member_by_name | ( | String | name | ) | throws BadKind |
Get the index of the member of the given name.
void print_IDL | ( | int | indent | ) |
Prints a com.rti.dds.typecode.TypeCode in a pseudo-IDL notation.
indent | <<in>> Indent. |
void print_IDL | ( | int | indent, |
Writer | out | ||
) | throws IOException |
Prints a com.rti.dds.typecode.TypeCode in a pseudo-IDL notation.
void print_complete_IDL | ( | Writer | writer | ) | throws IOException |
Print all IDL constructs needed by the code generator to generate code for this type.
writer | The writer to which the IDL is to be written. |
IOException | If there were issues writing to the writer. |
int add_member | ( | String | name, |
int | id, | ||
TypeCode | tc, | ||
byte | member_flags | ||
) | throws BadKind,BadMemberName,BadMemberId |
Add a new member to this com.rti.dds.typecode.TypeCode.
This method is applicable to com.rti.dds.typecode.TypeCode objects representing structures (com.rti.dds.typecode.TCKind.TK_STRUCT), value types (com.rti.dds.typecode.TCKind.TK_VALUE), and unions (com.rti.dds.typecode.TCKind.TK_UNION). To add a constant to an enumeration, see com.rti.dds.typecode.TypeCode.add_member_to_enum.
Calling this method clones the type code passed as the tc
parameter if the type code is not a builtin one. To delete this cloned type code, call com.rti.dds.typecode.TypeCodeFactory.delete_tc.
The ability to modify a com.rti.dds.typecode.TypeCode – such as by adding a member – is important if you are using the Dynamic Data APIs.
Here's a simple code example that adds two fields to a data type, one an integer and another a sequence of integers.
name | <<in>> The name of the new member. |
id | <<in>> Member ID or case value.
|
tc | <<in>> The type of the new member. You can get or create this com.rti.dds.typecode.TypeCode with the com.rti.dds.typecode.TypeCodeFactory. |
member_flags | <<in>> Indicates whether the member is part of the key and whether it is required. |
synchronized int add_member | ( | String | name, |
int | id, | ||
TypeCode | tc, | ||
byte | member_flags, | ||
short | visibility, | ||
boolean | is_pointer, | ||
short | bits | ||
) | throws BadKind,BadMemberName,BadMemberId,BAD_PARAM,IllegalStateException |
Add a new member to this com.rti.dds.typecode.TypeCode.
This method is applicable to com.rti.dds.typecode.TypeCode objects representing structures (com.rti.dds.typecode.TCKind.TK_STRUCT), value types (com.rti.dds.typecode.TCKind.TK_VALUE), and unions (com.rti.dds.typecode.TCKind.TK_UNION). To add a constant to an enumeration, see com.rti.dds.typecode.TypeCode.add_member_to_enum.
Calling this method clones the type code passed in as the tc
parameter if the type code is not a builtin one. To delete this cloned type code, call com.rti.dds.typecode.TypeCodeFactory.delete_tc.
The ability to modify a com.rti.dds.typecode.TypeCode – such as by adding a member – is important if you are using the Dynamic Data APIs.
name | <<in>> The name of the new member. |
id | <<in>> Member ID or case value.
|
tc | <<in>> The type of the new member. You can get or create this com.rti.dds.typecode.TypeCode with the com.rti.dds.typecode.TypeCodeFactory. |
member_flags | <<in>> Indicates whether the member is part of the key and whether it is required. |
visibility | <<in>> Whether the new member is public or private. Non-public members are only relevant for types of kind com.rti.dds.typecode.TCKind.TK_VALUE. Possible values include:
|
is_pointer | <<in>> Whether the data member, in its deserialized form, should be stored by pointer as opposed to by value. |
bits | <<in>> The number of bits, if this new member is a bit field, or com.rti.dds.typecode.TypeCode.NOT_BITFIELD. |
synchronized int add_member_to_enum | ( | String | name, |
int | ordinal | ||
) | throws BadKind,BadMemberName |
Add a new enumerated constant to this enum com.rti.dds.typecode.TypeCode.
This method is applicable to com.rti.dds.typecode.TypeCode objects representing enumerations (com.rti.dds.typecode.TCKind.TK_ENUM). To add a field to a structured type, see com.rti.dds.typecode.TypeCode.add_member_to_enum.
Modifying a com.rti.dds.typecode.TypeCode – such as by adding a member – is important if you are using the Dynamic Data APIs.
name | <<in>> The name of the new member. This string must be unique within this type and must not be null. |
ordinal | <<in>> The relative order of the new member in this enum or a custom integer value. The value must be unique within the type. |
synchronized int add_member_to_union | ( | String | name, |
int | id, | ||
int | labels_in[], | ||
TypeCode | tc, | ||
boolean | is_pointer | ||
) | throws BadKind,BadMemberName, BadMemberId |
Add a new member to a union com.rti.dds.typecode.TypeCode.
This method is applicable to com.rti.dds.typecode.TypeCode objects representing unions (com.rti.dds.typecode.TCKind.TK_UNION).
Modifying a com.rti.dds.typecode.TypeCode – such as by adding a member – is important if you are using the Dynamic Data APIs.
name | <<in>> The name of the new member. |
id | <<in>> The member ID. For automatic assignment of the member ID specify com.rti.dds.typecode.TypeCode.MEMBER_ID_INVALID. |
labels_in | <<in>> A sequence of labels or case values associated with the member. |
tc | <<in>> The type of the new member. You can get or create this com.rti.dds.typecode.TypeCode with the com.rti.dds.typecode.TypeCodeFactory. |
is_pointer | <<in>> Whether the data member, in its deserialized form, should be stored by pointer as opposed to by value. |
com.rti.dds.infrastructure.ExceptionCode_t.BadKind | com.rti.dds.infrastructure.ExceptionCode_t.BadMemberName com.rti.dds.infrastructure.ExceptionCode_t.BadMemberId |
String signature | ( | ) | throws RETCODE_ERROR |
long get_type_object_serialized_size | ( | ) |
Gets the serialized size of the TypeObject created from this com.rti.dds.typecode.TypeCode.
The default buffer size used for storing a TypeObject is 3072 bytes. For a large TypeObject, this API can be used to determine the size that needs to be set in com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.type_object_max_serialized_length
|
static |
Basic null type.
|
static |
Basic 16-bit signed integer type.
|
static |
Basic 32-bit signed integer type.
|
static |
Basic unsigned 16-bit integer type.
|
static |
Basic unsigned 32-bit integer type.
|
static |
Basic 32-bit floating point type.
|
static |
Basic 64-bit floating point type.
|
static |
Basic Boolean type.
|
static |
Basic single-byte character type.
|
static |
Basic octet/byte type.
|
static |
Basic 64-bit integer type.
|
static |
Basic unsigned 64-bit integer type.
|
static |
Basic 128-bit floating point type.
|
static |
Basic four-byte character type.
|
static |
A sentinel indicating an invalid com.rti.dds.typecode.TypeCode member ID.
|
static |
Maximum value for member id. ID.
This value was introduced with the Extensible Types specification
|
static |
A sentinel indicating an invalid com.rti.dds.typecode.TypeCode member index.
|
static |
A flag indicating that a type member is optional and not part of the key.
If a type is used with the Dynamic Data facility, a com.rti.dds.dynamicdata.DynamicData sample of the type will only contain a value for a com.rti.dds.typecode.TypeCode.NONKEY_MEMBER field if one has been explicitly set (see, for example, com.rti.dds.dynamicdata.DynamicData.DynamicData.set_int). The middleware will not assume any default value.
|
static |
A flag indicating that a type member is part of the key for that type, and therefore required.
If a type is used with the Dynamic Data facility, all com.rti.dds.dynamicdata.DynamicData samples of the type will contain a value for all com.rti.dds.typecode.TypeCode.KEY_MEMBER fields. If you do not set a value of the member explicitly (see, for example, com.rti.dds.dynamicdata.DynamicData.DynamicData.set_int), the middleware will assume a default "zero" value: numeric values will be set to zero; strings and sequences will be of zero length.
|
static |
A flag indicating that a type member is not part of the key but is nevertheless required.
This is the most common kind of member.
If a type is used with the Dynamic Data facility, all com.rti.dds.dynamicdata.DynamicData samples of the type will contain a value for all com.rti.dds.typecode.TypeCode.NONKEY_REQUIRED_MEMBER fields. If you do not set a value of the member explicitly (see, for example, com.rti.dds.dynamicdata.DynamicData.DynamicData.set_int), the middleware will assume a default "zero" value: numeric values will be set to zero; strings and sequences will be of zero length.
|
static |
Indicates that a member of a type is not a bitfield.