<Plugin Search Profile>

This attribute defines a plugin search profile.

Syntax

Astrogator <Satellite Object Path> SetValue <Attribute Path>.Profiles.<Plugin Search Profile>.{Attribute} <Value> [{Unit}]

Astrogator_RM <Satellite Object Path> GetMCSConstraintValue <Attribute Path>.Profiles.<Plugin Search Profile> <ParentObjectName> <ResultName> <Attribute>

Astrogator_RM <Satellite Object Path> GetMCSControlValue <Attribute Path>.Profiles.<Plugin Search Profile> <ParentObjectName> <ControlName> <Attribute>

Astrogator <Satellite Object Path> SetMCSConstraintValue <Attribute Path>.Profiles.<Plugin Search Profile> <ParentObjectName> <ResultName> <Attribute> <Value> [<Unit>]

Astrogator <Satellite Object Path> SetMCSControlValue <Attribute Path>.Profiles.<Plugin Search Profile> <ParentObjectName> <ControlName> <Attribute> <Value> [<Unit>]

Description

A plugin search profile is a COM component plugin that implements a customized search algorithm.

Examples

Control Parameters (Independent Variables)

Retrieving Current Value

CurrentValue only works with GetMCSControlValue because it is read only.

Astrogator_RM */Satellite/Satellite1 GetMCSControlValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection Propagate StoppingConditions.Duration.TripValue CurrentValue

Retrieving Initial Value

InitialValue only works with GetMCSControlValue because it is read only.

Astrogator_RM */Satellite/Satellite1 GetMCSControlValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection Propagate StoppingConditions.Duration.TripValue InitialValue

Retrieving Values for Every Iteration

Values only works with GetMCSControlValue because it is read only. It returns a list of the variable's values at every iteration.

Astrogator_RM */Satellite/Satellite1 GetMCSControlValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection Propagate StoppingConditions.Duration.TripValue Values

Setting Custom Values

To set a custom value of the plugin, add PluginConfig to the path.

Astrogator */Satellite/Satellite1 SetMCSControlValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection Propagate StoppingConditions.Duration.TripValue PluginConfig.Step 10 sec

Setting Custom Display Unit to Active/Inactive

Set UseCustomUnit to true to use a custom display unit.

Astrogator */Satellite/Satellite1 SetMCSControlValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection Propagate StoppingConditions.Duration.TripValue UseCustomUnit true

Defining Custom Display Unit

Specify the custom display unit.

Astrogator */Satellite/Satellite1 SetMCSControlValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection Propagate StoppingConditions.Duration.TripValue Unit day

Results (Dependent Variables)

Retrieving Current Value

CurrentValue only works with GetMCSConstraintValue because it is read only.

Astrogator_RM */Satellite/Satellite1 GetMCSConstraintValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection Propagate R_Mag CurrentValue

Retrieving Values for Every Iteration

Values only works with GetMCSConstraintValue because it is read only. It returns a list of the variable's values at every iteration.

Astrogator_RM */Satellite/Satellite1 GetMCSConstraintValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection Propagate R_Mag Values

Setting Custom Values

To set a custom value of the plugin, add PluginConfig to the path.

Astrogator */Satellite/Satellite1 SetMCSConstraintValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection Propagate R_Mag PluginConfig.DesiredValue 10000 km

Setting Custom Display Unit to Active/Inactive

Set UseCustomUnit to true to use a custom display unit.

Astrogator */Satellite/Satellite1 SetMCSConstraintValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection Propagate R_Mag UseCustomUnit true

Defining Custom Display Unit

Specify the custom display unit.

Astrogator */Satellite/Satellite1 SetMCSConstraintValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection Propagate R_Mag Unit m

Selecting Reset Before Each Run

Set this attribute to true to use this option; otherwise, set it to false.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ResetBeforeEachRun true

Setting Custom Values

To set a custom value of the plugin, add PluginConfig to the path.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.PluginConfig.MaxIterations 50

Graphs

Defining the Graphs List

Add a Graph component for each graph needed. The graph names will automatically be changed to be unique.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs Graph Graph Graph

To keep an existing graph while adding new ones to the list, include the name of the existing graph in the list.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs "My Graph" Graph Graph

Graph Properties

To retrieve or set the value of the properties of a graph, you must append the graph name after "Graphs".

Graph Name

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.ComponentName "My Graph"

Graph Generation

The value is a boolean.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.GraphWhileRunning true

User Comment

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.UserComment "This graph shows x"

Independent Variable

The value can be "Iteration" or the name of an active control or result.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.IndependentVariable Maneuver_:_Semimajor_Axis

Label Iterations

The value is a boolean.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.LabelIterations false

Show Desired Value

The value is a boolean.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.ShowDesired true

Show Tolerance Band

The value is a boolean.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.ShowTolerance true

Active Controls

To retrieve or set the value of the graph properties of an active control, you must append "ActiveControlOptions" and the name of the control after the graph name.

Graph Value

The value is a boolean.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.ActiveControlOptions.Maneuver_:_ImpulsiveMnvr_Cartesian_X.GraphValue true

Line Color

The color is defined in hexadecimal format, as 0x00BBGGRR, where BB is blue, GG is green, and RR is red. Connect does not acknowledge hexadecimal numbers, so once you have chosen the hexadecimal expression of the desired color, you will have to convert it to a decimal number.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.ActiveControlOptions.Maneuver_:_ImpulsiveMnvr_Cartesian_X.GraphLineColor 1

Point Style

The value can be Circle, Cross, Diamond, Down Triangle, None, Plus, Solid Diamond, Solid Dot, Solid Down Triangle, Solid Square, Solid Triangle, Square, or Triangle.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.ActiveControlOptions.Maneuver_:_ImpulsiveMnvr_Cartesian_X.GraphPointStyle "Solid Down Triangle"

Y Axis

The value can be Y1 or Y2.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.ActiveControlOptions.Maneuver_:_ImpulsiveMnvr_Cartesian_X.GraphYAxis Y2

Results

To retrieve or set the value of the graph properties of a result, you must append "ResultOptions" and the name of the result after the graph name.

Graph Option

The value can be "Don't graph", "Graph difference", or "Graph value".

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.ResultOptions.Maneuver_:_Semimajor_Axis.GraphOption "Graph difference"

Show Desired Value

The value is a boolean.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.ResultOptions.Maneuver_:_Semimajor_Axis.GraphDesired true

Line Color

The color is defined in hexadecimal format, as 0x00BBGGRR, where BB is blue, GG is green, and RR is red. Connect does not acknowledge hexadecimal numbers, so once you have chosen the hexadecimal expression of the desired color, you will have to convert it to a decimal number.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.ResultOptions.Maneuver_:_Semimajor_Axis.GraphLineColor 1

Point Style

The value can be Circle, Cross, Diamond, Down Triangle, None, Plus, Solid Diamond, Solid Dot, Solid Down Triangle, Solid Square, Solid Triangle, Square, or Triangle.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.ResultOptions.Maneuver_:_Semimajor_Axis.GraphPointStyle "Solid Down Triangle"

Y Axis

The value can be Y1 or Y2.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.ResultOptions.Maneuver_:_Semimajor_Axis.GraphYAxis Y2

Show Tolerance Band

The value is a boolean.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.Graphs.Graph1.ResultOptions.Maneuver_:_Semimajor_Axis.GraphTolerance true

Scripting

Setting to Enabled/Disabled

Set Enabled to true to use the Scripting Tool.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Enabled true

Defining Object Property List

Add an Attribute component in the list for each object property needed.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Attributes Attribute Attribute

Specifying Object

Enter the object that the attribute component will be associated with.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Attributes.Attribute.Object Propagate

Specifying Attribute

Enter the specific attribute of the object that the attribute component uses.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Attributes.Attribute.Attribute StoppingConditions.Duration.TripValue

Specifying Unit

Enter the unit in which the object property will be used in the script.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Attributes.Attribute.Unit min

Selecting Editable or Read-Only Attributes

Set ReadOnlyProperty to true to select from read-only attributes or false to select from editable attributes.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Attributes.Attribute.ReadOnlyProperty true

Defining Calc Object List

Enter a Calc Object component for each calculation object needed.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.CalcObjects CalcObject CalcObject

Specifying Calc Object

Enter the name of the calculation object the component should use.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.CalcObjects.CalcObject.CalcObject Altitude

To set a property of the calc object, add that property to the attribute path (this example sets the altitude calc object to be lunar altitude).

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.CalcObjects.CalcObject.CalcObject.CentralBody Moon

Specifying Unit

Enter the unit in which the calculation object will be used in the script.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.CalcObjects.CalcObject.Unit m

Specifying Parameter List

Enter a Parameter component for each parameter needed.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Parameters Parameter Parameter

Setting a Parameter to Inherit Its Value

Set InheritValue to true to have the parameter inherit its value (and unit dimension and unit) from a previous search profile that has the same parameter or false to define the value manually.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Parameters.Parameter.InheritValue true

Setting a User Comment

Enter a user comment.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Parameters.Parameter.UserComment This parameter is my favorite

Selecting a Minimum Value

Set UseMinValue to true to give the parameter a minimum value.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Parameters.Parameter.UseMinValue true

Setting a Minimum Value

If UseMinValue is true, define a minimum value for the parameter.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Parameters.Parameter.MinValue 0

Selecting a Maximum Value

Set UseMaxValue to true to give the parameter a maximum value.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Parameters.Parameter.UseMaxValue true

Setting a Maximum Value

If UseMaxValue is true, define a maximum value for the parameter.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Parameters.Parameter.MaxValue 10

Defining Parameter Value

Enter the value of the parameter.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Parameters.Parameter.ParamValue 20

Defining Parameter Type

Enter "Boolean", "Date", "Double", "Enumeration", "Integer", "Quantity", or "String".

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Parameters.Parameter.ParamType Boolean

Defining Parameter Unit

Enter a unit.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Parameters.Parameter.Unit m/sec

Defining Parameter Unit Dimension

Enter a unit dimension.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Parameters.Parameter.UnitDimension Rate

Specifying Language

Enter the desired scripting language.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Language JScript

or

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Language VBScript

or

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.Language MATLAB

Specifying Script

Enter the text of the script.

Astrogator */Satellite/Satellite1 SetValue MainSequence.SegmentList.Target_Sequence.Profiles.JScript_Bisection.ScriptingTool.ScriptStatements "Attribute = 2 * Parameter"

STK Programming Interface 11.0.1