RTI Connext Java API
Version 6.1.1
|
A description of a member of a value type. More...
Inherits Serializable.
Public Member Functions | |
ValueMember (String name, boolean is_pointer, short bits, boolean is_key, short access, TypeCode type) | |
Public Attributes | |
String | name |
The name of the value member. More... | |
TypeCode | type |
The type of the value member. More... | |
boolean | is_pointer |
Indicates whether the value member is a pointer or not. More... | |
short | bits |
Number of bits of a bitfield member. More... | |
boolean | is_key |
Indicates if the value member is a key member or not. More... | |
short | access |
The type of access (public, private) for the value member. More... | |
int | id |
The member ID. More... | |
boolean | is_optional |
Indicates if the value member is optional or required. More... | |
A description of a member of a value type.
ValueMember | ( | String | name, |
boolean | is_pointer, | ||
short | bits, | ||
boolean | is_key, | ||
short | access, | ||
TypeCode | type | ||
) |
Constructs a ValueMember object initialized with the given values.
References ValueMember.access, ValueMember.bits, ValueMember.id, ValueMember.is_key, ValueMember.is_optional, ValueMember.is_pointer, TypeCode.MEMBER_ID_INVALID, ValueMember.name, and ValueMember.type.
String name |
The name of the value member.
Cannot be null.
Referenced by TypeCode.member_name(), and ValueMember.ValueMember().
TypeCode type |
The type of the value member.
Cannot be null.
Referenced by TypeCode.cdr_serialized_sample_key_max_size(), TypeCode.member_type(), and ValueMember.ValueMember().
boolean is_pointer |
Indicates whether the value member is a pointer or not.
Referenced by TypeCode.is_member_pointer(), and ValueMember.ValueMember().
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.
Referenced by TypeCode.member_bitfield_bits(), and ValueMember.ValueMember().
boolean is_key |
Indicates if the value member is a key member or not.
Referenced by TypeCode.is_member_key(), and ValueMember.ValueMember().
short access |
The type of access (public, private) for the value member.
It can take the values: com.rti.dds.typecode.Visibility.PRIVATE_MEMBER or com.rti.dds.typecode.Visibility.PUBLIC_MEMBER.
Referenced by TypeCode.member_visibility(), and ValueMember.ValueMember().
int id |
The member ID.
Use com.rti.dds.typecode.TypeCode.MEMBER_ID_INVALID to have the member ID automatically assigned.
Referenced by TypeCode.add_member(), TypeCode.member_id(), and ValueMember.ValueMember().
boolean is_optional |
Indicates if the value member is optional or required.
Referenced by TypeCode.is_member_required(), and ValueMember.ValueMember().