RTI Connext C API  Version 5.1.0
DDS_ValueMember Struct Reference

A description of a member of a value type. More...

Data Fields

char * name
 The name of the value member.
 
const DDS_TypeCodetype
 The type of the value member.
 
DDS_Boolean is_pointer
 Indicates whether the value member is a pointer or not.
 
DDS_Short bits
 Number of bits of a bitfield member.
 
DDS_Boolean is_key
 Indicates if the value member is a key member or not.
 
DDS_Visibility access
 The type of access (public, private) for the value member.
 
DDS_Long id
 The member ID.
 
DDS_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
DDS_ValueMemberSeq
DDS_TypeCodeFactory_create_value_tc

Field Documentation

char* DDS_ValueMember::name

The name of the value member.

Cannot be NULL.

const DDS_TypeCode* DDS_ValueMember::type

The type of the value member.

Cannot be NULL.

DDS_Boolean DDS_ValueMember::is_pointer

Indicates whether the value member is a pointer or not.

DDS_Short DDS_ValueMember::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 DDS_TYPECODE_NOT_BITFIELD.

DDS_Boolean DDS_ValueMember::is_key

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

DDS_Visibility DDS_ValueMember::access

The type of access (public, private) for the value member.

It can take the values: DDS_PRIVATE_MEMBER or DDS_PUBLIC_MEMBER.

DDS_Long DDS_ValueMember::id

The member ID.

Use DDS_TYPECODE_MEMBER_ID_INVALID to have the member ID automatically assigned.

DDS_Boolean DDS_ValueMember::is_optional

Indicates if the value member is optional or required.


RTI Connext C API Version 5.1.0 Copyright © Mon Feb 3 2014 Real-Time Innovations, Inc