com.mathworks.mps.client.rest

Class MATLABParams

java.lang.Object

com.mathworks.mps.client.rest.MATLABParams

public class MATLABParams
extends Object

This class creates the payload for the initial HTTP POST request. For more information, see POST Asynchronous Request.

Method Summary

Modifier and Type	Method and Description
MWMarshalingRules	getMwMarshalingRules() Returns an object of type MWMarshalingRules.
int	getNargout() Returns the number of output arguments returned by the MATLAB function.
byte[]	getRequestBody() Constructs a byte array corresponding to the HTTP request body.
Class	getTargetType() Returns the expected target type.
static MATLABParams	newInstance(int nargout, Class targetType, MWMarshalingRules mwMarshalingRules, Object... inputs) Creates a MATLABParams object.
static MATLABParams	newInstance(int nargout, Class targetType, Object... inputs) Creates a MATLABParams object.
void	writeTo(OutputStream outputStream) Writes a byte array corresponding to the MatlabParams object to this output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newInstance

public static MATLABParams newInstance(int nargout,
                                       Class targetType,
                                       MWMarshalingRules mwMarshalingRules,
                                       Object... inputs)

Creates a MATLABParams object.

Parameters:

inputs - Array of objects representing the inputs sent to the MATLAB function deployed on MATLAB Production Server

nargout - Expected number of output arguments

targetType - Expected target output type

mwMarshalingRules - Marshaling rules that contain a list of Java classes marshaled as MATLAB structures; if null, use the overloaded newInstance method

newInstance

public static MATLABParams newInstance(int nargout,
                                       Class targetType,
                                       Object... inputs)

Creates a MATLABParams object.

Parameters:

inputs - Array of objects representing the inputs sent to the MATLAB function deployed on MATLAB Production Server

nargout - Expected number of output arguments

targetType - Expected target output type

getNargout

public int getNargout()

Returns the number of output arguments returned by the MATLAB function.

Returns:

int

getTargetType

public Class getTargetType()

Returns the expected target type.

Returns:

Class

getMwMarshalingRules

public MWMarshalingRules getMwMarshalingRules()

Returns an object of type MWMarshalingRules.

Returns:

MWMarshallingRules

getRequestBody

public byte[] getRequestBody()

Constructs a byte array corresponding to the HTTP request body. Call this method after you construct the MATLABParams object with the required parameters.

Returns:

byte array used in the HTTP request body

writeTo

public void writeTo(OutputStream outputStream)
             throws IOException

Writes a byte array corresponding to the MatlabParams object to this output stream.

Parameters:

outputStream -

Throws:

IOException