com.sas.cas.actions.localSearch

Class SolveLsoOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.localSearch.SolveLsoOptions

All Implemented Interfaces:

KeyedMap<java.lang.String,java.lang.Object>, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>

public class SolveLsoOptions
extends CASGeneratedActionOptions

Options for solveLso: Solve LSO Problem.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SolveLsoOptions.ALGORITHM

Nested classes/interfaces inherited from class com.sas.cas.CASActionOptions

CASActionOptions.EnumValue, CASActionOptions.FORMAT

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_NAME
static java.lang.String	ACTION_SET_NAME
static java.lang.String	KEY_ALGORITHM
static java.lang.String	KEY_CONFUNCINFO
static java.lang.String	KEY_DISPLAY
static java.lang.String	KEY_INPUTDATASETS
static java.lang.String	KEY_LINCON
static java.lang.String	KEY_LOGGINGOPTIONS
static java.lang.String	KEY_NTHREADS
static java.lang.String	KEY_NUMOBJS
static java.lang.String	KEY_NUMVARS
static java.lang.String	KEY_OBJFUNCINFO
static java.lang.String	KEY_OPTIMIZATIONCONTROLS
static java.lang.String	KEY_OUTPUTDATASETS
static java.lang.String	KEY_OUTPUTTABLES
static java.lang.String	KEY_STOPPINGCRITERIA
static java.lang.String	KEY_TECHNICALOPTIONS
static java.lang.String	KEY_VARINFO

Fields inherited from class com.sas.cas.CASActionOptions

FLAGS_EXPAND_ARRAYS, FLAGS_IGNORE_DISPOSITION_ERROR, FLAGS_RETURN_RESULTS_ON_EXCEPTION, FLAGS_SKIP_ACTION_EVENTS, FLAGS_SKIP_RESULTS, HIDDEN_PASSWORD, JSON_NULL, LUA_NIL, PARAMETER_FLAG_ISPASSWORD, PARAMETER_FLAG_ISPATH, PARAMETER_FLAG_ISTABLENAME, PARAMETER_FLAG_ISVAR, PARAMETER_FLAG_REQUIRED, PYTHON_NULL, SERIALIZED_PREFIX

Constructor Summary

Constructors

Constructor and Description
SolveLsoOptions()
SolveLsoOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
SolveLsoOptions.ALGORITHM	getAlgorithm()
ConFuncInfo[]	getConFuncInfo()
DisplayTables	getDisplay()
InputDatasets	getInputDatasets()
Castable	getLinCon()
LoggingOptions	getLoggingOptions()
java.lang.Integer	getNthreads()
java.lang.Integer	getNumObjs()
java.lang.Integer	getNumVars()
ObjFuncInfo[]	getObjFuncInfo()
OptimizationControls	getOptimizationControls()
OutputDatasets	getOutputDatasets()
OutputTables	getOutputTables()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
StoppingCriteria	getStoppingCriteria()
TechnicalOptions	getTechnicalOptions()
VarInfo[]	getVarInfo()
SolveLsoOptions	setAlgorithm(SolveLsoOptions.ALGORITHM value) Sets the value of parameter 'algorithm'.
SolveLsoOptions	setConFuncInfo(ConFuncInfo[] value) Sets the value of parameter 'conFuncInfo'.
SolveLsoOptions	setDisplay(DisplayTables value) Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.
SolveLsoOptions	setInputDatasets(InputDatasets value) Sets the value of parameter 'inputDatasets'.
SolveLsoOptions	setLinCon(Castable value) Sets the value of parameter 'linCon': specifies the settings for an input table.
SolveLsoOptions	setLoggingOptions(LoggingOptions value) Sets the value of parameter 'loggingOptions'.
SolveLsoOptions	setNthreads(java.lang.Integer value) Sets the value of parameter 'nthreads'.
SolveLsoOptions	setNumObjs(java.lang.Integer value) Sets the value of parameter 'numObjs'.
SolveLsoOptions	setNumVars(java.lang.Integer value) Sets the value of parameter 'numVars'.
SolveLsoOptions	setObjFuncInfo(ObjFuncInfo[] value) Sets the value of parameter 'objFuncInfo'.
SolveLsoOptions	setOptimizationControls(OptimizationControls value) Sets the value of parameter 'optimizationControls'.
SolveLsoOptions	setOutputDatasets(OutputDatasets value) Sets the value of parameter 'outputDatasets'.
SolveLsoOptions	setOutputTables(OutputTables value) Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.
SolveLsoOptions	setStoppingCriteria(StoppingCriteria value) Sets the value of parameter 'stoppingCriteria'.
SolveLsoOptions	setTechnicalOptions(TechnicalOptions value) Sets the value of parameter 'technicalOptions'.
SolveLsoOptions	setVarInfo(VarInfo[] value) Sets the value of parameter 'varInfo'.

Methods inherited from class com.sas.cas.CASActionOptions

addActionFlags, addParameterFlag, appendValue, checkForPasswords, clear, containsKey, containsValue, convertToEnumArray, copy, deserialize, entrySet, equals, findOptionsClass, findSetter, get, getActionFlags, getActionName, getActionResponseEventListener, getActionResultEventListener, getActionSetName, getCASClient, getClassName, getDebugOptions, getDispositionEventListener, getFullyQualifiedActionName, getLogEventListener, getLogMessage, getMessageOutputStream, getMessageTagHandler, getParameter, getParameterAsBoolean, getParameterAsByteArray, getParameterAsDouble, getParameterAsDoubleArray, getParameterAsInteger, getParameterAsIntegerArray, getParameterAsLong, getParameterAsLongArray, getParameterAsString, getParameterAsStringArray, getParameterFlags, getParameterIgnoreCase, getParameterIgnoreCase, getParameterKeys, getPerformanceEventListener, getPropertyKey, getSessionID, getUserProperty, getUserPropertyKeys, hashCode, invoke, isEmpty, isFlagSet, isMap, isParameterFlagSet, isPassword, isPath, isRequired, isTable, isVariable, keySet, put, putAll, putAllDeep, putDeep, putDeep, quoteIfNotNull, remove, removeParameter, set, setActionFlags, setActionName, setActionResponseEventListener, setActionResultEventListener, setActionSetName, setCASClient, setDebugOptions, setDispositionEventListener, setFullyQualifiedActionName, setLogEventListener, setLogMessage, setMessageOutputStream, setMessageTagHandler, setParameter, setPerformanceEventListener, setPropertyKey, setSessionID, setUserProperty, size, toCASLString, toLuaString, toLuaString, toOptionsWithGeneratedClasses, toSerialized, toString, toString, toString, upcaseFirstChar, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

ACTION_SET_NAME

public static final java.lang.String ACTION_SET_NAME

See Also:

Constant Field Values

ACTION_NAME

public static final java.lang.String ACTION_NAME

See Also:

Constant Field Values

KEY_NUMVARS

public static final java.lang.String KEY_NUMVARS

See Also:

Constant Field Values

KEY_VARINFO

public static final java.lang.String KEY_VARINFO

See Also:

Constant Field Values

KEY_NUMOBJS

public static final java.lang.String KEY_NUMOBJS

See Also:

Constant Field Values

KEY_OBJFUNCINFO

public static final java.lang.String KEY_OBJFUNCINFO

See Also:

Constant Field Values

KEY_LINCON

public static final java.lang.String KEY_LINCON

See Also:

Constant Field Values

KEY_CONFUNCINFO

public static final java.lang.String KEY_CONFUNCINFO

See Also:

Constant Field Values

KEY_ALGORITHM

public static final java.lang.String KEY_ALGORITHM

See Also:

Constant Field Values

KEY_STOPPINGCRITERIA

public static final java.lang.String KEY_STOPPINGCRITERIA

See Also:

Constant Field Values

KEY_OPTIMIZATIONCONTROLS

public static final java.lang.String KEY_OPTIMIZATIONCONTROLS

See Also:

Constant Field Values

KEY_INPUTDATASETS

public static final java.lang.String KEY_INPUTDATASETS

See Also:

Constant Field Values

KEY_OUTPUTDATASETS

public static final java.lang.String KEY_OUTPUTDATASETS

See Also:

Constant Field Values

KEY_TECHNICALOPTIONS

public static final java.lang.String KEY_TECHNICALOPTIONS

See Also:

Constant Field Values

KEY_LOGGINGOPTIONS

public static final java.lang.String KEY_LOGGINGOPTIONS

See Also:

Constant Field Values

KEY_NTHREADS

public static final java.lang.String KEY_NTHREADS

See Also:

Constant Field Values

KEY_DISPLAY

public static final java.lang.String KEY_DISPLAY

See Also:

Constant Field Values

KEY_OUTPUTTABLES

public static final java.lang.String KEY_OUTPUTTABLES

See Also:

Constant Field Values

Constructor Detail

SolveLsoOptions

public SolveLsoOptions()

SolveLsoOptions

public SolveLsoOptions(CASActionOptions options)

Method Detail

getServerDefaultValue

public java.lang.Object getServerDefaultValue(java.lang.String key)

Description copied from class: CASActionOptions

Gets the server default value, if known.

Overrides:

getServerDefaultValue in class CASActionOptions

Parameters:

key - The parameter key

Returns:

THe default value, or null if not known

getNumVars

public java.lang.Integer getNumVars()

setNumVars

public SolveLsoOptions setNumVars(java.lang.Integer value)

Sets the value of parameter 'numVars'. The server default is 1.

Parameters:

value - The value

Returns:

The options object

getVarInfo

public VarInfo[] getVarInfo()

setVarInfo

public SolveLsoOptions setVarInfo(VarInfo[] value)

Sets the value of parameter 'varInfo'.

Parameters:

value - The value

Returns:

The options object

getNumObjs

public java.lang.Integer getNumObjs()

setNumObjs

public SolveLsoOptions setNumObjs(java.lang.Integer value)

Sets the value of parameter 'numObjs'. The server default is 1.

Parameters:

value - The value

Returns:

The options object

getObjFuncInfo

public ObjFuncInfo[] getObjFuncInfo()

setObjFuncInfo

public SolveLsoOptions setObjFuncInfo(ObjFuncInfo[] value)

Sets the value of parameter 'objFuncInfo'.

Parameters:

value - The value

Returns:

The options object

getLinCon

public Castable getLinCon()

setLinCon

public SolveLsoOptions setLinCon(Castable value)

Sets the value of parameter 'linCon': specifies the settings for an input table.

Parameters:

value - The value

Returns:

The options object

getConFuncInfo

public ConFuncInfo[] getConFuncInfo()

setConFuncInfo

public SolveLsoOptions setConFuncInfo(ConFuncInfo[] value)

Sets the value of parameter 'conFuncInfo'.

Parameters:

value - The value

Returns:

The options object

getAlgorithm

public SolveLsoOptions.ALGORITHM getAlgorithm()

setAlgorithm

public SolveLsoOptions setAlgorithm(SolveLsoOptions.ALGORITHM value)

Sets the value of parameter 'algorithm'. The server default is ALGORITHM.HYBRID.

Parameters:

value - The value

Returns:

The options object

getStoppingCriteria

public StoppingCriteria getStoppingCriteria()

setStoppingCriteria

public SolveLsoOptions setStoppingCriteria(StoppingCriteria value)

Sets the value of parameter 'stoppingCriteria'.

Parameters:

value - The value

Returns:

The options object

getOptimizationControls

public OptimizationControls getOptimizationControls()

setOptimizationControls

public SolveLsoOptions setOptimizationControls(OptimizationControls value)

Sets the value of parameter 'optimizationControls'.

Parameters:

value - The value

Returns:

The options object

getInputDatasets

public InputDatasets getInputDatasets()

setInputDatasets

public SolveLsoOptions setInputDatasets(InputDatasets value)

Sets the value of parameter 'inputDatasets'.

Parameters:

value - The value

Returns:

The options object

getOutputDatasets

public OutputDatasets getOutputDatasets()

setOutputDatasets

public SolveLsoOptions setOutputDatasets(OutputDatasets value)

Sets the value of parameter 'outputDatasets'.

Parameters:

value - The value

Returns:

The options object

getTechnicalOptions

public TechnicalOptions getTechnicalOptions()

setTechnicalOptions

public SolveLsoOptions setTechnicalOptions(TechnicalOptions value)

Sets the value of parameter 'technicalOptions'.

Parameters:

value - The value

Returns:

The options object

getLoggingOptions

public LoggingOptions getLoggingOptions()

setLoggingOptions

public SolveLsoOptions setLoggingOptions(LoggingOptions value)

Sets the value of parameter 'loggingOptions'.

Parameters:

value - The value

Returns:

The options object

getNthreads

public java.lang.Integer getNthreads()

setNthreads

public SolveLsoOptions setNthreads(java.lang.Integer value)

Sets the value of parameter 'nthreads'. The server default is 0.

Parameters:

value - The value

Returns:

The options object

getDisplay

public DisplayTables getDisplay()

setDisplay

public SolveLsoOptions setDisplay(DisplayTables value)

Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.

Parameters:

value - The value

Returns:

The options object

getOutputTables

public OutputTables getOutputTables()

setOutputTables

public SolveLsoOptions setOutputTables(OutputTables value)

Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.

Parameters:

value - The value

Returns:

The options object