7.2. Diagnostic Control

This section is referenced in the following other sections

Running & Troubleshooting: Diagnostic Output

7.2.1. Diagnostic Control

Scope

Sierra

Summary

Specifies the diagnostic writer to set output control features.

Description

The diagnostic and informational output can be selectively enabled based on time, step or an application specified condition. During the application’s procedure execution loop, the diagnostic controller evaluates the enclosed line commands in the order specified in the input deck. The diagnostic options specified in the first line command that meets its criteria are applied.

Since control parameters are only applied when the criteria is met, it is important to include an ENABLE line command with the base settings to be applied as a baseline. Refer the ‘-h’ output for a complete list of diagnostic writers and available values.

The options which may be enabled varies for each application, diagnostic and information writer. To obtain a list of available options, use the sierra app -i -O -h command.

See Diagnostic Stream for specifying the output destination.

begin Diagnostic Control Name

   Enable Printmask

   From Step StartStep To EndStep Enable Printmask

   Set Information Stream Path File_path

end Diagnostic Control Name

7.2.1.1. Line Commands

Enable

Syntax: Enable Printmask
Summary: Specifies the options to enable when no other control option criteria are satisfied.

Parameter	Value	Default
Printmask	“string”	–

From Step

Syntax: From Step StartStep To EndStep Enable Printmask
Summary: Specifies the options to enable when the step is within the specified range.

Parameter	Value	Default
StartStep	integer	–
EndStep	integer	–
Printmask	“string”	–

Set Information Stream Path

Syntax: Set Information Stream Path File_path
Summary: File path to information stream information to.

Parameter	Value	Default
File_path	string	–

7.2.2. Diagnostic Stream

Syntax: Diagnostic Stream File_name [ Indent-streambuf-flags1[ Indent-streambuf-flags2] ]
Summary: File path to write diagnostic messages to.

Parameter	Value	Default
File_name	string	–