MockIAlgorithmCatalogEntry2 Class

Namespace: Phoenix.Optimization.AlgorithmTests.MockObjects

Overview

Copy of MockIAlgorithmCatalogEntry with different metadata on the wrapped [IAlgorithm]()

Inheritance

Declaration

class MockIAlgorithmCatalogEntry2

Description

Copy of MockIAlgorithmCatalogEntry with different metadata on the wrapped [IAlgorithm]().

Additional Inherited Members

Public Member Functions inherited from MockIAlgorithmCatalogEntry

Type	Name	Description
`ISerializableAlgorithm`	`DeserializeAlgorithm (string xml)`	Given the XML tag for an `ISerializableAlgorithm`, deserialize the tag and return the result.
void	`DeserializeAlgorithmToUserInteractionInstance (string xml)`	Given the XML tag for an `ISerializableAlgorithm`, deserialize the tag and save it in this instance's `UserInteractionInstance`.
void	`DeserializeOptionsToUserInteractionInstance (string innerXML)`	Given the XML tag for an options object, deserialize the tag to the `IAlgorithm.Options` property of `UserInteractionInstance`.
void	`Dispose ()`
object	`GetCurrentOptionsForDialog ()`	Returns a clone of the `UserInteractionInstance` `IAlgorithm.Options` property for use in the default options dialog. The `UserInteractionInstance` should be prepared to accept this object being passed as the value to set the `IAlgorithm.Options` property, which indicates that the user clicked "OK" and wants to set the modified version of the object.
object	`GetDefaultOptionsForDialog ()`	Returns a default version of the object this algorithm uses for options. The `UserInteractionInstance` should be prepared to accept this object being passed as the value to set the `IAlgorithm.Options` property, which indicates that the user clicked "OK" and wants to set the modified version of the object.
`ISerializableAlgorithm`	`GetOutOfProcessAlgorithm ()`	Create an out-of-process instance of the algorithm suitable for running the algorithm.Before running, the Optimization Tool will set the problem definition and options object currently in use on the `UserInteractionInstance`. The caller of this method owns the returned `IAlgorithm` and is responsible for disposing it.
	`MockIAlgorithmCatalogEntry (IAlgorithm algorithm)`	Constructor.
`ISerializableAlgorithm`	`DeserializeAlgorithm (string xml)`	Given the XML tag for an `ISerializableAlgorithm`, deserialize the tag and return the result.
void	`DeserializeAlgorithmToUserInteractionInstance (string xml)`	Given the XML tag for an `ISerializableAlgorithm`, deserialize the tag and save it in this instance's UserInteractionInstance.
void	`DeserializeOptionsToUserInteractionInstance (string innerXML)`	Given the XML tag for an options object, deserialize the tag to the `IAlgorithm.Options` property of UserInteractionInstance.
object	`GetCurrentOptionsForDialog ()`	Returns a clone of the `UserInteractionInstance` `IAlgorithm.Options` property for use in the default options dialog.
object	`GetDefaultOptionsForDialog ()`	Returns a default version of the object this algorithm uses for options.
`ISerializableAlgorithm`	`GetOutOfProcessAlgorithm ()`	Create an out-of-process instance of the algorithm suitable for running the algorithm.

Protected Member Functions inherited from MockIAlgorithmCatalogEntry

Type	Name	Description
virtual void	`Setup (IAlgorithm algorithm)`	Initialization method used by contructors to set up the wrapped `IAlgorithm`.

Protected Attributes inherited from MockIAlgorithmCatalogEntry

Type	Name	Description
`IAlgorithm`	`_algorithm`	The mock `IAlgorithm` object.

Properties inherited from MockIAlgorithmCatalogEntry

Type	Name	Description
string	`Id [get]`	The ID for this algorithm entry. This is sometimes used to relocate an algorithm in the overall catalog. This property should be the same as the key associated with this entry in the dictionary returned by `IDynamicAlgorithmProvider.LoadAlgorithms`.
`IAlgorithm`	`UserInteractionInstance [get]`	This instance is intended for the Opt Tool to present to the user when configuring the algorithm and optimization tool. The instance is owned by the catalog entry and should be disposed when it is disposed.

Properties inherited from IAlgorithmCatalogEntry

Type	Name	Description
string	`Id [get]`	The ID for this algorithm entry.
`IAlgorithm`	`UserInteractionInstance [get]`	This instance is intended for the Opt Tool to present to the user when configuring the algorithm and optimization tool.

ModelCenter Custom Optimization Algorithm SDK 2026 R1