Wombat::MamaFieldDescriptor

A class that describes a field in a MamaMsg

Inherits from Wombat.MamaWrapper, IDisposable

Public Functions

	Name
	MamaFieldDescriptor(int fid, mamaFieldType type, string name, bool trackModState)
	MamaFieldDescriptor(int fid, mamaFieldType type, string name)
void	destroy() Destroy a MamaFieldDescriptor
string	getName() Return the human readable name of the field.
int	getFid() Return the field identifier
mamaFieldType	getType() Return the data type
string	getTypeName() Return a human readable string for mamaMsgType

	Name
virtual override MamaStatus.mamaStatus	DestroyNativePeer() Implements the destruction of the underlying peer object

	Name
bool	trackModState Track the modification state
object	closure User-supplied data that is associated with the field descriptor
string?	pubName Publish name for the field

Public Functions inherited from Wombat.MamaWrapper

	Name
void	Dispose() Destroys the underlying peer object and unbinds the wrapper from it.
void	setNativeHandle(IntPtr nHandle) Sets the native handle of the native peer object. Should only be used by subclasses and in the same assembly.

Protected Functions inherited from Wombat.MamaWrapper

	Name
	MamaWrapper() Constructs a new wrapper object but doesn’t create it. If the object is not explicitly disposed it will remain registered for finalization and will attempt the destroy the native peer object when finalized.
	MamaWrapper(IntPtr nativeHandle) Constructs a managed wrapper from an existing native peer. The peer object will not be automatically finalized
virtual void	Dispose(bool disposing, bool destroyNativeHandle =true) The actual implementation of Dispose - called by both the Dispose method and the finalizer.
virtual void	OnDispose()

Protected Attributes inherited from Wombat.MamaWrapper

	Name
IntPtr	nativeHandle the handle to the native peer object

MamaFieldDescriptor(
    int fid,
    mamaFieldType type,
    string name,
    bool trackModState
)

MamaFieldDescriptor(
    int fid,
    mamaFieldType type,
    string name
)

void destroy()

string getName()

Return the human readable name of the field.

int getFid()

Return the field identifier

mamaFieldType getType()

Return the data type

string getTypeName()

Return a human readable string for mamaMsgType

virtual override MamaStatus.mamaStatus DestroyNativePeer()

Implements the destruction of the underlying peer object

Reimplements: Wombat::MamaWrapper::DestroyNativePeer

bool trackModState;

Track the modification state

object closure;

User-supplied data that is associated with the field descriptor

string? pubName;

Publish name for the field

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