Add Scalar

Convenience Methods

Declaration

void add(
    java.lang.String fieldName,
    scalar_type data)
  throws TibrvException
void add(
    java.lang.String fieldName,
    scalar_type data,
    int fieldId)
  throws TibrvException
void addUbits(
    java.lang.String fieldName,
    scalar_type data)
  throws TibrvException
void addUbits(
    java.lang.String fieldName,
    scalar_type data,
    int fieldId)
  throws TibrvException

Purpose

Add a field containing a scalar value.

Method Forms

The convenience methods named add() determine the field type from the numeric type of the data.

The convenience methods named addUnn() add unsigned integer fields, discarding the sign bit of a Java integer data value.

Method Name

Java Data Type

Field Type

Type Description

add

boolean

TibrvMsg.BOOL

boolean

add

float

TibrvMsg.F32

32-bit floating point

add

double

TibrvMsg.F64

64-bit floating point

add

byte

TibrvMsg.I8

8-bit integer

add

short

TibrvMsg.I16

16-bit integer

add

int

TibrvMsg.I32

32-bit integer

add

long

TibrvMsg.I64

64-bit integer

addU8

byte

TibrvMsg.U8

8-bit unsigned integer

addU16

short

TibrvMsg.U16

16-bit unsigned integer

addU32

int

TibrvMsg.U32

32-bit unsigned integer

addU64

long

TibrvMsg.U64

64-bit unsigned integer

Parameter

Description

fieldName

Add a field with this name.

null is a legal name. However, if fieldId is non-zero, then fieldName must be non-null.

data

Add a field with this data value.

null is illegal.

fieldId

Add a field with this identifier. All field identifiers must be unique within each message.

When absent, add a field without an identifier.

Zero is a special value, indicating no identifier. It is illegal to add a field that has both a null field name, and a non-zero field identifier.