MmodStream

MIL_TEXT_PTR MemPtrOrFileName,	//in-out
MIL_ID SysId,	//in
MIL_INT64 Operation,	//in
MIL_INT64 StreamType,	//in
MIL_DOUBLE Version,	//in
MIL_INT64 ControlFlag,	//in
MIL_ID *ContextModIdPtr,	//in-out
MIL_INT *SizeByteVarPtr	//out

)

Description

This function can load, restore, or save a Model Finder context from/to a file or memory stream.

To inquire the number of bytes necessary to save a Model Finder context to memory stream, you should first call this function (MmodStream()) with M_INQUIRE_SIZE_BYTE.

The content saved to memory stream is equivalent to the content saved to file. This function is equivalent to a file saved using MmodSave().

You can use this and other MIL stream functions, for example, to save all required MIL objects, as well as any other custom data, for your application to a memory stream. Once in a memory stream, you can write the stream to a single file or transfer it over a network. You are responsible for concatenating the streams and for saving the stream to file. All information about the previously allocated Model Finder context is saved, including all of the individual models' current settings. However, preprocessing, any associated camera calibration contexts and drawing control type settings are not saved.

All of the Model Finder context's settings that were in effect when the Model Finder context was saved will be restored. A loaded or restored Model Finder context is not preprocessed, therefore you must call MmodPreprocess() before performing a search with MmodFind(). If you had associated camera calibration contexts with the models in your Model Finder context and you did not save them with the context, you must re-associate the camera calibration contexts, using MmodControl() with M_ASSOCIATED_CALIBRATION.

Using MmodStream(), you can choose to save a backwards-compatible version of the Model Finder context, which will work using a version of MIL that is up to one major release older than the current version (depending on which version is specified). For example, if you allocate a Model Finder context using MIL 10.0 and save it to version 9.0, you can restore this context on a computer where MIL 9.0 is installed. However, all settings and features unique to the higher version will be ignored when restored using the lower version. Besides saving backwards-compatible versions, you can also load or restore Model Finder contexts saved using MIL version 7.0 or above. Settings that do not exist in the lower version will be filled with default values when the Model Finder context is loaded or restored.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.

Parameters

This function is not supported on the selected boards.

This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.

Parameters

MemPtrOrFileName

Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):

MIL_TEXT_PTR [optionally, in C++: a reference to a MIL_STRING]
Optionally, in C++: a reference to a std::vector of type MIL_UINT8

Specifies the file or memory stream.

See the Parameter associations section for possible values that can be returned/specified.

SysId

Specifies the system on which to restore the Model Finder context.

See the Parameter associations section for possible values that can be specified.

Operation

Specifies the operation to perform on the Model Finder context.

See the Parameter associations section for possible values that can be specified.

StreamType

Specifies the type of stream in which to store/from which to restore the Model Finder context.

For specifying the type of stream
Value	Description
M_FILE	Specifies a file stream.
M_MEMORY	Specifies a memory stream. You are responsible for allocating a block of memory for the stream. (summarize) Specifies a memory stream. (more details...)

Version

Specifies the MIL version of the Model Finder context. When performing an M_LOAD or M_RESTORE operation, this parameter must be set to M_DEFAULT.

See the Parameter associations section for possible values that can be specified.

ControlFlag

Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models.

For specifying whether to restore or save the camera calibration contexts
Value	Description
M_DEFAULT	Specifies that the camera calibration contexts are not saved or restored.
M_WITH_CALIBRATION	Specifies that the camera calibration contexts are saved or restored, depending on the Operation parameter. When restored, the camera calibration contexts must have been previously saved with the context, using MmodSave() or MmodStream() with M_WITH_CALIBRATION. Note that the camera calibration contexts associated with synthetic models are not saved or restored. The camera calibration information is restored from/ saved to the same file or memory stream as the Model Finder context. The camera calibration cannot be managed independently from the Model Finder context. When the Model Finder context is freed, the camera calibration is automatically freed as well. (summarize) Specifies that the camera calibration contexts are saved or restored, depending on the Operation parameter. (more details...)

ContextModIdPtr

Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context.

See the Parameter associations section for possible values that can be returned/specified.

SizeByteVarPtr

Specifies the address of the variable in which to write the size of the Model Finder context, in bytes.

If the size is not required, you can set this parameter to M_NULL.

Note that the size of a Model Finder context will vary depending on the MIL version specified.

Parameter associations

The table below lists possible values for the MemPtrOrFileName, SysId, Operation, Version, and ContextModIdPtr parameters.

For performing the stream operation.

For performing the stream operation.
Operation			Description
	MemPtrOrFileName - Possible values passed or returned
	SysId
	Version
	ContextModIdPtr - Possible values passed or returned
M_INQUIRE_SIZE_BYTE			Inquires the number of bytes required to save a Model Finder context to memory stream. This operation is not supported when the StreamType parameter is set to M_FILE. (summarize) Inquires the number of bytes required to save a Model Finder context to memory stream. (more details...)
	MemPtrOrFileName		This parameter must be set to M_NULL. (summarize) This parameter must be set to M_NULL. (more details...)
	SysId		This parameter must be set to M_NULL. (summarize) This parameter must be set to M_NULL. (more details...)
	Version		Specifies the MIL version with which the Model Finder context must be compatible when saved. The size of a Model Finder context might differ from one MIL version to another. (summarize) Specifies the MIL version with which the Model Finder context must be compatible when saved. (more details...)
		M_DEFAULT	Specifies the current version of MIL.
		M_PROC_VERSION_90	Specifies the version as being MIL 9.0.
		M_PROC_VERSION_90_PP1	Specifies the version as being MIL 9.0 Processing Pack 1.
		M_PROC_VERSION_90_PP2	Specifies the version as being MIL 9.0 Processing Pack 2.
		M_PROC_VERSION_100	Specifies the version as being MIL 10.0.
		M_PROC_VERSION_100_PP1	Specifies the version as being MIL 10.0 Processing Pack 1.
		M_PROC_VERSION_100_PP2	Specifies the version as being MIL 10.0 Processing Pack 2.
		M_PROC_VERSION_100_PP3	Specifies the version as being MIL 10.0 Processing Pack 3.
		M_PROC_VERSION_100_SP4	Specifies the version as being MIL 10.0 Service Pack 4.
	ContextModIdPtr		Specifies the address of the variable containing the identifier of the Model Finder context. (summarize) Specifies the address of the variable containing the identifier of the Model Finder context. (more details...)
M_LOAD			Loads the content of a specified file or memory stream into a previously allocated Model Finder context. (summarize) Loads the content of a specified file or memory stream into a previously allocated Model Finder context. (more details...)
	MemPtrOrFileName		Specifies the file or memory stream from which to load the context. (summarize) Specifies the file or memory stream from which to load the context. (more details...)
		M_INTERACTIVE	[This is only applicable to Windows] Opens a dialog box from which you can interactively specify the drive, directory, and name of the file, when the StreamType parameter is set to M_FILE.
		MIL_TEXT("FileName") ¹	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. Model Finder contexts typically have an MMF file extension. The function handles (internally) the opening and closing of the file. To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). (summarize) Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. (more details...)
		MemPtr	Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. The block of memory should be of type MIL_UINT8. The specified address must correspond to the first memory address in which the object is located, and the block of memory must contain the entire object. Note that when using a C compiler (not a C++ or other compiler), you must cast the MIL_UINT8 pointer to a MIL_TEXT_PTR. (summarize) Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. (more details...)
	SysId		This parameter must be set to M_NULL. (summarize) This parameter must be set to M_NULL. (more details...)
	Version		This parameter must be set to M_DEFAULT. (summarize) This parameter must be set to M_DEFAULT. (more details...)
	ContextModIdPtr		Specifies the address of the variable containing the identifier of the Model Finder context. All previous settings are overwritten with those of the loaded context, or are set to the default value if the settings didn't exist in the version of MIL from which the context is being loaded. (summarize) Specifies the address of the variable containing the identifier of the Model Finder context. (more details...)
M_RESTORE			Restores a Model Finder context from a file or memory stream and assigns it a MIL identifier. (summarize) Restores a Model Finder context from a file or memory stream and assigns it a MIL identifier. (more details...)
	MemPtrOrFileName		Specifies the file or memory stream from which to restore the context. (summarize) Specifies the file or memory stream from which to restore the context. (more details...)
		M_INTERACTIVE	[This is only applicable to Windows] Opens a dialog box from which you can interactively specify the drive, directory, and name of the file, when the StreamType parameter is set to M_FILE.
		MIL_TEXT("FileName") ¹	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. Model Finder contexts typically have an MMF file extension. The function handles (internally) the opening and closing of the file. To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). (summarize) Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. (more details...)
		MemPtr	Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. The block of memory should be of type MIL_UINT8. The specified address must correspond to the first memory address in which the object is located, and the block of memory must contain the entire object. Note that when using a C compiler (not a C++ or other compiler), you must cast the MIL_UINT8 pointer to a MIL_TEXT_PTR. (summarize) Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. (more details...)
	SysId		Specifies the system on which to allocate the Model Finder context. (summarize) Specifies the system on which to allocate the Model Finder context. (more details...)
		M_DEFAULT_HOST	Specifies the default Host system of the current MIL application.
		MIL system identifier	Specifies a valid system identifier, previously allocated using MsysAlloc().
	Version		This parameter must be set to M_DEFAULT. (summarize) This parameter must be set to M_DEFAULT. (more details...)
	ContextModIdPtr		Specifies the address of the variable in which to write the identifier of the Model Finder context. If the operation is not successful, M_NULL is returned. (summarize) Specifies the address of the variable in which to write the identifier of the Model Finder context. (more details...)
M_SAVE			Saves a Model Finder context to a specified file or memory stream. (summarize) Saves a Model Finder context to a specified file or memory stream. (more details...)
	MemPtrOrFileName		Specifies the file or memory stream. (summarize) Specifies the file or memory stream. (more details...)
		M_INTERACTIVE	[This is only applicable to Windows] Opens a dialog box from which you can interactively specify the drive, directory, and name of the file, when the StreamType parameter is set to M_FILE.
		MIL_TEXT("FileName") ¹	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. For easier use with other Matrox Imaging software products, when saving a model finder context to a file, use the MMF file extension. The function handles (internally) the opening and closing of the file. If the file already exists, it will be overwritten. To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). (summarize) Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. (more details...)
		MemPtr	Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. The block of memory should be of type MIL_UINT8. The specified address must correspond to the first memory address in which to write, and the block of memory must be large enough to stream the entire object. To determine the required size, call this function with M_INQUIRE_SIZE_BYTE. Note that when using a C compiler (not a C++ or other compiler), you must cast the MIL_UINT8 pointer to a MIL_TEXT_PTR. (summarize) Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. (more details...)
	SysId		This parameter must be set to M_NULL. (summarize) This parameter must be set to M_NULL. (more details...)
	Version		Specifies the MIL version with which the Model Finder context must be compatible when saved. Note that the Model Finder context can only be up to one major release older (MIL 9.0) than the current version. (summarize) Specifies the MIL version with which the Model Finder context must be compatible when saved. (more details...)
		M_DEFAULT	Specifies the current version of MIL.
		M_PROC_VERSION_90	Specifies the version as being MIL 9.0.
		M_PROC_VERSION_90_PP1	Specifies the version as being MIL 9.0 Processing Pack 1.
		M_PROC_VERSION_90_PP2	Specifies the version as being MIL 9.0 Processing Pack 2.
		M_PROC_VERSION_100	Specifies the version as being MIL 10.0.
		M_PROC_VERSION_100_PP1	Specifies the version as being MIL 10.0 Processing Pack 1.
		M_PROC_VERSION_100_PP2	Specifies the version as being MIL 10.0 Processing Pack 2.
		M_PROC_VERSION_100_PP3	Specifies the version as being MIL 10.0 Processing Pack 3.
		M_PROC_VERSION_100_SP4	Specifies the version as being MIL 10.0 Service Pack 4.
	ContextModIdPtr		Specifies the address of the variable containing the identifier of the Model Finder context to save. (summarize) Specifies the address of the variable containing the identifier of the Model Finder context to save. (more details...)

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

Compilation information

Header	Include mil.h.
Library	Use mil.lib; milmod.lib.
DLL	Requires mil.dll; milmod.dll.