ValueMember Class Reference

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.
TypeCode	type
	The type of the value member.
boolean	is_pointer
	Indicates whether the value member is a pointer or not.
short	bits
	Number of bits of a bitfield member.
boolean	is_key
	Indicates if the value member is a key member or not.
short	access
	The type of access (public, private) for the value member.
int	id
	The member ID.
boolean	is_optional
	Indicates if the value member is optional or required.

Detailed Description

A description of a member of a value type.

See Also

com.rti.dds.typecode.TypeCodeFactory.create_value_tc

Constructor & Destructor Documentation

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

Constructs a ValueMember object initialized with the given values.

Member Data Documentation

String name

The name of the value member.

Cannot be null.

TypeCode type

The type of the value member.

Cannot be null.

boolean is_pointer

Indicates whether the value 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 value member is a key member or not.

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.

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 value member is optional or required.