SnoptOptions Object

Name

Description

DeclaredName

The name of the object as declared.

DisplayName

The name displayed for this object in output windows such as views, plots, and reports.

FunctionPrecision

The accuracy with which the non-linear functions can be computed. Refer to SNOPT documentation for more information.

MajorOptimalityTolerance

Tolerance on the final accuracy of the dual variables. Refer to SNOPT documentation for more information.

ObjectId

The unique identifier for the object.

ObjectType

The type of the object.

PrintFilename

Path and filename used to capture output that SNOPT writes to the Print file.

SharedLibraryFilename

Path and filename to the shared library (.dll on windows, .so on linux) to use.

SpecFilename

Path and filename to the spec file to use.

SummaryFilename

Path and filename used to redirect standard output written from Snopt.

Name

Description

ClearAllOptions

Clears all options that were previously set for the optimization process.

ClearSavedStates

Clears previous saved states for this object.

GetFromFile

Load the object state from the specified FreeFlyer object file.

GetFromString

Load the object state from the specified string.

PutToFile

Convert the object state to FreeFlyer object xml and write to a file.

PutToString

Convert the object state to FreeFlyer object xml and return as a string.

ReferenceEquals

Returns 1 if the argument refers to the calling object and 0 otherwise.

Restore

Restore an object's state from a previously saved state.

Save

Save the object's state so that it can be restored later.

SetIntParameter

Adds an option as an integer value to be used in the optimization process. If the option is not valid, it will throw an error on initialization. See the Snopt documentation for valid options to be set through this interface.

SetParameter

Adds a string option to be used in the optimization process. If the option is not valid, it will throw an error on initialization. See the Snopt documentation for valid options to be set through this interface.

SetRealParameter

Adds an option a floating point value to be used in the optimization process. If the option is not valid, it will throw an error on initialization. See the Snopt documentation for valid options to be set through this interface.