Wombat::MamaMsgField

More…

#include <MamaMsgField.h>

Public Functions

Detailed Description

class Wombat::MamaMsgField;

MamaMsg field representation.

Public Functions Documentation

function ~MamaMsgField

~MamaMsgField()

function MamaMsgField

MamaMsgField(
    void 
)

function MamaMsgField

MamaMsgField(
    mamaMsgField field
)

function MamaMsgField

MamaMsgField(
    const MamaMsgField & field
)

function operator=

MamaMsgField & operator=(
    const MamaMsgField & field
)

function clear

void clear()

Clear the field.

function set

void set(
    mamaMsgField field
)

Set this field to a different MAMA C API field.

function getDescriptor

const MamaFieldDescriptor * getDescriptor() const

function getFid

mama_fid_t getFid() const

Return: The fid.

Return the field identifier.

function getName

const char * getName() const

Return: The name.

Return the field name.

function getType

mamaFieldType getType() const

Return: The type.

Return the field type.

function getTypeName

const char * getTypeName() const

Return: The type name.

Return the field type name. The type name is a human readable representation of the type.

function getBool

mama_bool_t getBool() const

Return: The boolean value.

Get as a boolean field.

function getChar

char getChar() const

Return: The character value.

Get as a character field.

function getI8

mama_i8_t getI8() const

Return: The integer value.

Get as a I8 field.

function getU8

mama_u8_t getU8() const

Return: The integer value.

Get as a U8 field.

function getI16

mama_i16_t getI16() const

Return: The integer value.

Get as a I16 field.

function getU16

mama_u16_t getU16() const

Return: The integer value.

Get as a U16 field.

function getI32

mama_i32_t getI32() const

Return: The integer value.

Get as a I32 field.

function getU32

mama_u32_t getU32() const

Return: The integer value.

Get as a U32 field.

function getI64

mama_i64_t getI64() const

Return: The field value as a long.

Get as a I64 field.

function getU64

mama_u64_t getU64() const

Return: The field value as a long.

Get as a U64 field.

function getF32

mama_f32_t getF32() const

Return: The field value as a 32 bit floating point number.

Get as a f32 field.

function getF64

mama_f64_t getF64() const

Return: The field value as a 64 bit floating point number.

Get as a f64 field.

function getString

const char * getString() const

Return: the string value.

Get as a const char* field.

function getOpaque

const void * getOpaque(
    mama_size_t & size
) const

Return: The opaque value.

Get as a const void* field

function getDateTime

void getDateTime(
    MamaDateTime & result
) const

Parameters:

• result The date/time value.

Get as a MamaDateTime field

function getPrice

void getPrice(
    MamaPrice & result
) const

Parameters:

• result The price value.

Get as a MamaPrice field

function getMsg

void getMsg(
    MamaMsg & result
) const

Parameters:

• result The msg value.

Get as a MamaMsg field

function getVectorBool

void getVectorBool(
    const mama_bool_t *& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) the vector.
• resultLen (out) the size of the vector.

Get a vector of boolean.

function getVectorChar

void getVectorChar(
    const char *& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) the vector.
• resultLen (out) the size of the vector.

Get a vector of characters.

function getVectorI8

void getVectorI8(
    const mama_i8_t *& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) the vector.
• resultLen (out) the size of the vector.

Get a vector of signed 8-bit integers.

function getVectorU8

void getVectorU8(
    const mama_u8_t *& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) the vector.
• resultLen (out) the size of the vector.

Get a vector of unsigned 8-bit integers.

function getVectorI16

void getVectorI16(
    const mama_i16_t *& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) the vector.
• resultLen (out) the size of the vector.

Get a vector of signed 16-bit integers.

function getVectorU16

void getVectorU16(
    const mama_u16_t *& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) the vector.
• resultLen (out) the size of the vector.

Get a vector of unsigned 16-bit integers.

function getVectorI32

void getVectorI32(
    const mama_i32_t *& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) the vector.
• resultLen (out) the size of the vector.

Get a vector of signed 32-bit integers.

function getVectorU32

void getVectorU32(
    const mama_u32_t *& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) the vector.
• resultLen (out) the size of the vector.

Get a vector of unsigned 32-bit integers.

function getVectorI64

void getVectorI64(
    const mama_i64_t *& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) the vector.
• resultLen (out) the size of the vector.

Get a vector of signed 64-bit integers.

function getVectorU64

void getVectorU64(
    const mama_u64_t *& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) the vector.
• resultLen (out) the size of the vector.

Get a vector of unsigned 64-bit integers.

function getVectorF32

void getVectorF32(
    const mama_f32_t *& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) the vector.
• resultLen (out) the size of the vector.

Get a vector of 32-bit floats.

function getVectorF64

void getVectorF64(
    const mama_f64_t *& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) the vector.
• resultLen (out) the size of the vector.

Get a vector of 64-bit floats.

function getVectorString

void getVectorString(
    const char **& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) the vector.
• resultLen (out) the size of the vector.

Get a vector of strings.

function getVectorMsg

void getVectorMsg(
    const MamaMsg **& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) vector.
• resultLen (out) the size of the vector.

Get a vector of submessages field. Note: The vector is only valid for the lifetime of the field object which, when iterating over fields in a message is only as long as the individual callback itself. Use getVectorMsgDetached if it is necessary to keep the vector of messages longer than the lifetime of the field.

function getVectorMsgDetached

void getVectorMsgDetached(
    const MamaMsg **& result,
    mama_size_t & resultLen
) const

Parameters:

• result (out) vector.
• resultLen (out) the size of the vector.

Get a vector of submessages field. Deallocating the memory allocated for array and it members will become the responsibility of the caller.

function getAsString

void getAsString(
    char * result,
    mama_size_t maxResultLen
) const

Parameters:

• result Buffer to put result.
• maxResultLen Maximum size of buffer to put result.

Return a string representation the field with the given fid.

function updateBool

void updateBool(
    mama_bool_t value
)

Parameters:

• value The new value for the field.

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new bool value.

function updateChar

void updateChar(
    char value
)

Parameters:

• value The new value for the field.

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new char value.

function updateI8

void updateI8(
    mama_i8_t value
)

Parameters:

• value The new value for the field.

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new i8 value.

function updateU8

void updateU8(
    mama_u8_t value
)

Parameters:

• value The new value for the field.

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new u8 value.

function updateI16

void updateI16(
    mama_i16_t value
)

Parameters:

• value The new value for the field.

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new i16 value.

function updateU16

void updateU16(
    mama_u16_t value
)

Parameters:

• value The new value for the field.

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new u16 value.

function updateI32

void updateI32(
    mama_i32_t value
)

Parameters:

• value The new value for the field.

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new i32 value.

function updateU32

void updateU32(
    mama_u32_t value
)

Parameters:

• value The new value for the field.

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new u32 value.

function updateI64

void updateI64(
    mama_i64_t value
)

Parameters:

• value The new value for the field.

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new i64 value.

function updateU64

void updateU64(
    mama_u64_t value
)

Parameters:

• value The new value for the field.

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new u64 value.

function updateF32

void updateF32(
    mama_f32_t value
)

Parameters:

• value The new value for the field.

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new f32 value.

function updateF64

void updateF64(
    mama_f64_t value
)

Parameters:

• value The new value for the field.

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new f64 value.

function updateDateTime

void updateDateTime(
    const mamaDateTime value
)

Parameters:

• value The new value for the field (mamaDateTime object).

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new date/time value.

function updateDateTime

void updateDateTime(
    const MamaDateTime value
)

Parameters:

• value The new value for the field (MamaDateTime object).

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new date/time value.

function updatePrice

void updatePrice(
    const mamaPrice value
)

Parameters:

• value The new value for the field (mamaPrice object).

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new price value.

function updatePrice

void updatePrice(
    const MamaPrice value
)

Parameters:

• value The new value for the field (MamaPrice object).

Exceptions:

• MamaStatus exception with the following possible status values. MAMA_STATUS_WRONG_FIELD_TYPE The existing field type does not match the type of the update method called. MAMA_STATUS_NULL_ARG The field passed to the C function is NULL. MAMA_STATUS_INVALID_ARG The underlying bridge field is NULL.

Update the specified field with a new price value.

function operator==

bool operator==(
    const MamaMsgField & 
) const

function operator!=

bool operator!=(
    const MamaMsgField & 
) const

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