RTI Connext Java API  Version 6.0.0
 All Classes Namespaces Functions Variables Groups Pages
StructMember Class Reference

A description of a member of a struct. More...

Inherits Serializable.

Public Member Functions

 StructMember (String name, boolean is_pointer, short bits, boolean is_key, TypeCode type)
 

Public Attributes

String name
 The name of the struct member.
 
TypeCode type
 The type of the struct member.
 
boolean is_pointer
 Indicates whether the struct member is a pointer or not.
 
short bits
 Number of bits of a bitfield member.
 
boolean is_key
 Indicates if the struct member is a key member or not.
 
int id
 The member ID.
 
boolean is_optional
 Indicates if the struct member is optional or required.
 

Detailed Description

A description of a member of a struct.

See Also
com.rti.dds.typecode.TypeCodeFactory.create_struct_tc

Constructor & Destructor Documentation

StructMember ( String  name,
boolean  is_pointer,
short  bits,
boolean  is_key,
TypeCode  type 
)

Constructs a StructMember object initialized with the given values.

Member Data Documentation

String name

The name of the struct member.

Cannot be null.

TypeCode type

The type of the struct member.

Cannot be null.

boolean is_pointer

Indicates whether the struct member is a pointer or not.

short bits

Number of bits of a bitfield member.

If the struct member is a bitfield, this field contains the number of bits of the bitfield. Otherwise, bits should contain com.rti.dds.typecode.TypeCode.NOT_BITFIELD.

boolean is_key

Indicates if the struct member is a key member or not.

int id

The member ID.

Use com.rti.dds.typecode.TypeCode.MEMBER_ID_INVALID to have the member ID automatically assigned.

boolean is_optional

Indicates if the struct member is optional or required.


RTI Connext Java API Version 6.0.0 Copyright © Sun Mar 3 2019 Real-Time Innovations, Inc