MxTransIt COM Automation API

Overview

The MxTransIt COM interface is used to automate creation or execution of a Test Harness. You can use it with any .NET language, such as C# or VBScript. For an example of a program executing a Test Harness, see MxTransIt Automation Samples. You can use this API to create a connection between your application and any device or system that can connect to MxTransIt.

The API provides the following objects and their associated methods and properties:

hmtoggle_plus1MxTransIt Object

Used to access high level features of MxTransIt. To launch MxTransIt and create the application object, use:

CreateObject (“MicroMax.MxTransIt”)

Properties

 

Harness

The current Test Harness

Execution

Contains properties and methods used for execution of the current Harness

IsReady

Returns: True when MxTransIt has completed start up

Methods

 

OpenProject

Opens the Harness file specified by the path.

Parameter: Path – The path of the .mxform file to open.

Returns: True if successful, otherwise false.

SaveProject

Saves the Harness file specified by the path.

Parameter: Path – The path of the .mxform file to save.

Returns: True if successful, otherwise false.

Quit

Terminates MxTransIt
hmtoggle_plus1Harness Object

Methods

 

AddTransform

Parameter: The type of Transform to add. Can be found in the Properties box.

Returns: Transform object

Sample: set xform = mxt.Harness.AddTransform( "MicroMax.MxVDev.Transforms.MxVMC.MxVmcTransform")

GetTransition

Gets the next transition from the MxTransIt response queue

Parameters: None

Returns: A transition object from the MxTransIt response queue if possible, otherwise null

ReplaceTransform

Replaces an exisiting Transform in the Harness with a new one

Parameters:

Old Transform - an instance of the Transform object

New Transform - an instance of the Transform object

Returns: True if the Transform was successfully replaced, otherwise false

Sample: mxt.Harness.ReplaceTransform(oldTransform, newTransform);

SetTransition

Adds a transition to the MxTransIt stimulus queue

Parameters:

portName - The name of the port to receive the transition

value - value of the transition

Returns: True if the transition was successfully queued, otherwise false

Example

SetTransition("MyMessagePort", "0xFFFF")

The code above sets a transition value on a message port. The message value is a hex string, which can be entered with or without the leading "0x". If the Signal is not variable length, the hex string must be the same length as the message buffer.

SendTransitions

Causes the transitions in the MxTransIt stimulus queue to be transmitted on the next tick
hmtoggle_plus1Execution Object

Properties

 

CurrentTime

The current execution time in nanoseconds

IsRunning

True if the current Harness is running, otherwise false

TickResolution

Gets or sets the base Tick Resolution (Tick Period) of the Harness in nanoseconds. The default is 5 ms.

Methods

 

Start

Starts execution of the current Harness

Stop

Stops execution of the current Harness
hmtoggle_plus1Transform Object

Properties

 

InPortCount

The number of inports. Read only.

OutPortCount

The number of outports. Read only.

Name

Get or set the name of the Transform.

Methods

 

GetInPort

Parameter: The index of the port.

Returns: Inport object

GetOutPort

Parameter: The index of the port.

Returns: Outport object

GetProperty

Parameter: The name of the property.

Returns: A value. The type varies depending on the property.

Sample:

MicroMax.MxVDev.Automation.MxTransIt.ITransform subSystem = mxt.Harness.SelectTransformByName("SubSystem");

 

string value = (string)subSystem.GetProperty("External Reference Path");

 

SetProperty

Parameters: The name and value of the property.

Returns: True if successful, otherwise false.

Sample:

MicroMax.MxVDev.Automation.MxTransIt.ITransform subSystem = mxt.Harness.SelectTransformByName("SubSystem");

 

bool isSetCompleted = subSystem.SetProperty("External Reference Path", "C:\\Documents");

 

DoAction

Parameter: The name of the action. Actions are the same as the Verbs listed in the Transform's Properties box.

Returns: True if successful, otherwise false.
hmtoggle_plus1InPort/OutPort Objects

Properties

 

Name

Gets the name of the port. Read only.

Methods

 

Export

Parameter: None

Returns: True if successful, otherwise false.
hmtoggle_plus1Transition Object

Properties

 

PortName

The name of the port that transmitted this transition

Time

The time (in nanoseconds) when this transition was created

Value

The value of this transition

 

Related Topics:

COM Automation (.NET)

MxTransIt Automation Samples

MxTransIt Automation