Smoother Scope Functions

The Smoother attribute scope contains functions that enable you to interact with a Smoother object.

CAgAttr GetStateContents(string roughFilename)

This previews which states the smoother will use, based on a specific rough file. The StateContent tool calls this function.

Parameters

roughFilename string The string path of the rough file to preview states from

Return Value

CAgAttr A list of states (as a list of strings) applicable to the smoother

Example VBS:

Copy 
rFile = "c:\temp\SampleRoughFile.rough"
Set stateList = sc.Smoother(0).GetStateContents(rFile)

bool Go()

Use this to run the smoother.

Return Value

bool A Boolean indicating whether or not the smoother ran to completion

Example VBS:

Copy 
bSuccess = sc.Smoother(0).Go

It returns a flag indicating if the smoother ran and if the subsequent ephemeris prediction propagated to the requested stop time. To distinguish between the smoother run itself and the ephemeris prediction, you can inspect the following Boolean attributes for detailed status/error information:

Copy 
Smoother.RunResults.SetupSuccess = <bool>
Smoother.RunResults.RunSuccess = <bool>
Smoother.RunResults.RunCanceled = <bool>
Smoother.RunResults.PropagatorError = <bool>
Smoother.RunResults.EphemerisPredictPropagatorError = <bool>
Smoother.RunResults.PropagatorAltitudeError = <bool>
Smoother.RunResults.PropagatorVelocityError = <bool>
Smoother.RunResults.PropagatorStateVectorError = <bool>
Smoother.RunResults.PropagatorErrorSatelliteName = <string>
Smoother.RunResults.PropagatorErrorTime = <time>

bool Stop()

Use this to stop the execution of the smoother.

Parameters

bool A Boolean that is always true

Example VBS:

Copy 
bSuccess = sc.Smoother(0).Stop