StreamTypeDescriptor Struct Reference

Describes the type of entries in a stream. More...

#include <SimuStorTypes.h>

Data Fields
char	name [MAX_STREAM_TYPE_NAME_LENGTH]
	Friendly name of the type.
StreamTypeId	id
	Unique id of the type.
StreamTypeFlags	flags
	Stream type flags. More...
uint32_t	reserved1
	Reserved. Set to 0.
uint32_t	entrySize
	Entry size. More...
uint32_t	reserved2
	Reserved. Set to 0.

Detailed Description

Each stream must have a type that describes the size and properties of the entries in a stream. The StreamTypeDescriptor encapsulates this information.

Deprecated:

Before 3.2: A set of bit fields was used to represent the stream properties. The fields have been replaced with the flags field to improve interoperability.

Since

3.0

Field Documentation

StreamTypeFlags StreamTypeDescriptor::flags

Remarks

Replaces set of bit fields in a binary compatible way.

Since

3.2

uint32_t StreamTypeDescriptor::entrySize

Size of a single entry in bytes. To make variable-sized entries use makeVariableEntrySize(). If the size itself is desired, do not read the entry size directly, instead use getEntrySize()

---

The documentation for this struct was generated from the following file:

• SimuStorTypes.h