|
LSSTApplications
18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
LSSTDataManagementBasePackage
|
Include textual comments in output? (bool)
This is a boolean attribute which controls whether textual comments are to be included in the output generated by a Channel. If included, they will describe what each item of output represents.
If Comment is true, then comments will be included. If it is false, comments will be omitted.
The default value is true for a normal Channel.
The default value is true for a FitsChan.
The default value is false for an XmlChan.
Set level of output detail. (int)
This attribute is a three-state flag and takes values of -1, 0 or +1. It controls the amount of information included in the output generated by a Channel.
If Full is false, then a modest amount of non-essential but useful information will be included in the output. If Full is negative, all non-essential information will be suppressed to minimise the amount of output, while if it is positive, the output will include the maximum amount of detailed information about the Object being written.
The default value is false for a normal Channel.
The default value is false for a FitsChan.
The default value is -1 for an XmlChan.
The default value is false for an StcsChan. Set a positive value to cause default values to be included in STC-S descriptions.
Specifies the indentation to use in text produced by a Channel. (int)
This attribute controls the indentation within the output text produced by Channel::write. It gives the increase in the indentation for each level in the object heirarchy. If it is set to zero, no indentation will be used.
The default value is zero for a basic Channel.
The FitsChan class ignores this attribute.
The default value for an StcsChan is zero, which causes the entire STC-S description is written out by a single invocation of the sink function. The text supplied to the sink function will not contain any linefeed characters, and each pair of adjacent words will be separated by a single space. The text may thus be arbitrarily large and the StcsLength attribute is ignored.
If Indent is non-zero, then the text is written out via multiple calls to the sink function, each call corresponding to a single "line" of text (although no line feed characters will be inserted by AST). The complete STC-S description is broken into lines so that:
If this causes a sub-phrase to extend to two or more lines, then the second and subsequent lines will be indented by three spaces compared to the first line. In addition, lines within a compound spatial region will have extra indentation to highlight the nesting produced by the parentheses. Each new level of nesting will be indented by a further three spaces.
The default value for an XmlChan is zero, which results in no linefeeds or indentation strings being added to output text. If any non-zero value is assigned to Indent, then extra linefeed and space characters will be inserted as necessary to ensure that each XML tag starts on a new line, and each tag will be indented by a further 3 spaces to show its depth in the containment hierarchy.
Determines which read/write conditions are reported. (int)
This attribute determines which, if any, of the conditions that occur whilst reading or writing an Object should be reported. These conditions will generate either a fatal error or a warning, as determined by attribute Strict. ReportLevel can take any of the following values:
The default value is 1. Note, there are many other conditions that can occur whilst reading or writing an Object that completely prevent the conversion taking place. Such conditions will always generate errors, irrespective of the ReportLevel and Strict attributes.
Skip irrelevant data? (bool)
This is a boolean attribute which indicates whether the Object data being read through a Channel are inter-mixed with other, irrelevant, external data.
If Skip is false (the default for all but FitsChan), then the source of input data is expected to contain descriptions of AST Objects and comments and nothing else (if anything else is read, an error will result). If Skip is true (the default for @ref FitsChan), then any non-Object data encountered between Objects will be ignored and simply skipped over in order to reach the next Object.
The FitsChan class sets the default value of this attribute to true, so that all irrelevant FITS headers will normally be ignored.
Report an error if any unexpeted data items are found? (bool)
This is a boolean attribute which indicates whether a warning rather than an error should be issed for insignificant conversion problems. If it is set true, then fatal errors are issued instead of warnings, resulting in an exception being thrown. If Strict is false (the default), then execution continues after minor conversion problems, and a warning message is added to the Channel structure. Such messages can be retrieved using the astWarnings function.
1.8.13