XPRM Class

Methods for initialisation as well as model compilation and loading of compiled models into Mosel.

Inheritance Hierarchy

System.Object
   Mosel.XPRM

Namespace:   Mosel
Assembly:  xprmdn (in xprmdn.dll) Version: 6.6.0

Syntax

C#

public class XPRM : XPRMObject, IDisposable

The XPRM type exposes the following members.

Properties

	Name	Description
	IODrivers	Get a list of all IO drivers
	IsEnvironmentInitialized	Returns 'true' if there is a Mosel environment is currently initialized in this process. A Mosel environment will be initialized if there is any XPRM object that has not been disposed.
	Model	Returns a reference to this XPRM model - this is 'null' for XPRM objects
	Modules	Get an Collection to enumerate all loaded modules.
	Owner	Returns a reference to this XPRM object - included to implement the XPRMObject interface.
	WorkDir	Property representing the current default working directory for new Mosel models

Top

Methods

	Name	Description
	BeginLicensing	Begins the OEM licensing procedure. Subsequent calls to BeginLicensing() from the same process will block until this thread calls EndLicensing(), whether or not BeginLicensing() returns true.
	Bind	Bind an object to a name. This method is used to associate a name with an object; this name can then be used to locate the object from the 'dotnetstream' and 'dotnetraw' I/O drivers within a Mosel model. Binding an object also prevents it from being garbage collected until the name is unbound or another object is bound to this name, or until the XPRM object is disposed.
	Compile(String)	Compile a model source file.
	Compile(String, String)	Compile a model source file. This method compiles a given model source file into a binary model file (bim file) that is required as input to method LoadModel(string) for loading the model. The output file takes the same name as the source file with the extension .bim. Note that the empty string (i.e. "") is interpreted as the standard input for src.
	Compile(String, Stream, Stream)	Compile a model source file. This method compiles a given model source file into a binary model file (bim file) that is required as input to method LoadModel(string) for loading the model. The output file takes the same name as the source file with the extension .bim. Note that the empty string (i.e. "") is interpreted as the standard input for src.
	Compile(String, TextReader, Stream)	Compile a model source file. This method compiles a given model source file into a binary model file (bim file) that is required as input to method LoadModel(string) for loading the model. The output file takes the same name as the source file with the extension .bim. Note that the empty string (i.e. "") is interpreted as the standard input for src.
	Compile(String, String, Stream)	Compile a model source file. This method compiles a given model source file into a binary model file (bim file) that is required as input to method LoadModel(string) for loading the model. The output file takes the same name as the source file with the extension .bim. Note that the empty string (i.e. "") is interpreted as the standard input for src.
	Compile(String, String, String)	Compile a model source file. This method compiles a given model source file into a binary model file (bim file) that is required as input to method LoadModel(string) for loading the model. The output file takes the same name as the source file with the extension .bim. Note that the empty string (i.e. "") is interpreted as the standard input for src.
	Compile(String, Stream, Stream, String)	Compile a model source file. This method compiles a given model source file into a binary model file (bim file) that is required as input to method LoadModel(string) for loading the model. The output file takes the same name as the source file with the extension .bim. Note that the empty string (i.e. "") is interpreted as the standard input for src.
	Compile(String, TextReader, Stream, String)	Compile a model source file. This method compiles a given model source file into a binary model file (bim file) that is required as input to method LoadModel(string) for loading the model. The output file takes the same name as the source file with the extension .bim. Note that the empty string (i.e. "") is interpreted as the standard input for src.
	Compile(String, String, Stream, String)	Compile a model source file. This method compiles a given model source file into a binary model file (bim file) that is required as input to method LoadModel(string) for loading the model. The output file takes the same name as the source file with the extension .bim. Note that the empty string (i.e. "") is interpreted as the standard input for src.
	Compile(String, String, String, String)	Compile a model source file. This method compiles a given model source file into a binary model file (bim file) that is required as input to method LoadModel(string) for loading the model. The output file takes the same name as the source file with the extension .bim. Note that the empty string (i.e. "") is interpreted as the standard input for src.
	Compile(String, Stream, Stream, String, String, String, String)	Compile a model source file. This method compiles a given model source file into a binary model file (bim file) that is required as input to method LoadModel(string) for loading the model. The output file takes the same name as the source file with the extension .bim. Note that the empty string (i.e. "") is interpreted as the standard input for src.
	Compile(String, TextReader, Stream, String, String, String, String)	Compile a model source file. This method compiles a given model source file into a binary model file (bim file) that is required as input to method LoadModel(string) for loading the model. The output file takes the same name as the source file with the extension .bim. Note that the empty string (i.e. "") is interpreted as the standard input for src.
	Compile(String, String, Stream, String, String, String, String)	Compile a model source file. This method compiles a given model source file into a binary model file (bim file) that is required as input to method LoadModel(string) for loading the model. The output file takes the same name as the source file with the extension .bim. Note that the empty string (i.e. "") is interpreted as the standard input for src.
	Compile(String, String, String, String, String, String, String)	Compile a model source file. This method compiles a given model source file into a binary model file (bim file) that is required as input to method LoadModel(string) for loading the model. The output file takes the same name as the source file with the extension .bim. Note that the empty string (i.e. "") is interpreted as the standard input for src.
	CompileAndLoad(TextReader)	Compile a model source into a memory buffer from the given stream, then read it into an XPRMModel object
	CompileAndLoad(String)	Compile a model source file into a memory buffer, then read it into an XPRMModel object
	CompileAndLoad(String, TextReader)	Compile a model source from the given stream into a memory buffer, then read it into an XPRMModel object
	CompileAndLoad(String, String)	Compile a model source file into a memory buffer, then read it into an XPRMModel object
	CreateIOCallback(XPRMIOCallbackInput)	This returns the name of an IO driver callback stream. The supplied delegate will be called whenever Mosel needs to read data from the stream; you should return the data to Mosel in a byte array, up to the limit supplied by Mosel.
	CreateIOCallback(XPRMIOCallbackOutput)	This returns the name of an IO driver callback stream. The supplied delegate will be called whenever output is sent to the stream; your function can do with it as you wish (e.g. output it to the screen, write it to a file, display it in a window, etc etc etc...)
	CreateIOCallback(XPRMIOCallbackOutputText)	This returns the name of an IO driver callback stream. The supplied delegate will be called whenever output is sent to the stream; your function can do with it as you wish (e.g. output it to the screen, write it to a file, display it in a window, etc etc etc...) Note that the stream must be called with line-buffering enabled (ie F_OUTPUT_LINEBUF)
	CreateIOCallback(XPRMIOCallbackInput, Object)	This returns the name of an IO driver callback stream. The supplied delegate will be called whenever Mosel needs to read data from the stream; you should return the data to Mosel in a byte array, up to the limit supplied by Mosel.
	CreateIOCallback(XPRMIOCallbackOutput, Object)	This returns the name of an IO driver callback stream. The supplied delegate will be called whenever output is sent to the stream; your function can do with it as you wish (e.g. output it to the screen, write it to a file, display it in a window, etc etc etc...)
	CreateIOCallback(XPRMIOCallbackOutputText, Object)	This returns the name of an IO driver callback stream. The supplied delegate will be called whenever output is sent to the stream; your function can do with it as you wish (e.g. output it to the screen, write it to a file, display it in a window, etc etc etc...) Note that the stream must be called with line-buffering enabled (ie F_OUTPUT_LINEBUF)
	DestroyIOCallback	You should call this method when you have finished using an IO driver callback stream name returned by CreateIOCallback. If you do not do this, resources associated with this callback will not be garbage-collected until the XPRM object is disposed. Mosel must not try to access a IO driver callback after its name is passed to this function.
	Dispose()	Closes down Mosel, deallocating all models and resources. By default this will happen when the XPRM object is garbage-collected, but you can invoke the method explicitly if you want to control when Mosel is unloaded. Note that you must call Dispose() on every object returned by XPRM.Init() if you want to guarantee that the license is released.
	Dispose(Boolean)	Releases the unmanaged resources used by the XPRM and optionally releases the managed resources
	EndLicensing	Ends the OEM licensing procedure. Must always be called the same number of times as BeginLicensing().
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	ExpandPath	Generates an absoute path, taking into account the current working directory and the 'tmp:' IO driver.
	Finalize	Closes the object, and unloads the Mosel interface. (Overrides Object.Finalize().)
	FindModule	Find a module by its name. This method searches for a module of the given name. The module must be loaded in memory.
	FlushModules	Unload unused modules. See also SetAutoUnloadModules(Boolean)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLocaleDir	obtain the location of the translated messages. This function can be used to specify the location of the translated messages (native language support) if they are not stored in the usual place.
	GetModulesPath	Get the directory list where modules are searched for. Note that the returned path includes both the default search path (MOSEL/dso,XPRESSDIR/dso) and the path set up either via the environment variable MOSEL_DSO or the method setModulesPath(string).
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetVersion()	Get Mosel version.
	GetVersion(XPRMVersionType)	Get version information. This function returns the version number of Mosel, the Native Interface or BIM file format.
	Init	Return an XPRM object and initialise Mosel (if necessary) This method must be called first in order to use the library.
	License(String)	Generate a license object. This method initiates the OEM licensing procedure. You must then modify the 'Number' field of the returned XPRMLicense with your OEM license key, using the formula described for 'nvalue' in the OEM user guide, before calling XPRM.License(XPRMLicense).
	License(XPRMLicense)	Check license. This method is used for checking an OEM License. On return, the 'Message' field of the XPRMLicense object will contain your OEM string.
	License(Int32, String)	Deprecated. Use XPRM.License(string) instead.
	LoadModel(Stream)	Load a compiled model into memory. This method loads a compiled model (Binary Model file) from a Stream into memory. While loading a model from a stream, Mosel also automatically opens any additional modules that are required by this model.
	LoadModel(String)	Load a compiled model into memory. This method loads a compiled model (Binary Model file) into memory. While loading a model from a file, Mosel also automatically opens any additional modules that are required by this model.
	LoadModel(Stream, String, String, String, String)	Load a compiled model into memory. This method loads a compiled model (Binary Model file) from a stream into memory. While loading a model from a stream, Mosel also automatically opens any additional modules that are required by this model.
	LoadModel(String, String, String, String, String)	Load a compiled model into memory. This method loads a compiled model (Binary Model file) into memory. While loading a model from a file, Mosel also automatically opens any additional modules that are required by this model.
	LoadModule	Explicitly load a module. Mosel loads modules on demand when they are required by the models in core memory. However, it is possible to force the system to load a module using this function.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RemoveTmpDir	Remove the Mosel workspace temporary directory and any files within it
	SetAutoUnloadModules	Disable or enable automatic unloading of modules. By default, each unused module is automatically unloaded after a fixed period of time. Using this function it is possible to disable this automatic unloading; in which case, unused modules have to be unloaded explicitly using FlushModules()
	SetDefaultStream(XPRMStreamType, TextReader)	Set default input/output streams. This method defines the default global streams: they are used as the default when a model is loaded and whenever no model information is available (e.g. compilation errors, error on modules, etc). The method can be used only if no model is currently loaded in memory.
	SetDefaultStream(XPRMStreamType, TextWriter)	Set default input/output streams. This method defines the default global streams: they are used as the default when a model is loaded and whenever no model information is available (e.g. compilation errors, error on modules, etc). The method can be used only if no model is currently loaded in memory.
	SetDefaultStream(XPRMStreamType, String)	Set default input/output streams. This method defines the default global streams: they are used as the default when a model is loaded and whenever no model information is available (e.g. compilation errors, error on modules, etc). The method can be used only if no model is currently loaded in memory. Using an empty string as the file name implies resetting to the corresponding original default stream.
	SetLocaleDir	Set the location of the translated messages. This function can be used to specify the location of the translated messages (native language support) if they are not stored in the usual place.
	SetModulesPath	Set the directory list where modules are stored. By default, Mosel looks for its modules in the directories defined by the environment variable MOSEL_DSO, in MOSEL/dso and then in XPRESSDIR/dso. This function may be used to replace the directory list defined by MOSEL_DSO. Note that the directory separator is ':' under Unix (e.g. "/opt/Mosel/dso:/tmp") and ';' under Win32 (e.g. "E:\Mosel\Dso;C:\Temp").
	ToString	Returns a String that represents the current Object. (Inherited from Object.)
	Unbind	Unbinds the object associated with this name; the object can now be garbage collected (if no other references to it exist), and can no longer be referred to by this name from the 'dotnetstream' or 'dotnetraw' I/O drivers. This method should be called once a name is not to be used again in Mosel.

Top

See Also

Reference

Mosel Namespace

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.