TCKind Class Reference

Enumeration type for com.rti.dds.typecode.TypeCode kinds. More...

Inheritance diagram for TCKind:

Static Public Attributes
static final TCKind	TK_NULL
	Indicates that a type code does not describe anything.
static final TCKind	TK_SHORT
	short type.
static final TCKind	TK_LONG
	long type.
static final TCKind	TK_USHORT
	unsigned short type.
static final TCKind	TK_ULONG
	unsigned long type.
static final TCKind	TK_FLOAT
	float type.
static final TCKind	TK_DOUBLE
	double type.
static final TCKind	TK_BOOLEAN
	boolean type.
static final TCKind	TK_CHAR
	char type.
static final TCKind	TK_OCTET
	octet type.
static final TCKind	TK_STRUCT
	struct type.
static final TCKind	TK_UNION
	union type.
static final TCKind	TK_ENUM
	enumerated type.
static final TCKind	TK_STRING
	string type.
static final TCKind	TK_SEQUENCE
	sequence type.
static final TCKind	TK_ARRAY
	array type.
static final TCKind	TK_ALIAS
	alias (typedef) type.
static final TCKind	TK_LONGLONG
	long long type.
static final TCKind	TK_ULONGLONG
	unsigned long long type.
static final TCKind	TK_LONGDOUBLE
	long double type.
static final TCKind	TK_WCHAR
	wide char type.
static final TCKind	TK_WSTRING
	wide string type.
static final TCKind	TK_VALUE
	value type.
static final TCKind	TK_SPARSE
	A sparse value type.

Additional Inherited Members
Public Member Functions inherited from Enum
final int	ordinal ()
	The integral value of this enumerated constant.
Object	copy_from (Object src)
final String	name ()
	The name of this enum constant, as declared in the enum declaration.
final String	toString ()
	The string value of this enum constant.
Protected Member Functions inherited from Enum
	Enum (String name, int ordinal)
	The constructor.

Detailed Description

Enumeration type for com.rti.dds.typecode.TypeCode kinds.

Type code kinds are modeled as values of this type.

Member Data Documentation

final TCKind TK_NULL

static

Indicates that a type code does not describe anything.

final TCKind TK_SHORT

static

short type.

final TCKind TK_LONG

static

long type.

final TCKind TK_USHORT

static

unsigned short type.

final TCKind TK_ULONG

static

unsigned long type.

final TCKind TK_FLOAT

static

float type.

final TCKind TK_DOUBLE

static

double type.

final TCKind TK_BOOLEAN

static

boolean type.

final TCKind TK_CHAR

static

char type.

final TCKind TK_OCTET

static

octet type.

final TCKind TK_STRUCT

static

struct type.

final TCKind TK_UNION

static

union type.

final TCKind TK_ENUM

static

enumerated type.

final TCKind TK_STRING

static

string type.

final TCKind TK_SEQUENCE

static

sequence type.

final TCKind TK_ARRAY

static

array type.

final TCKind TK_ALIAS

static

alias (typedef) type.

final TCKind TK_LONGLONG

static

long long type.

final TCKind TK_ULONGLONG

static

unsigned long long type.

final TCKind TK_LONGDOUBLE

static

long double type.

final TCKind TK_WCHAR

static

wide char type.

final TCKind TK_WSTRING

static

wide string type.

final TCKind TK_VALUE

static

value type.

final TCKind TK_SPARSE

static

A sparse value type.

A sparse value type is one in which all of the fields are not necessarily sent on the network as a part of every sample.

Fields of a sparse value type fall into one of three categories:

• Key fields (see com.rti.dds.typecode.TypeCode.KEY_MEMBER)
• Non-key, but required members (see com.rti.dds.typecode.TypeCode.NONKEY_REQUIRED_MEMBER)
• Non-key, optional members (see com.rti.dds.typecode.TypeCode.NONKEY_MEMBER)

Fields of the first two kinds must appear in every sample. These are also the only kinds of fields on which you can perform content filtering (see com.rti.dds.topic.ContentFilteredTopic), because filter evaluation on a non-existent field is not well defined.