Report_RM
Return data in a specified report style.
Syntax
Report_RM <ObjectPath> ({Option} <Value>)...
Related commands
Description
The Report_RM command returns a report, based on the style specified, over the Connect socket
The Report_RM command will return one blank line (zero length) at the end of the report.
Certain options can be set for output created using the Report_RM command. For example, the delimiter between data items and whether or not headers are returned. To set these options use the ExportConfig command.
| {Option} <Value> | Description |
|---|---|
| Style "<ReportStyleName>" | Enter the name of the report style to create, the style must match an existing report style within STK. Available styles display in the STK Report & Graph Manager window.
For details on how to specify "<ReportStyleName>" see Report Style Names The Style option is required. |
| TimePeriod {{TimeInterval} | UseAccessTimes | Intervals {"<FilePath>" | "<IntervalListSpec>"}} |
Enter {TimeInterval} to define the start time and stop time for the report span. For valid {TimeInterval} values see Time Options.
Or specify UseAccessTimes to only report data during access times between the <ObjectPath> and an AccessObject, but you must also specify at least one AccessObject. Or use the Intervals option to specify an STK interval file for the time period or an Interval List component specification. For help on creating the STK interval file, see Create & Import External Files - Interval List in STK Help. For information about "<IntervalListSpec>" see Component Specification. |
| TimeStep {<Value> | Bound <Value> | Array "<TimeArraySpec>"} | Enter the time step <Value> to be used in creating the report. This value is entered in seconds and must be between 0.000001 and 1000000000.0 seconds.
Or enter Bound <Value> to have the report steps calculated on a specific time boundary. This value is entered in seconds and must be between 0 and 3600 seconds. If 0 is entered then the default time step (usually 60 seconds) is used. Or enter Array "<TimeArraySpec>" to use the array times of the Time Array component as time steps. For information about "<TimeArraySpec>" see Component Specification. |
| AccessObject <AccessObjectPath> | If reporting access, specify the object to which access will be calculated. Access will be calculated from the object for which the command is being issued (specified using the <ObjectPath> parameter). This option can be entered multiple times, to specify multiple access objects. |
| AdditionalData "<Data>" | Some Report Styles require additional or pre-data, such as a comparison object for the RIC report for a Satellite. For these types of reports you must include this option. More information on styles that require AdditionalData can be found at "Report Additional Data". |
| Summary {Include | Only} | Use this option to have summary data, if specified in the report style, included with the report data. Enter the Include value to have the summary data included with the rest of the report; use the Only value to have only the summary data reported. By default, summary data is not included in the report data. |
| AllLines {On | Off} | Entering On for this option will return a report that includes all headers, spaces, tabs, and blank lines based on the report Style specified in the command. |
Examples
To return a Lighting Times report for the Shuttle satellite that only addresses four hours:
To return a Cartesian Position report for the Perth facility:
To return a Receiver report of Antenna Gain:
To generate an AER position report only when the satellite has access to Facility/Facility1:
To return the full AER access report, including all lines and spaces, etc:
Return message
Each single message contains one line of data from the report:REPORT_RM 2
3
REPORT_RM 26
"x (km)","y (km)","z (km)"
REPORT_RM 36
1116.630008, -4842.889882, 3984.11923
REPORT_RM 0
Group membership
This command belongs to the following group(s):
Version
12