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. More...
TypeCode	type
	The type of the struct member. More...
boolean	is_pointer
	Indicates whether the struct member is a pointer or not. More...
short	bits
	Number of bits of a bitfield member. More...
boolean	is_key
	Indicates if the struct member is a key member or not. More...
int	id
	The member ID. More...
boolean	is_optional
	Indicates if the struct member is optional or required. More...

Detailed Description

A description of a member of a struct.

See also

com.rti.dds.typecode.TypeCodeFactory.create_struct_tc

Constructor & Destructor Documentation

StructMember()

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

Constructs a StructMember object initialized with the given values.

References StructMember.bits, StructMember.id, StructMember.is_key, StructMember.is_optional, StructMember.is_pointer, TypeCode.MEMBER_ID_INVALID, StructMember.name, and StructMember.type.

Member Data Documentation

name

String name

The name of the struct member.

Cannot be null.

Referenced by TypeCode.member_name(), and StructMember.StructMember().

type

TypeCode type

The type of the struct member.

Cannot be null.

Referenced by TypeCode.cdr_serialized_sample_key_max_size(), TypeCode.member_type(), and StructMember.StructMember().

is_pointer

boolean is_pointer

Indicates whether the struct member is a pointer or not.

Referenced by TypeCode.is_member_pointer(), and StructMember.StructMember().

bits

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 StructMember.StructMember().

is_key

boolean is_key

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

Referenced by TypeCode.is_member_key(), and StructMember.StructMember().

id

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 StructMember.StructMember().

is_optional

boolean is_optional

Indicates if the struct member is optional or required.

Referenced by TypeCode.is_member_required(), and StructMember.StructMember().