Wombat::MamaFieldDescriptor Class Reference

The MamaFieldDescriptor class describes a field within a MamaDictionary More...

#include <MamaFieldDescriptor.h>

Public Member Functions
virtual	~MamaFieldDescriptor ()
	MamaFieldDescriptor (mamaFieldDescriptor field)
	MamaFieldDescriptor (mama_fid_t fid, mamaFieldType type, const char *name)
	Create a new field descriptor based on supplied info. More...
mama_fid_t	getFid (void) const
	Return the field identifier. More...
mamaFieldType	getType (void) const
	Return the data type. More...
const char *	getName (void) const
	Return the human readable name of the field. More...
const char *	getTypeName (void) const
	Return a human readable string for mamaMsgType. More...
void	setClosure (void *closure)
	Associate user supplied data with the field descriptor. More...
void *	getClosure () const
	Return the user supplied data associated with the field descriptor. More...
void	setTrackModState (bool on)
	Track the modification state of the field. More...
bool	getTrackModState () const
	Track the modification state of the field? More...
void	setPubName (const char *pubName)
	Set the publish name for this field. More...
const char *	getPubName () const
	Get the publish name for this field. More...

Public Attributes
FieldDescriptorImpl *	mPimpl

Detailed Description

The MamaFieldDescriptor class describes a field within a MamaDictionary

See also

MamaDictionary

MamaMsg

Constructor & Destructor Documentation

~MamaFieldDescriptor()

virtual Wombat::MamaFieldDescriptor::~MamaFieldDescriptor ( )

virtual

MamaFieldDescriptor() [1/2]

Wombat::MamaFieldDescriptor::MamaFieldDescriptor

(

mamaFieldDescriptor

field

)

MamaFieldDescriptor() [2/2]

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

Create a new field descriptor based on supplied info.

Parameters

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

Member Function Documentation

getFid()

mama_fid_t Wombat::MamaFieldDescriptor::getFid

(

void

)

const

Return the field identifier.

Returns

The fid.

getType()

mamaFieldType Wombat::MamaFieldDescriptor::getType

(

void

)

const

Return the data type.

Returns

The type.

getName()

const char* Wombat::MamaFieldDescriptor::getName

(

void

)

const

Return the human readable name of the field.

Returns

The name.

getTypeName()

const char* Wombat::MamaFieldDescriptor::getTypeName

(

void

)

const

Return a human readable string for mamaMsgType.

setClosure()

void Wombat::MamaFieldDescriptor::setClosure

(

void *

closure

)

Associate user supplied data with the field descriptor.

Parameters

closure

The user supplied data to associate with the field descriptor.

getClosure()

void* Wombat::MamaFieldDescriptor::getClosure

(

)

const

Return the user supplied data associated with the field descriptor.

Returns

The user supplied data associated with the field descriptor.

setTrackModState()

void Wombat::MamaFieldDescriptor::setTrackModState

(

bool

on

)

Track the modification state of the field.

getTrackModState()

bool Wombat::MamaFieldDescriptor::getTrackModState

(

)

const

Track the modification state of the field?

setPubName()

void Wombat::MamaFieldDescriptor::setPubName

(

const char *

pubName

)

Set the publish name for this field.

getPubName()

const char* Wombat::MamaFieldDescriptor::getPubName

(

)

const

Get the publish name for this field.

Member Data Documentation

mPimpl

FieldDescriptorImpl* Wombat::MamaFieldDescriptor::mPimpl

---

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

• MamaFieldDescriptor.h