Wombat::MamaFieldDescriptor

More…

#include <MamaFieldDescriptor.h>

Public Functions

Public Attributes

Detailed Description

class Wombat::MamaFieldDescriptor;

See:

• MamaDictionary
• MamaMsg

The [MamaFieldDescriptor](classWombat_1_1MamaFieldDescriptor.html) class describes a field within a [MamaDictionary](classWombat_1_1MamaDictionary.html)

Public Functions Documentation

function ~MamaFieldDescriptor

virtual ~MamaFieldDescriptor()

function MamaFieldDescriptor

MamaFieldDescriptor(
    mamaFieldDescriptor field
)

function MamaFieldDescriptor

MamaFieldDescriptor(
    mama_fid_t fid,
    mamaFieldType type,
    const char * name
)

Parameters:

• fid The field id.
• type The field type.
• name The field name.

Create a new field descriptor based on supplied info.

function getFid

mama_fid_t getFid(
    void 
) const

Return: The fid.

Return the field identifier.

function getType

mamaFieldType getType(
    void 
) const

Return: The type.

Return the data type.

function getName

const char * getName(
    void 
) const

Return: The name.

Return the human readable name of the field.

function getTypeName

const char * getTypeName(
    void 
) const

Return a human readable string for mamaMsgType.

function setClosure

void setClosure(
    void * closure
)

Parameters:

• closure The user supplied data to associate with the field descriptor.

Associate user supplied data with the field descriptor.

function getClosure

void * getClosure() const

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

Return the user supplied data associated with the field descriptor.

function setTrackModState

void setTrackModState(
    bool on
)

Track the modification state of the field.

function getTrackModState

bool getTrackModState() const

Track the modification state of the field?

function setPubName

void setPubName(
    const char * pubName
)

Set the publish name for this field

function getPubName

const char * getPubName() const

Get the publish name for this field

Public Attributes Documentation

variable mPimpl

FieldDescriptorImpl * mPimpl;

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