This repository has been archived by the owner on Mar 4, 2023. It is now read-only.
/
FieldReportOptions.py
125 lines (108 loc) · 4.5 KB
/
FieldReportOptions.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
from abaqusConstants import *
from ..Session.NumberFormat import NumberFormat
class FieldReportOptions:
"""The FieldReportOptions object stores settings used by the writeFieldReport method when
you write a FieldOutput object to an ASCII file. The FieldReportOptions object has no
constructor. Abaqus creates the *fieldReportOptions* member when you import the
Visualization module.
Attributes
----------
numberFormat: NumberFormat
Format of the number
Notes
-----
This object can be accessed by:
.. code-block:: python
import visualization
session.defaultFieldReportOptions
session.fieldReportOptions
"""
# Format of the number
numberFormat: NumberFormat = NumberFormat()
def setValues(
self,
numColumns: int = 80,
numberFormat: NumberFormat = NumberFormat(),
printXYData: Boolean = ON,
printTotal: Boolean = ON,
printMinMax: Boolean = ON,
pageWidth: SymbolicConstant = NO_LIMIT,
columnLayout: SymbolicConstant = SINGLE_TABLE,
sort: SymbolicConstant = ASCENDING,
printLocalCSYS: Boolean = OFF,
):
"""This method modifies the FieldReportOptions object.
Parameters
----------
numColumns
An Int specifying the number of columns to display for the tabular report. The default
value is 80.
numberFormat
A NumberFormat object specifying the format type, number of digits and precision used to
print the numeric output.
printXYData
A Boolean specifying whether to include *X–Y* data values in the tabular report. The
default value is ON.
printTotal
A Boolean specifying whether to include column totals in the tabular report. The default
value is ON.
printMinMax
A Boolean specifying whether to include column summary minimum and maximum values in the
tabular report. The default value is ON.
pageWidth
A SymbolicConstant specifying how the width of the tabular report is to be determined.
Possible values are NO_LIMIT and SPECIFY. The default value is NO_LIMIT.
columnLayout
A SymbolicConstant specifying how values are to be presented in the tabular report.
Possible values are SINGLE_TABLE and SEPARATE_TABLES. The default value is SINGLE_TABLE.
sort
A SymbolicConstant specifying the order in which values are to be sorted within a
tabular report. Possible values are ASCENDING and DESCENDING. The default value is
ASCENDING.
printLocalCSYS
A Boolean specifying whether to include the local coordinate system values in the
tabular report. The default value is OFF.
Returns
-------
A FieldReportOptions object.
"""
pass
def NumberFormat(
self,
blankPad: Boolean = ON,
format: SymbolicConstant = ENGINEERING,
numDigits: int = 6,
precision: int = 0,
) -> NumberFormat:
"""This method creates a NumberFormat object.
Notes
-----
This function can be accessed by:
.. code-block:: python
session.defaultFieldReportOptions.NumberFormat
session.fieldReportOptions.NumberFormat
session.journalOptions.NumberFormat
Parameters
----------
blankPad
A Boolean specifying whether the printed digits should be padded with blank characters
to ensure equal sized fields. The *blankPad* argument is useful when your printed output
includes columns. The default value is ON.
format
A SymbolicConstant specifying the formatting type. Possible values are ENGINEERING,
SCIENTIFIC, and AUTOMATIC. The default value is ENGINEERING.
numDigits
An Int specifying the number of digits to be displayed in the result. *numDigits* >0>0.
The default value is 6.
precision
An Int specifying the number of decimal places to which the number is to be truncated
for display. *precision* ≤0≤0. If *precision* =0, no truncation is applied. The default
value is 0.
Returns
-------
A NumberFormat object.
"""
self.numberFormat = numberFormat = NumberFormat(
blankPad, format, numDigits, precision
)
return numberFormat