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.
|
mama_fid_t | getFid (void) const |
| Return the field identifier.
|
mamaFieldType | getType (void) const |
| Return the data type.
|
const char * | getName (void) const |
| Return the human readable name of the field.
|
const char * | getTypeName (void) const |
| Return a human readable string for mamaMsgType.
|
void | setClosure (void *closure) |
| Associate user supplied data with the field descriptor.
|
void * | getClosure () const |
| Return the user supplied data associated with the field descriptor.
|
void | setTrackModState (bool on) |
| Track the modification state of the field.
|
bool | getTrackModState () const |
| Track the modification state of the field?
|
void | setPubName (const char *pubName) |
| Set the publish name for this field.
|
const char * | getPubName () const |
| Get the publish name for this field.
|
Public Attributes |
FieldDescriptorImpl * | mPimpl |
Detailed Description
Constructor & Destructor Documentation
virtual Wombat::MamaFieldDescriptor::~MamaFieldDescriptor |
( |
| ) |
|
|
virtual |
Wombat::MamaFieldDescriptor::MamaFieldDescriptor |
( |
mamaFieldDescriptor |
field | ) |
|
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
mama_fid_t Wombat::MamaFieldDescriptor::getFid |
( |
void |
| ) |
const |
Return the field identifier.
- Returns
- The fid.
mamaFieldType Wombat::MamaFieldDescriptor::getType |
( |
void |
| ) |
const |
Return the data type.
- Returns
- The type.
const char* Wombat::MamaFieldDescriptor::getName |
( |
void |
| ) |
const |
Return the human readable name of the field.
- Returns
- The name.
const char* Wombat::MamaFieldDescriptor::getTypeName |
( |
void |
| ) |
const |
Return a human readable string for mamaMsgType.
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. |
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.
void Wombat::MamaFieldDescriptor::setTrackModState |
( |
bool |
on | ) |
|
Track the modification state of the field.
bool Wombat::MamaFieldDescriptor::getTrackModState |
( |
| ) |
const |
Track the modification state of the field?
void Wombat::MamaFieldDescriptor::setPubName |
( |
const char * |
pubName | ) |
|
Set the publish name for this field.
const char* Wombat::MamaFieldDescriptor::getPubName |
( |
| ) |
const |
Get the publish name for this field.
Member Data Documentation
FieldDescriptorImpl* Wombat::MamaFieldDescriptor::mPimpl |
The documentation for this class was generated from the following file: