SectionGraph class is used for section graph settings.
The class can be called from Study class.
.
More...
Public Member Functions | |
| void | AddSelected (Selection *selection) |
| Adds the part that is selected using the Selection object to a calculation. More... | |
| void | AddSet (Set *set, int group=0) |
| Adds the Set object to a calculation. More... | |
| void | Build () |
| Creates a section graph using information required for creating a section graph. The information must be specified in advance. | |
| void | ClearParts () |
| Clears the setting parts. | |
| String | GetAbscissa () |
| Returns the X-axis type as a string. More... | |
| double | GetAngle () |
| Returns the angle of a section graph (arc). More... | |
| double | GetArcOffset () |
| Returns the offset of an arc. More... | |
| double | GetArcOffsetWithUnit (String &unitName) |
| Returns the offset of an arc in the specified unit. More... | |
| Point * | GetAxis () |
| Returns the axis direction of a section graph (arc). More... | |
| String | GetBoundaryCoordinateName () |
| Returns the name of the coordinate system of a symmetry boundary applied to a section graph. More... | |
| String | GetBoundaryCoordinateNameList () |
| Returns the list of coordinate systems of a symmetry boundary applied to a section graph. More... | |
| DataSet * | GetCaseDataSet (int caseno) |
| Returns DataSet object of specified case. More... | |
| Point * | GetCenter () |
| Returns the center point of a section graph (arc). More... | |
| String | GetComponent () |
| Returns the component name. More... | |
| Variant | GetComponentNames () |
| Returns the component name list. More... | |
| double | GetConvergenceTolerance () |
| Returns convergence tolerance. More... | |
| DataSet * | GetDataSet () |
| Returns a DataSet object. More... | |
| Point * | GetEnd () |
| Returns end point of a section graph (line). More... | |
| Point * | GetLineOffset () |
| Returns the offset of a line. More... | |
| Point * | GetLineOffsetWithUnit (String &unitName) |
| Returns the offset of a line in the specified unit. More... | |
| int | GetMaximumCopies () |
| Returns maximum number of copies. More... | |
| String | GetName () |
| Returns the graph name as a string. More... | |
| int | GetNumCopies () |
| Returns number of copies. More... | |
| double | GetPhase () |
| Returns the phase. More... | |
| String | GetPhaseType () |
| Returns the display format. More... | |
| double | GetRadius () |
| Returns the radius of a section graph (arc). More... | |
| int | GetReferenceStep () |
| Returns reference step. More... | |
| String | GetResultComponent () |
| Returns the component of a result type as a string. More... | |
| Variant | GetResultComponentNames () |
| Returns the list of component names of a result type. More... | |
| String | GetResultCoordinateName () |
| Returns the name of the coordinate system that is applied to the section graph. More... | |
| String | GetResultCoordinateNameList () |
| Returns the list of coordinate systems that is applied to the section graph. More... | |
| String | GetResultType () |
| Returns the name of the result type as a string. More... | |
| Variant | GetResultTypeNames () |
| Returns the list of result types. More... | |
| String | GetResultUnit () |
| Returns the unit of result type as a string. More... | |
| Selection * | GetSelection () |
| Returns the part included in a calculation as Selection object. More... | |
| bool | GetSeparateLines () |
| Returns True if materials are divided with lines between each material. More... | |
| Set * | GetSet (int index, int group=0) |
| Returns sets included in a calculation with a specified index. More... | |
| Point * | GetStart () |
| Returns the start point of a section graph (line/arc). More... | |
| Variant | GetSymmetries () |
| Returns the values of the symmetry boundary as a point sequence. More... | |
| int | GetSymmetryXY () |
| Returns the value of the symmetry boundary on the XY-plane as a real number. More... | |
| int | GetSymmetryYZ () |
| Returns the value of the symmetry boundary on the YZ-plane as a real number. More... | |
| int | GetSymmetryZX () |
| Returns the value of the symmetry boundary on the ZX-plane as a real number. More... | |
| double | GetTemperature () |
| Returns temperature. More... | |
| int | GetTruncationType () |
| Returns truncation type. More... | |
| String | GetUnit () |
| Returns the name of a unit as a string. More... | |
| String | GetUserComponentType () |
| Returns the user component name as a character string. More... | |
| virtual bool | IsValid () |
| Returns True if an object is valid. More... | |
| int | NumParts () |
| Returns number of the setting parts. More... | |
| int | NumSets (int group=0) |
| Returns number of the setting sets. More... | |
| void | SetAbscissa (String &name) |
| Specifies an X-axis type. More... | |
| void | SetAirRegionFlag (bool use) |
| Specifies the flag to create a section graph for the arbitrary region. More... | |
| void | SetAirRegionSectionGraph (Variant &numPoints) |
| Specifies an argument to create a section graph for the arbitrary region. More... | |
| void | SetAllSteps () |
| Specifies all steps. | |
| void | SetArc (Point *origin, Point *axis, Point *start, double angle) |
| Specifies an arc from the center point, axis, start point, and angle. More... | |
| void | SetArcByRadius (Point *origin, Point *axis, double radius, double angle) |
| Specifies an arc from the center point, axis, radius, and angle. More... | |
| void | SetArcByRadiusWithUnit (Point *origin, Point *axis, double radius, double angle, String &unitName) |
| Specifies an arc from the center point, axis, radius, and angle with unit specification. More... | |
| void | SetArcExpression (Variant &originX, Variant &originY, Variant &originZ, Variant &axisX, Variant &axisY, Variant &axisZ, Variant &startX, Variant &startY, Variant &startZ, Variant &angle, Variant &radius=Variant()) |
| Specifies center point, axis, start point, and angle of an arc graph. More... | |
| void | SetArcOffset (Variant &offset) |
| Specifies an offset of the arc. More... | |
| void | SetArcOffsetWithUnit (Variant &offset, String &unitName) |
| Specifies an offset of the arc by specifying units. More... | |
| void | SetArcWithUnit (Point *origin, Point *axis, Point *start, double angle, String &unitName) |
| Specifies an arc from center point, axis, start point, and angle. More... | |
| void | SetBoundaryCoordinate (Variant &name) |
| Applies a coordinate system of the symmetric boundary to the section graph by specifying a name or index. More... | |
| void | SetComponent (String &name) |
| Specifies the component. More... | |
| void | SetConvergenceTolerance (Variant &tolerance) |
| Specifies convergence tolerance. More... | |
| void | SetHistoryAllSteps () |
| Specifies the reference range of history functions to all steps. | |
| void | SetHistorySteps (String array &steps) |
| Specifies the steps that is in the reference range of history functions. More... | |
| void | SetHistoryStepsByString (String &str) |
| Specifies multiple steps to be referenced by the history function using a string. More... | |
| void | SetLine (Point *start, Point *end) |
| Specifies a line connecting two points. More... | |
| void | SetLineExpression (Variant &startX, Variant &startY, Variant &startZ, Variant &endX, Variant &endY, Variant &endZ) |
| Specifies the start and end points of a straight line section graph. More... | |
| void | SetLineOffset (Point *offset) |
| Specifies the offset of a line. More... | |
| void | SetLineOffsetWithUnit (Point *offset, String &unitName) |
| Specifies the offset of a line in unit specification. More... | |
| void | SetLineWithUnit (Point *start, Point *end, String &unitName) |
| Specifies a line connecting two points in unit specification. More... | |
| void | SetMaximumCopies (Variant &maximumCopies) |
| Specifies maximum number of copies. More... | |
| void | SetName (String &title) |
| Specifies the name of the graph. More... | |
| void | SetNumCopies (Variant &numCopies) |
| Specifies number of copies. More... | |
| void | SetPhase (double value) |
| Specifies the phase. More... | |
| void | SetPhaseType (Variant &value) |
| Specifies the display format. More... | |
| void | SetReferenceStep (Variant &step) |
| Specifies reference step. More... | |
| void | SetResultComponent (String &name) |
| Specifies the component of a result type. More... | |
| void | SetResultCoordinate (Variant &name) |
| Applies a coordinate system to a section graph by specifying the name or index. More... | |
| void | SetResultType (String &typeName, String &sourceTitle=String()) |
| Specifies result type. More... | |
| void | SetResultUnit (String &name) |
| Specifies a unit used for the result type. More... | |
| void | SetSeparateLines (bool use) |
| Specifies whether or not to output a graph with lines between each material. More... | |
| void | SetSteps (String array &steps) |
| Specifies steps. More... | |
| void | SetStepsByInterval (Variant &interval) |
| Specifies steps in constant intervals. More... | |
| void | SetStepsByString (String &str) |
| Specifies multiple steps using a string. More... | |
| void | SetSymmetry (int xy, int yz, int zx) |
| Specifies boundaries for the XY-plane, YZ-plane, and ZX-plane. More... | |
| void | SetSymmetryXY (int xy) |
| Specifies how the XY-plane is handled. More... | |
| void | SetSymmetryYZ (int yz) |
| Specifies how the YZ-plane is handled. More... | |
| void | SetSymmetryZX (int zx) |
| Specifies a boundary on the ZX-plane. More... | |
| void | SetTargetAllParts (bool all) |
| Specifies flags for all parts. More... | |
| void | SetTemperature (Variant &value) |
| Specifies temperature. More... | |
| void | SetTruncationType (Variant &type) |
| Specifies truncation type. More... | |
| void | SetUserComponentType (String &name) |
| Specifies the user component if the user component ("User") is selected as the result type. More... | |
| bool | TargetAllParts () |
| Returns the flags for all parts. More... | |
SectionGraph class is used for section graph settings.
The class can be called from Study class.
.
Example of calling the class object:
| void SectionGraph::AddSelected | ( | Selection * | selection | ) |
| void SectionGraph::AddSet | ( | Set * | set, |
| int | group = 0 |
||
| ) |
| String SectionGraph::GetAbscissa | ( | ) |
Returns the X-axis type as a string.
| double SectionGraph::GetAngle | ( | ) |
Returns the angle of a section graph (arc).
| double SectionGraph::GetArcOffset | ( | ) |
Returns the offset of an arc.
| double SectionGraph::GetArcOffsetWithUnit | ( | String & | unitName | ) |
Returns the offset of an arc in the specified unit.
| unitName | Unit |
| Point * SectionGraph::GetAxis | ( | ) |
Returns the axis direction of a section graph (arc).
| String SectionGraph::GetBoundaryCoordinateName | ( | ) |
Returns the name of the coordinate system of a symmetry boundary applied to a section graph.
| String SectionGraph::GetBoundaryCoordinateNameList | ( | ) |
Returns the list of coordinate systems of a symmetry boundary applied to a section graph.
| DataSet * SectionGraph::GetCaseDataSet | ( | int | caseno | ) |
| Point * SectionGraph::GetCenter | ( | ) |
Returns the center point of a section graph (arc).
| String SectionGraph::GetComponent | ( | ) |
Returns the component name.
| Variant SectionGraph::GetComponentNames | ( | ) |
Returns the component name list.
| double SectionGraph::GetConvergenceTolerance | ( | ) |
Returns convergence tolerance.
| Point * SectionGraph::GetEnd | ( | ) |
Returns end point of a section graph (line).
| Point * SectionGraph::GetLineOffset | ( | ) |
Returns the offset of a line.
| Point * SectionGraph::GetLineOffsetWithUnit | ( | String & | unitName | ) |
Returns the offset of a line in the specified unit.
| unitName | Unit |
| int SectionGraph::GetMaximumCopies | ( | ) |
Returns maximum number of copies.
| String SectionGraph::GetName | ( | ) |
Returns the graph name as a string.
| int SectionGraph::GetNumCopies | ( | ) |
Returns number of copies.
| double SectionGraph::GetPhase | ( | ) |
Returns the phase.
Some of the output items of magnetic field frequency analysis, structural eigenmode analysis, structural frequency analysis, and electric field frequency analysis can be obtained.
| String SectionGraph::GetPhaseType | ( | ) |
Returns the display format.
Some of the output items of magnetic field frequency analysis, structural eigenmode analysis, structural frequency analysis, and electric field frequency analysis can be obtained.
| double SectionGraph::GetRadius | ( | ) |
Returns the radius of a section graph (arc).
| int SectionGraph::GetReferenceStep | ( | ) |
Returns reference step.
This command is used when the demagnetization ratio (Compared to reference step) is selected as the result type.
| String SectionGraph::GetResultComponent | ( | ) |
Returns the component of a result type as a string.
| Variant SectionGraph::GetResultComponentNames | ( | ) |
Returns the list of component names of a result type.
| String SectionGraph::GetResultCoordinateName | ( | ) |
Returns the name of the coordinate system that is applied to the section graph.
| String SectionGraph::GetResultCoordinateNameList | ( | ) |
Returns the list of coordinate systems that is applied to the section graph.
| String SectionGraph::GetResultType | ( | ) |
Returns the name of the result type as a string.
| Variant SectionGraph::GetResultTypeNames | ( | ) |
Returns the list of result types.
| String SectionGraph::GetResultUnit | ( | ) |
Returns the unit of result type as a string.
| Selection * SectionGraph::GetSelection | ( | ) |
| bool SectionGraph::GetSeparateLines | ( | ) |
Returns True if materials are divided with lines between each material.
| Set * SectionGraph::GetSet | ( | int | index, |
| int | group = 0 |
||
| ) |
| Point * SectionGraph::GetStart | ( | ) |
Returns the start point of a section graph (line/arc).
| Variant SectionGraph::GetSymmetries | ( | ) |
Returns the values of the symmetry boundary as a point sequence.
This command is not available for structural analysis.
| int SectionGraph::GetSymmetryXY | ( | ) |
Returns the value of the symmetry boundary on the XY-plane as a real number.
This command is not available for structural analysis.
| int SectionGraph::GetSymmetryYZ | ( | ) |
Returns the value of the symmetry boundary on the YZ-plane as a real number.
This command is not available for structural analysis.
| int SectionGraph::GetSymmetryZX | ( | ) |
Returns the value of the symmetry boundary on the ZX-plane as a real number.
This command is not available for structural analysis.
| double SectionGraph::GetTemperature | ( | ) |
Returns temperature.
This command is used when the demagnetization ratio (Compared to undemagnetized state, temperature dependent) is selected as the result type.
| int SectionGraph::GetTruncationType | ( | ) |
Returns truncation type.
| String SectionGraph::GetUnit | ( | ) |
Returns the name of a unit as a string.
| String SectionGraph::GetUserComponentType | ( | ) |
Returns the user component name as a character string.
|
virtual |
Returns True if an object is valid.
| int SectionGraph::NumParts | ( | ) |
Returns number of the setting parts.
| int SectionGraph::NumSets | ( | int | group = 0 | ) |
Returns number of the setting sets.
| void SectionGraph::SetAbscissa | ( | String & | name | ) |
Specifies an X-axis type.
| name | X-axis type |
| void SectionGraph::SetAirRegionFlag | ( | bool | use | ) |
Specifies the flag to create a section graph for the arbitrary region.
| use | True=1 : Section Line/Arc for Arbitrary Region
False=0 : Section Line/Arc
|
This command is not available for structural analysis.
| void SectionGraph::SetAirRegionSectionGraph | ( | Variant & | numPoints | ) |
Specifies an argument to create a section graph for the arbitrary region.
| numPoints | Interval |
This command is not available for structural analysis.
| void SectionGraph::SetArcExpression | ( | Variant & | originX, |
| Variant & | originY, | ||
| Variant & | originZ, | ||
| Variant & | axisX, | ||
| Variant & | axisY, | ||
| Variant & | axisZ, | ||
| Variant & | startX, | ||
| Variant & | startY, | ||
| Variant & | startZ, | ||
| Variant & | angle, | ||
| Variant & | radius = Variant() |
||
| ) |
Specifies center point, axis, start point, and angle of an arc graph.
| originX | X-coordinate of origin |
| originY | Y-coordinate of origin |
| originZ | Z-coordinate of origin |
| axisX | X-coordinate of a point on central axis |
| axisY | Y-coordinate of a point on central axis |
| axisZ | Z-coordinate of a point on central axis |
| startX | X-coordinate of start point |
| startY | Y-coordinate of start point |
| startZ | Z-coordinate of start point |
| angle | Angle |
| radius | Radius |
| void SectionGraph::SetArcOffset | ( | Variant & | offset | ) |
Specifies an offset of the arc.
| offset | Offset distance |
| void SectionGraph::SetArcOffsetWithUnit | ( | Variant & | offset, |
| String & | unitName | ||
| ) |
Specifies an offset of the arc by specifying units.
| offset | Offset distance |
| unitName | Unit name |
| void SectionGraph::SetBoundaryCoordinate | ( | Variant & | name | ) |
Applies a coordinate system of the symmetric boundary to the section graph by specifying a name or index.
| name | Name or index of the coordinate system |
| void SectionGraph::SetComponent | ( | String & | name | ) |
Specifies the component.
| name | Component name. "Radial" and "Z" and so on. |
| void SectionGraph::SetConvergenceTolerance | ( | Variant & | tolerance | ) |
Specifies convergence tolerance.
| tolerance | Convergence tolerance |
| void SectionGraph::SetHistorySteps | ( | String array & | steps | ) |
Specifies the steps that is in the reference range of history functions.
| steps | Step |
| void SectionGraph::SetHistoryStepsByString | ( | String & | str | ) |
Specifies multiple steps to be referenced by the history function using a string.
The steps can be specified either with a comma (1,2,3) or by range (e.g. 4-8).
| str | Step |
| void SectionGraph::SetLineExpression | ( | Variant & | startX, |
| Variant & | startY, | ||
| Variant & | startZ, | ||
| Variant & | endX, | ||
| Variant & | endY, | ||
| Variant & | endZ | ||
| ) |
Specifies the start and end points of a straight line section graph.
| startX | X-coordinate of start point |
| startY | Y-coordinate of start point |
| startZ | Z-coordinate of start point |
| endX | X-coordinate of end point |
| endY | Y-coordinate of end point |
| endZ | Z-coordinate of end point |
| void SectionGraph::SetLineOffset | ( | Point * | offset | ) |
Specifies the offset of a line.
| offset | Point object (offset distance) |
| void SectionGraph::SetLineOffsetWithUnit | ( | Point * | offset, |
| String & | unitName | ||
| ) |
Specifies the offset of a line in unit specification.
| offset | Point object (offset distance) |
| unitName | Unit |
| void SectionGraph::SetMaximumCopies | ( | Variant & | maximumCopies | ) |
Specifies maximum number of copies.
| maximumCopies | Maximum number of copies |
| void SectionGraph::SetName | ( | String & | title | ) |
Specifies the name of the graph.
| title | Graph name |
| void SectionGraph::SetNumCopies | ( | Variant & | numCopies | ) |
Specifies number of copies.
| numCopies | Number of copies |
| void SectionGraph::SetPhase | ( | double | value | ) |
Specifies the phase.
Some of the output items of magnetic field frequency analysis, structural eigenmode analysis, structural frequency analysis, and electric field frequency analysis can be obtained.
| value | Phase |
| void SectionGraph::SetPhaseType | ( | Variant & | value | ) |
Specifies the display format.
Some of the output items of magnetic field frequency analysis, structural eigenmode analysis, structural frequency analysis, and electric field frequency analysis can be obtained.
| value | Phase type
"RealImag" or "0" = Displays real part and imaginary part
"AmplitudePhase" or "1" = Displays amplitude and phase
"FixedPhase" or "2" = Specified phase
|
| void SectionGraph::SetReferenceStep | ( | Variant & | step | ) |
Specifies reference step.
| step | Reference Step ID |
This command is used to display the demagnetization ratio (Compared to reference step) for a magnetic field analysis.
| void SectionGraph::SetResultComponent | ( | String & | name | ) |
Specifies the component of a result type.
| name | Component name of a result type |
| void SectionGraph::SetResultCoordinate | ( | Variant & | name | ) |
Applies a coordinate system to a section graph by specifying the name or index.
| name | Name or index of the coordinate system |
| void SectionGraph::SetResultType | ( | String & | typeName, |
| String & | sourceTitle = String() |
||
| ) |
Specifies result type.
| typeName | Result type name. "MagneticFlux Density" and "Magnetization" and so on. For user components, enter "User". |
| sourceTitle | Title of result calculation processing (such as FFT) when referring to the calclation tool. |
The argument "sourceTitle" can be omitted.
For more information about the condition type name that can be specified as the argument "typeName", see Properties and Flags for Calculating Results .
| void SectionGraph::SetResultUnit | ( | String & | name | ) |
Specifies a unit used for the result type.
This command is used to specify the unit of "temperature distribution" for a result type of thermal analysis or thermal stress analysis.
| name | Unit name |
Enter Fahrenheit or Celsius according to the unit you want to use.
| void SectionGraph::SetSeparateLines | ( | bool | use | ) |
Specifies whether or not to output a graph with lines between each material.
| use | True=1 : Divides line with a material
False=0 : Do not divide line with a material
|
| void SectionGraph::SetSteps | ( | String array & | steps | ) |
Specifies steps.
| steps | Step |
| void SectionGraph::SetStepsByInterval | ( | Variant & | interval | ) |
Specifies steps in constant intervals.
| interval | Interval |
| void SectionGraph::SetStepsByString | ( | String & | str | ) |
Specifies multiple steps using a string.
The step can be specified either with comma (1,2,3) or by range (e.g. 4-8).
| str | Step |
| void SectionGraph::SetSymmetry | ( | int | xy, |
| int | yz, | ||
| int | zx | ||
| ) |
Specifies boundaries for the XY-plane, YZ-plane, and ZX-plane.
| xy | Symmetry boundary : 1
None : 0
Natural boundary : -1
|
| yz | Symmetry boundary : 1
None : 0
Natural boundary : -1
|
| zx | Symmetry boundary : 1
None : 0
Natural boundary : -1
|
This command is not available for structural analysis.
| void SectionGraph::SetSymmetryXY | ( | int | xy | ) |
Specifies how the XY-plane is handled.
| xy | Symmetry boundary : 1
None : 0
Natural boundary : -1
|
This command is not available for structural analysis.
| void SectionGraph::SetSymmetryYZ | ( | int | yz | ) |
Specifies how the YZ-plane is handled.
| yz | Symmetry boundary : 1
None : 0
Natural boundary : -1
|
This command is not available for structural analysis.
| void SectionGraph::SetSymmetryZX | ( | int | zx | ) |
Specifies a boundary on the ZX-plane.
| zx | Symmetry boundary : 1
None : 0
Natural boundary : -1
|
This command is not available for structural analysis.
| void SectionGraph::SetTargetAllParts | ( | bool | all | ) |
Specifies flags for all parts.
| all | "0" = Release flag for all parts
|
| void SectionGraph::SetTemperature | ( | Variant & | value | ) |
Specifies temperature.
| value | Temperature |
This command is used to display the demagnetization ratio (Compared to undemagnetized state, temperature dependent) for a magnetic field analysis.
| void SectionGraph::SetTruncationType | ( | Variant & | type | ) |
| void SectionGraph::SetUserComponentType | ( | String & | name | ) |
Specifies the user component if the user component ("User") is selected as the result type.
| name | Name of the user component |
| bool SectionGraph::TargetAllParts | ( | ) |
Returns the flags for all parts.