PrintState()

Prints the data model state to System Coupling's Transcript.

By default, prints the state for the entire data model.

If given optional arguments, behaves as described below in Optional Keyword Arguments.

Optional Keyword Arguments

ObjectPath : string

String indicating the path of the object for which the state is printed. When used, the state is printed only for the specified object.

FilePath : string

String indicating the path and filename of the file to which the state is printed. When used, the state is printed to the specified file instead of the command console.

FileMode : string

String indicating the mode to be used when the state is printed.

Possible values:

w: Write mode. (default value) Subsequent actions are written to a new file.
a: Append mode. Actions are appended to an existing file.

ExplicitSettingsOnly : Boolean

Boolean indicating whether all settings is included (False, default) or only the explicit settings is included (True) when the state is printed.

Return Type

None

Examples

Example 52: Print the state of a specified object


DatamodelRoot().CouplingParticipant['MAPDL-2'].Variable['FORC'].PrintState()

CouplingParticipant:MAPDL-2
  Variable:FORC
    QuantityType = Force
    Location = Node
    DisplayName = Force
    VariableName = Force
    TensorType = Vector
    IsExtensive = True

Example 53: Print the state of a specified singleton


PrintState(ObjectPath = '/SystemCoupling/OutputControl')

OutputControl
  Option = EveryStep
  GenerateCSVChartOutput = False
  Results:
    Option = ProgramControlled
    Type:
      Option = EnsightGold