SnoptOptions Object

 Top  Previous  Next

Description

The SnoptOptions object provides access to configuration parameters that are specific to the third party Snopt optimization system.

 

Inheritance Hierarchy: Object->OptimizerOptions->SnoptOptions

 

Available In Editions:

Mission

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Properties

 

Name

Description

Attributes

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

FunctionPrecision

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

Type:   Variable

Access: Read/Write

MajorOptimalityTolerance

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

Type:   Variable

Access: Read/Write

Name

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

Type:   String

Access: Read/Write

ObjectId

The unique identifier for the object.

Type:   Variable

Access: Read-Only

ObjectType

The type of the object.

Type:   String

Access: Read-Only

PrintFilename

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

Type:   String

Access: Read/Write

SharedLibraryFilename

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

Type:   String

Access: Read/Write

SpecFilename

Path and filename to the spec file to use.

Type:   String

Access: Read/Write

SummaryFilename

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

Type:   String

Access: Read/Write

 
 

 

Methods

 

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.

 
 

 

 

See also

Optimization Guide