com::wombat::mama::MamaFieldDescriptor

Public Functions

	Name
	MamaFieldDescriptor(int fid, short type, String name, Object data)
int	getFid()
short	getType()
String	getName()
String	toString()
void	setClosure(Object closure)
Object	getClosure()
void	setTrackModState(boolean on)
boolean	getTrackModState()
String	getTypeName(short type)

Public Attributes

	Name
final short	MSG
final short	DATETIME
final short	OPAQUE
final short	STRING
final short	BOOL
final short	CHAR
final short	I8
final short	U8
final short	I16
final short	U16
final short	I32
final short	U32
final short	I64
final short	U64
final short	F32
final short	F64
final short	TIME
final short	PRICE
final short	I8ARRAY
final short	U8ARRAY
final short	I16ARRAY
final short	U16ARRAY
final short	I32ARRAY
final short	U32ARRAY
final short	I64ARRAY
final short	U64ARRAY
final short	F32ARRAY
final short	F64ARRAY
final short	VECTOR_STRING
final short	VECTOR_MSG
final short	VECTOR_TIME
final short	VECTOR_PRICE
final short	QUANTITY
final short	VECTOR
final short	COLLECTION
final short	UNKNOWN

Detailed Description

class com::wombat::mama::MamaFieldDescriptor;

See:

The [MamaFieldDescriptor](classcom_1_1wombat_1_1mama_1_1MamaFieldDescriptor.html) class represents a field in a [MamaMsg](classcom_1_1wombat_1_1mama_1_1MamaMsg.html)

Public Functions Documentation

function MamaFieldDescriptor

inline MamaFieldDescriptor(
    int fid,
    short type,
    String name,
    Object data
)

Parameters:

fid The field identifier.
type The type.
name The field name.

Create a [MamaFieldDescriptor](classcom_1_1wombat_1_1mama_1_1MamaFieldDescriptor.html)

function getFid

inline int getFid()

Return: The fid.

Return the field identifier.

function getType

inline short getType()

Return: The type.

Return the data type.

function getName

inline String getName()

Return: The name.

Return the human readable name of the field.

function toString

inline String toString()

Return: A human readable string for the field.

Returns a string suitable for output to a terminal containing the type, id, and name.

function setClosure

inline void setClosure(
    Object closure
)

Parameters:

closure The data to associate with the descriptor.

Set user specified data to associate with the field descriptor.

function getClosure

inline Object getClosure()

Return: The user specified data associated with the field descriptor.

Return the user specified data associated with the field descriptor. The closure data has a default value of null

function setTrackModState

inline void setTrackModState(
    boolean on
)

function getTrackModState

inline boolean getTrackModState()

function getTypeName

static inline String getTypeName(
    short type
)

Public Attributes Documentation

variable MSG

static final short MSG =   1;

variable DATETIME

static final short DATETIME =   3;

variable OPAQUE

static final short OPAQUE =   7;

variable STRING

static final short STRING =   8;

variable BOOL

static final short BOOL =   9;

variable CHAR

static final short CHAR =   10;

variable I8

static final short I8 =   14;

variable U8

static final short U8 =   15;

variable I16

static final short I16 =   16;

variable U16

static final short U16 =   17;

variable I32

static final short I32 =   18;

variable U32

static final short U32 =   19;

variable I64

static final short I64 =   20;

variable U64

static final short U64 =   21;

variable F32

static final short F32 =   24;

variable F64

static final short F64 =   25;

variable TIME

static final short TIME =   26;

variable PRICE

static final short PRICE =   27;

variable I8ARRAY

static final short I8ARRAY =   34;

variable U8ARRAY

static final short U8ARRAY =   35;

variable I16ARRAY

static final short I16ARRAY =   36;

variable U16ARRAY

static final short U16ARRAY =   37;

variable I32ARRAY

static final short I32ARRAY =   38;

variable U32ARRAY

static final short U32ARRAY =   39;

variable I64ARRAY

static final short I64ARRAY =   40;

variable U64ARRAY

static final short U64ARRAY =   41;

variable F32ARRAY

static final short F32ARRAY =   44;

variable F64ARRAY

static final short F64ARRAY =   45;

variable VECTOR_STRING

static final short VECTOR_STRING = 46;

variable VECTOR_MSG

static final short VECTOR_MSG = 47;

variable VECTOR_TIME

static final short VECTOR_TIME = 48;

variable VECTOR_PRICE

static final short VECTOR_PRICE = 49;

variable QUANTITY

static final short QUANTITY = 50;

variable VECTOR

static final short VECTOR = 98;

variable COLLECTION

static final short COLLECTION = 99;

variable UNKNOWN

static final short UNKNOWN = 100;

Updated on 2023-03-31 at 15:29:43 +0100