Wombat::MamaSymbolMapFile

A file-based symbol mapper More…

Inherits from Wombat.MamaWrapper, IDisposable

Public Functions

	Name
	MamaSymbolMapFile() M:Wombat.MamaWrapper.::ctor
void	create() Create the object
void	load(string fileName) (Re)Load the map for the file-based symbol mapper.
void	addMap(string fromSymbol, string toSymbol) Add additional individual symbology mapping.
int	map(ref string result, string symbol, int maxLen) Perform a mapping from the file-based symbol mapper.
int	revMap(ref string result, string symbol, int maxLen) Perform a reverse mapping from the file-based symbol mapper.

Protected Functions

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

Additional inherited members

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

Detailed Description

class Wombat::MamaSymbolMapFile;

A file-based symbol mapper

Use MamaSymbolMapFile load() to open the file. If the file exists, its contents should be a two columns of data, with the columns separated by white space. A matching symbol of the left column is mapped to the symbol in the right column. When performing the mapping, if the symbol does not match anything in the file (or the file cannot be found), then the original symbol is used (i.e. no mapping)

Public Functions Documentation

function MamaSymbolMapFile

MamaSymbolMapFile()

M:Wombat.MamaWrapper.::ctor

function create

void create()

Create the object

function load

void load(
    string fileName
)

(Re)Load the map for the file-based symbol mapper.

function addMap

void addMap(
    string fromSymbol,
    string toSymbol
)

Add additional individual symbology mapping.

function map

int map(
    ref string result,
    string symbol,
    int maxLen
)

Perform a mapping from the file-based symbol mapper.

function revMap

int revMap(
    ref string result,
    string symbol,
    int maxLen
)

Perform a reverse mapping from the file-based symbol mapper.

Protected Functions Documentation

function DestroyNativePeer

virtual override MamaStatus.mamaStatus DestroyNativePeer()

Implements the destruction of the underlying peer object. MamaWrapper.DestroyNativePeer

Reimplements: Wombat::MamaWrapper::DestroyNativePeer

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