ReportInterface Object

Description

The ReportInterface object provides the mechanism to collect data and text to be written to an ASCII file. Hint: use the FileInterface to convert a binary file to an ASCII file or an ASCII file to a binary file in the desired format.

Inheritance Hierarchy: Object->ReportInterface

Available In Editions:

Engineer

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.

Name	Description	Attributes
Append	Determines if data will be appended to an existing file of the same name, or if any existing data will be overwritten.	Type: Variable Access: Read/Write
AutoLinefeed	Determines whether the Report will automatically include a linefeed at the end of each Report command. Note that the Report command keywords "without linefeed" will override this setting.	Type: Variable Access: Read/Write
AutoPadding	Determines whether the Report will automatically pad columns with spaces. Note that the Report command keywords "without padding" will override this setting.	Type: Variable Access: Read/Write
ColumnDelimiter	The character to use when delimiting Array or Matrix columns.	Type: String Access: Read/Write
CustomHeaderLabels	StringArray containing custom column headers. If the number of items in the StringArray doesn't match the number of columns being reported, an error will be thrown. To change the format of the headers, use the HeaderType property.	Type: StringArray Access: Read-Only
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Filename	The name and path of the file to be created. If no path is declared then the file will be created in the local directory where the mission plan resides.	Type: String Access: Read/Write
HeaderType	Determines the format of the headers. To show or hide the headers completely, set this value to "None."	Type: Variable Access: Read/Write
IsOpen	Returns a 0/1 flag indicating whether the ReportInterface object is opened or not.	Type: Variable Access: Read-Only
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
NumberFormat	The format in which to write numeric values. Note that this will be overriden by per-item qualifiers, i.e. "Report myValue<width, precision> to myReportInterface."	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