# OCC.Message module

class `Handle_Message_Algorithm`(*args)

  Bases: `OCC.MMgt.Handle_MMgt_TShared`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_Message_ListNodeOfListOfMsg`(*args)

  Bases: `OCC.TCollection.Handle_TCollection_MapNode`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_Message_Messenger`(*args)

  Bases: `OCC.MMgt.Handle_MMgt_TShared`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_Message_Printer`(*args)

  Bases: `OCC.MMgt.Handle_MMgt_TShared`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_Message_PrinterOStream`(*args)

  Bases: `OCC.Message.Handle_Message_Printer`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_Message_ProgressIndicator`(*args)

  Bases: `OCC.MMgt.Handle_MMgt_TShared`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_Message_SequenceNodeOfSequenceOfPrinters`(*args)

  Bases: `OCC.TCollection.Handle_TCollection_SeqNode`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_Message_SequenceNodeOfSequenceOfProgressScale`(*args)

  Bases: `OCC.TCollection.Handle_TCollection_SeqNode`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Message_Algorithm`(*args)

  Bases: `OCC.MMgt.MMgt_TShared`

  - Empty constructor

  Return type: | None

  `AddStatus`()
    - Add statuses to this algorithm from other algorithm (including messages)

    Parameters: | theOther (Handle_Message_Algorithm &) –
    Return type: | None

    - Add statuses to this algorithm from other algorithm, but only those items are moved that correspond to statuses set in theStatus

    Parameters: | theStatus (Message_ExecStatus &) – theOther (Handle_Message_Algorithm &) –
    Return type: | None

  `ChangeStatus`()
    - Returns exec status of algorithm

    Return type: | Message_ExecStatus

  `ClearStatus`()
    - Clear exec status of algorithm

    Return type: | None

  `GetHandle`()
  `GetMessageNumbers`()
    - Return the numbers associated with the indicated status; Null handle if no such status or no numbers associated with it

    Parameters: | theStatus (Message_Status &) –
    Return type: | Handle_TColStd_HPackedMapOfInteger

  `GetMessageStrings`()
    - Return the strings associated with the indicated status; Null handle if no such status or no strings associated with it

    Parameters: | theStatus (Message_Status &) –
    Return type: | Handle_TColStd_HSequenceOfHExtendedString

  `GetMessenger`()
    - Returns messenger of algorithm. The returned handle is always non-null and can be used for sending messages.

    Return type: | Handle_Message_Messenger

  `GetStatus`()
    - Returns copy of exec status of algorithm

    Return type: | Message_ExecStatus

  static `PrepareReport`(*args)
    - Prepares a string containing a list of integers contained in theError map, but not more than theMaxCount

    Parameters: | theError (Handle_TColStd_HPackedMapOfInteger &) – theMaxCount (int) –
    Return type: | TCollection_ExtendedString

    - Prepares a string containing a list of names contained in theReportSeq sequence, but not more than theMaxCount

    Parameters: | theReportSeq (TColStd_SequenceOfHExtendedString &) – theMaxCount (int) –
    Return type: | TCollection_ExtendedString

  `SendMessages`()
    - Convenient variant of SendStatusMessages() with theFilter having defined all WARN, ALARM, and FAIL (but not DONE) status flags

    Parameters: | theTraceLevel (Message_Gravity) – default value is Message_Warning theMaxCount (int) – default value is 20
    Return type: | None

  `SendStatusMessages`()
    - Print messages for all status flags that have been set during algorithm execution, excluding statuses that are NOT set in theFilter. //! The messages are taken from resource file, names being constructed as {dynamic class type}.{status name}, for instance, ‘Message_Algorithm.Fail5’. If message is not found in resources for this class and all its base types, surrogate text is printed. //! For the statuses having number or string parameters, theMaxCount defines maximal number of numbers or strings to be included in the message //! Note that this method is virtual; this allows descendant classes to customize message output (e.g. by adding messages from other sub-algorithms)

    Parameters: | theFilter (Message_ExecStatus &) – theTraceLevel (Message_Gravity) – default value is Message_Warning theMaxCount (int) – default value is 20
    Return type: | void

  `SetMessenger`()
    - Sets messenger to algorithm

    Parameters: | theMsgr (Handle_Message_Messenger &) –
    Return type: | None

  `SetStatus`()
    - Sets status with no parameter

    Parameters: | theStat (Message_Status &) –
    Return type: | None

    - Sets status with integer parameter

    Parameters: | theStat (Message_Status &) – theInt (int) –
    Return type: | None

    - Sets status with string parameter. If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag

    Parameters: | theStat (Message_Status &) – theStr (char *) – noRepetitions (bool) – default value is Standard_True
    Return type: | None

    - Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag

    Parameters: | theStat (Message_Status &) – theStr (TCollection_AsciiString &) – noRepetitions (bool) – default value is Standard_True
    Return type: | None

    - Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag

    Parameters: | theStat (Message_Status &) – theStr (Handle_TCollection_HAsciiString &) – noRepetitions (bool) – default value is Standard_True
    Return type: | None

    - Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag

    Parameters: | theStat (Message_Status &) – theStr (TCollection_ExtendedString &) – noRepetitions (bool) – default value is Standard_True
    Return type: | None

    - Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag

    Parameters: | theStat (Message_Status &) – theStr (Handle_TCollection_HExtendedString &) – noRepetitions (bool) – default value is Standard_True
    Return type: | None

    - Sets status with preformatted message. This message will be used directly to report the status; automatic generation of status messages will be disabled for it.

    Parameters: | theStat (Message_Status &) – theMsg (Message_Msg &) –
    Return type: | None

  `thisown`

    The membership flag

`Message_Algorithm_PrepareReport`(*args)
  - Prepares a string containing a list of integers contained in theError map, but not more than theMaxCount

  Parameters: | theError (Handle_TColStd_HPackedMapOfInteger &) – theMaxCount (int) –
  Return type: | TCollection_ExtendedString

  - Prepares a string containing a list of names contained in theReportSeq sequence, but not more than theMaxCount

  Parameters: | theReportSeq (TColStd_SequenceOfHExtendedString &) – theMaxCount (int) –
  Return type: | TCollection_ExtendedString

class `Message_ListIteratorOfListOfMsg`(*args)

  Bases: `object`

  Return type: | None
  Parameters: | L (Message_ListOfMsg &) –
  Return type: | None

  `Initialize`()

    Parameters: | L (Message_ListOfMsg &) –
    Return type: | None

  `More`()

    Return type: | bool

  `Next`()

    Return type: | None

  `Value`()

    Return type: | Message_Msg

  `thisown`

    The membership flag

class `Message_ListNodeOfListOfMsg`(*args)

  Bases: `OCC.TCollection.TCollection_MapNode`

  Parameters: | I (Message_Msg &) – n (TCollection_MapNodePtr &) –
  Return type: | None

  `GetHandle`()
  `Value`()

    Return type: | Message_Msg

  `thisown`

    The membership flag

class `Message_ListOfMsg`(*args)

  Bases: `object`

  Return type: | None
  Parameters: | Other (Message_ListOfMsg &) –
  Return type: | None

  `Append`()

    Parameters: | I (Message_Msg &) – I – theIt (Message_ListIteratorOfListOfMsg &) – Other (Message_ListOfMsg &) –
    Return type: | None
    Return type: | None
    Return type: | None

  `Assign`()

    Parameters: | Other (Message_ListOfMsg &) –
    Return type: | None

  `Clear`()

    Return type: | None

  `Extent`()

    Return type: | int

  `First`()

    Return type: | Message_Msg

  `InsertAfter`()

    Parameters: | I (Message_Msg &) – It (Message_ListIteratorOfListOfMsg &) – Other (Message_ListOfMsg &) – It –
    Return type: | None
    Return type: | None

  `InsertBefore`()

    Parameters: | I (Message_Msg &) – It (Message_ListIteratorOfListOfMsg &) – Other (Message_ListOfMsg &) – It –
    Return type: | None
    Return type: | None

  `IsEmpty`()

    Return type: | bool

  `Last`()

    Return type: | Message_Msg

  `Prepend`()

    Parameters: | I (Message_Msg &) – I – theIt (Message_ListIteratorOfListOfMsg &) – Other (Message_ListOfMsg &) –
    Return type: | None
    Return type: | None
    Return type: | None

  `Remove`()

    Parameters: | It (Message_ListIteratorOfListOfMsg &) –
    Return type: | None

  `RemoveFirst`()

    Return type: | None

  `Set`()

    Parameters: | Other (Message_ListOfMsg &) –
    Return type: | None

  `thisown`

    The membership flag

class `Message_Messenger`(*args)

  Bases: `OCC.MMgt.MMgt_TShared`

  - Empty constructor; initializes by single printer directed to cout. Note: the default messenger is not empty but directed to cout in order to protect against possibility to forget defining printers. If printing to cout is not needed, clear messenger by GetPrinters().Clear()

  Return type: | None

  - Create messenger with single printer

  Parameters: | thePrinter (Handle_Message_Printer &) –
  Return type: | None

  `AddPrinter`()
    - Add a printer to the messenger. The printer will be added only if it is not yet in the list. Returns True if printer has been added.

    Parameters: | thePrinter (Handle_Message_Printer &) –
    Return type: | bool

  `ChangePrinters`()
    - Returns sequence of printers The sequence can be modified.

    Return type: | Message_SequenceOfPrinters

  `GetHandle`()
  `Printers`()
    - Returns current sequence of printers

    Return type: | Message_SequenceOfPrinters

  `RemovePrinter`()
    - Removes specified printer from the messenger. Returns True if this printer has been found in the list and removed.

    Parameters: | thePrinter (Handle_Message_Printer &) –
    Return type: | bool

  `RemovePrinters`()
    - Removes printers of specified type (including derived classes) from the messenger. Returns number of removed printers.

    Parameters: | theType (Handle_Standard_Type &) –
    Return type: | int

  `Send`()
    - Dispatch a message to all the printers in the list. Three versions of string representations are accepted for convenience, by default all are converted to ExtendedString. The parameter putEndl specifies whether the new line should be started after this message (default) or not (may have sense in some conditions).

    Parameters: | theString (char *) – theGravity (Message_Gravity) – default value is Message_Warning putEndl (bool) – default value is Standard_True
    Return type: | None

    - See above

    Parameters: | theString (TCollection_AsciiString &) – theGravity (Message_Gravity) – default value is Message_Warning putEndl (bool) – default value is Standard_True
    Return type: | None

    - See above

    Parameters: | theString (TCollection_ExtendedString &) – theGravity (Message_Gravity) – default value is Message_Warning putEndl (bool) – default value is Standard_True
    Return type: | None

  `thisown`

    The membership flag

class `Message_MsgFile`

  Bases: `object`

  static `AddMsg`(*args)
    - Adds new message to the map. Parameter <key> gives the key of the message, <text> defines the message itself. If there already was defined the message identified by the same keyword, it is replaced with the new one.

    Parameters: | key (TCollection_AsciiString &) – text (TCollection_ExtendedString &) –
    Return type: | bool

  static `HasMsg`(*args)
    - Returns True if message with specified keyword is registered

    Parameters: | key (TCollection_AsciiString &) –
    Return type: | bool

  static `Load`(*args)
    - Load message file <theFileName> from directory <theDirName> or its sub-directory

    Parameters: | theDirName (char *) – theFileName (char *) –
    Return type: | bool

  static `LoadFile`(*args)
    - Load the messages from the given file, additive to any previously loaded messages. Messages with same keywords, if already present, are replaced with the new ones.

    Parameters: | theFName (char *) –
    Return type: | bool

  static `LoadFromEnv`(*args)
    - Loads the messages from the file with name (without extension) given by environment variable. Extension of the file name is given separately. If its not defined, it is taken: - by default from environment CSF_LANGUAGE, - if not defined either, as ‘us’.

    Parameters: | envname (char *) – filename (char *) – ext (char *) – default value is
    Return type: | void

  static `Msg`(*args)

    Parameters: | key (char *) –
    Return type: | TCollection_ExtendedString

    - Gives the text for the message identified by the keyword <key> If there are no messages with such keyword defined, the error message is returned. In that case reference to static string is returned, it can be chenged with next call(s) to Msg(). Note: The error message is constructed like ‘Unknown message: <key>’, and can itself be customized by defining message with key Message_Msg_BadKeyword.

    Parameters: | key (TCollection_AsciiString &) –
    Return type: | TCollection_ExtendedString

  `thisown`

    The membership flag

`Message_MsgFile_AddMsg`(*args)
  - Adds new message to the map. Parameter <key> gives the key of the message, <text> defines the message itself. If there already was defined the message identified by the same keyword, it is replaced with the new one.

  Parameters: | key (TCollection_AsciiString &) – text (TCollection_ExtendedString &) –
  Return type: | bool

`Message_MsgFile_HasMsg`(*args)
  - Returns True if message with specified keyword is registered

  Parameters: | key (TCollection_AsciiString &) –
  Return type: | bool

`Message_MsgFile_Load`(*args)
  - Load message file <theFileName> from directory <theDirName> or its sub-directory

  Parameters: | theDirName (char *) – theFileName (char *) –
  Return type: | bool

`Message_MsgFile_LoadFile`(*args)
  - Load the messages from the given file, additive to any previously loaded messages. Messages with same keywords, if already present, are replaced with the new ones.

  Parameters: | theFName (char *) –
  Return type: | bool

`Message_MsgFile_LoadFromEnv`(*args)
  - Loads the messages from the file with name (without extension) given by environment variable. Extension of the file name is given separately. If its not defined, it is taken: - by default from environment CSF_LANGUAGE, - if not defined either, as ‘us’.

  Parameters: | envname (char *) – filename (char *) – ext (char *) – default value is
  Return type: | void

`Message_MsgFile_Msg`(*args)

  Parameters: | key (char *) –
  Return type: | TCollection_ExtendedString

  - Gives the text for the message identified by the keyword <key> If there are no messages with such keyword defined, the error message is returned. In that case reference to static string is returned, it can be chenged with next call(s) to Msg(). Note: The error message is constructed like ‘Unknown message: <key>’, and can itself be customized by defining message with key Message_Msg_BadKeyword.

  Parameters: | key (TCollection_AsciiString &) –
  Return type: | TCollection_ExtendedString

class `Message_Printer`(*args, **kwargs)

  Bases: `OCC.MMgt.MMgt_TShared`

  `GetHandle`()
  `GetTraceLevel`()
    - Return trace level used for filtering messages; messages with lover gravity will be ignored.

    Return type: | Message_Gravity

  `Send`()
    - Send a string message with specified trace level. The parameter theToPutEol specified whether end-of-line should be added to the end of the message. This method must be redefined in descentant.

    Parameters: | theString (TCollection_ExtendedString &) – theGravity (Message_Gravity) – theToPutEol (bool) –
    Return type: | void

    - Send a string message with specified trace level. The parameter theToPutEol specified whether end-of-line should be added to the end of the message. Default implementation calls first method Send().

    Parameters: | theString (char *) – theGravity (Message_Gravity) – theToPutEol (bool) –
    Return type: | void

    - Send a string message with specified trace level. The parameter theToPutEol specified whether end-of-line should be added to the end of the message. Default implementation calls first method Send().

    Parameters: | theString (TCollection_AsciiString &) – theGravity (Message_Gravity) – theToPutEol (bool) –
    Return type: | void

  `SetTraceLevel`()
    - Set trace level used for filtering messages. By default, trace level is Message_Info, so that all messages are output

    Parameters: | theTraceLevel (Message_Gravity) –
    Return type: | None

  `thisown`

    The membership flag

class `Message_PrinterOStream`(*args)

  Bases: `OCC.Message.Message_Printer`

  - Empty constructor, defaulting to cout

  Parameters: | theTraceLevel (Message_Gravity) – default value is Message_Info
  Return type: | None

  - Create printer for output to a specified file. The option theDoAppend specifies whether file should be appended or rewritten. For specific file names (cout, cerr) standard streams are used

  Parameters: | theFileName (char *) – theDoAppend (bool) – theTraceLevel (Message_Gravity) – default value is Message_Info
  Return type: | None

  `Close`()
    - Flushes the output stream and destroys it if it has been specified externally with option doFree (or if it is internal file stream)

    Return type: | None

  `GetHandle`()
  `GetStream`()
    - Returns reference to the output stream

    Return type: | Standard_OStream

  `GetUseUtf8`()
    - Returns option to convert non-Ascii symbols to UTF8 encoding

    Return type: | bool

  `Send`()
    - Puts a message to the current stream if its gravity is equal or greater to the trace level set by SetTraceLevel()

    Parameters: | theString (char *) – theGravity (Message_Gravity) – putEndl (bool) – default value is Standard_True
    Return type: | void

    - Puts a message to the current stream if its gravity is equal or greater to the trace level set by SetTraceLevel()

    Parameters: | theString (TCollection_AsciiString &) – theGravity (Message_Gravity) – putEndl (bool) – default value is Standard_True
    Return type: | void

    - Puts a message to the current stream if its gravity is equal or greater to the trace level set by SetTraceLevel() Non-Ascii symbols are converted to UTF-8 if UseUtf8 option is set, else replaced by symbols ‘?’

    Parameters: | theString (TCollection_ExtendedString &) – theGravity (Message_Gravity) – putEndl (bool) – default value is Standard_True
    Return type: | void

  `SetUseUtf8`()
    - Sets option to convert non-Ascii symbols to UTF8 encoding

    Parameters: | useUtf8 (bool) –
    Return type: | None

  `thisown`

    The membership flag

class `Message_ProgressIndicator`(*args, **kwargs)

  Bases: `OCC.MMgt.MMgt_TShared`

  `EndScope`()
    - Close the current scope and thus return to previous scale Updates position to be at the end of the closing scope Returns False if no scope is opened

    Return type: | bool

  `GetHandle`()
  `GetNbScopes`()
    - Returns current number of opened scopes This number is always >=1 as top-level scale is always present

    Return type: | int

  `GetPosition`()
    - Returns total progress position on the basic scale ranged from 0. to 1.

    Return type: | float

  `GetScale`()
    - Returns all parameters for current scale

    Parameters: | min (float &) – max (float &) – step (float &) – isInf (bool) –
    Return type: | None

  `GetScope`()
    - Returns data for scale of index-th scope The first scope is current one, the last is the top-level one

    Parameters: | index (int) –
    Return type: | Message_ProgressScale

  `GetValue`()
    - Set and get progress value at current scale If the value to be set is more than currently set one, or out of range for the current scale, it is limited by that range

    Return type: | float

  `Increment`()

    Return type: | None

    - Increment the progress value by the default of specified step

    Parameters: | step (float) –
    Return type: | None

  `NewScope`()

    Parameters: | name (char *) – default value is 0 name – span (float) – name – default value is 0
    Return type: | bool
    Return type: | bool
    Return type: | bool

    - Creates new scope on a part of a current scale from current position with span either equal to default step, or specified The scale for the new scope will have specified name and ranged from 0 to 100 with step 1 Returns False if something is wrong in arguments or in current position of progress indicator; scope is opened anyway

    Parameters: | span (float) – name (Handle_TCollection_HAsciiString &) –
    Return type: | bool

  `NextScope`()

    Parameters: | name (char *) – default value is 0
    Return type: | bool

    - Optimized version of { return EndScope() && NewScope(); }

    Parameters: | span (float) – name (char *) – default value is 0
    Return type: | bool

  `Reset`()
    - Drops all scopes and sets scale from 0 to 100, step 1 This scale has name ‘Step’

    Return type: | void

  `SetInfinite`()
    - Set or drop infinite mode for the current scale

    Parameters: | isInf (bool) – default value is Standard_True
    Return type: | None

  `SetName`()

    Parameters: | name (char *) –
    Return type: | None

    - Set (optional) name for scale

    Parameters: | name (Handle_TCollection_HAsciiString &) –
    Return type: | None

  `SetRange`()
    - Set range for current scale

    Parameters: | min (float) – max (float) –
    Return type: | None

  `SetScale`()

    Parameters: | name (char *) – min (float) – max (float) – step (float) – isInf (bool) – default value is Standard_False
    Return type: | None

    - Set all parameters for current scale

    Parameters: | min (float) – max (float) – step (float) – isInf (bool) – default value is Standard_False
    Return type: | None

  `SetStep`()
    - Set step for current scale

    Parameters: | step (float) –
    Return type: | None

  `SetValue`()

    Parameters: | val (float) –
    Return type: | None

  `Show`()
    - Update presentation of the progress indicator Called when progress position is changed Flag force is intended for forcing update in case if it is optimized; all internal calls from ProgressIndicator are done with this flag equal to False

    Parameters: | force (bool) – default value is Standard_True
    Return type: | bool

  `UserBreak`()
    - Should return True if user has send a break signal. Default implementation returns False.

    Return type: | bool

  `thisown`

    The membership flag

class `Message_ProgressScale`(*args)

  Bases: `object`

  - Creates scale ranged from 0 to 100 with step 1

  Return type: | None

  `BaseToLocal`()
    - Convert value from this scale to base one and back

    Parameters: | val (float) –
    Return type: | float

  `GetFirst`()

    Return type: | float

  `GetInfinite`()
    - Gets flag for infinite scale

    Return type: | bool

  `GetLast`()
    - Return information on span occupied by the scale on the base scale

    Return type: | float

  `GetMax`()
    - Gets minimum value of scale

    Return type: | float

  `GetMin`()
    - Gets minimum value of scale

    Return type: | float

  `GetName`()
    - Gets scale name Name may be Null handle if not set

    Return type: | Handle_TCollection_HAsciiString

  `GetStep`()
    - Gets default step

    Return type: | float

  `LocalToBase`()

    Parameters: | val (float) –
    Return type: | float

  `SetInfinite`()
    - Sets flag for infinite scale

    Parameters: | theInfinite (bool) – default value is Standard_True
    Return type: | None

  `SetMax`()
    - Sets minimum value of scale

    Parameters: | theMax (float) –
    Return type: | None

  `SetMin`()
    - Sets minimum value of scale

    Parameters: | theMin (float) –
    Return type: | None

  `SetName`()

    Parameters: | theName (char *) –
    Return type: | None

    - Sets scale name

    Parameters: | theName (Handle_TCollection_HAsciiString &) –
    Return type: | None

  `SetRange`()
    - Set both min and max

    Parameters: | min (float) – max (float) –
    Return type: | None

  `SetScale`()
    - Set all scale parameters

    Parameters: | min (float) – max (float) – step (float) – theInfinite (bool) – default value is Standard_True
    Return type: | None

  `SetSpan`()
    - Defines span occupied by the scale on the basis scale

    Parameters: | first (float) – last (float) –
    Return type: | None

  `SetStep`()
    - Sets default step

    Parameters: | theStep (float) –
    Return type: | None

  `thisown`

    The membership flag

class `Message_ProgressSentry`(*args)

  Bases: `object`

  Parameters: | PI (Handle_Message_ProgressIndicator &) – name (char *) – min (float) – max (float) – step (float) – isInf (bool) – default value is Standard_False newScopeSpan (float) – default value is 0.0
  Return type: | None

  - Creates an instance of ProgressSentry attaching it to the specified ProgressIndicator, selects parameters of the current scale, and opens a new scope with specified span (equal to step by default)

  Parameters: | PI (Handle_Message_ProgressIndicator &) – name (Handle_TCollection_HAsciiString &) – min (float) – max (float) – step (float) – isInf (bool) – default value is Standard_False newScopeSpan (float) – default value is 0.0
  Return type: | None

  `More`()
    - Returns False if ProgressIndicator signals UserBreak

    Return type: | bool

  `Next`()

    Parameters: | name (char *) – default value is 0 span (float) – name – default value is 0
    Return type: | None
    Return type: | None

    - Closes current scope and opens next one with either specified or default span

    Parameters: | span (float) – name (Handle_TCollection_HAsciiString &) –
    Return type: | None

  `Relieve`()
    - Moves progress indicator to the end of the current scale and relieves sentry from its duty. Methods other than Show() will do nothing after this one is called.

    Return type: | None

  `Show`()
    - Forces update of progress indicator display

    Return type: | None

  `thisown`

    The membership flag

class `Message_SequenceNodeOfSequenceOfPrinters`(*args)

  Bases: `OCC.TCollection.TCollection_SeqNode`

  Parameters: | I (Handle_Message_Printer &) – n (TCollection_SeqNodePtr &) – p (TCollection_SeqNodePtr &) –
  Return type: | None

  `GetHandle`()
  `Value`()

    Return type: | Handle_Message_Printer

  `thisown`

    The membership flag

class `Message_SequenceNodeOfSequenceOfProgressScale`(*args)

  Bases: `OCC.TCollection.TCollection_SeqNode`

  Parameters: | I (Message_ProgressScale &) – n (TCollection_SeqNodePtr &) – p (TCollection_SeqNodePtr &) –
  Return type: | None

  `GetHandle`()
  `Value`()

    Return type: | Message_ProgressScale

  `thisown`

    The membership flag

class `Message_SequenceOfPrinters`(*args)

  Bases: `OCC.TCollection.TCollection_BaseSequence`

  Return type: | None
  Parameters: | Other (Message_SequenceOfPrinters &) –
  Return type: | None

  `Append`()

    Parameters: | T (Handle_Message_Printer &) – S (Message_SequenceOfPrinters &) –
    Return type: | None
    Return type: | None

  `Assign`()

    Parameters: | Other (Message_SequenceOfPrinters &) –
    Return type: | Message_SequenceOfPrinters

  `ChangeValue`()

    Parameters: | Index (int) –
    Return type: | Handle_Message_Printer

  `Clear`()

    Return type: | None

  `First`()

    Return type: | Handle_Message_Printer

  `InsertAfter`()

    Parameters: | Index (int) – T (Handle_Message_Printer &) – Index – S (Message_SequenceOfPrinters &) –
    Return type: | None
    Return type: | None

  `InsertBefore`()

    Parameters: | Index (int) – T (Handle_Message_Printer &) – Index – S (Message_SequenceOfPrinters &) –
    Return type: | None
    Return type: | None

  `Last`()

    Return type: | Handle_Message_Printer

  `Prepend`()

    Parameters: | T (Handle_Message_Printer &) – S (Message_SequenceOfPrinters &) –
    Return type: | None
    Return type: | None

  `Remove`()

    Parameters: | Index (int) – FromIndex (int) – ToIndex (int) –
    Return type: | None
    Return type: | None

  `Set`()

    Parameters: | Other (Message_SequenceOfPrinters &) –
    Return type: | Message_SequenceOfPrinters

  `SetValue`()

    Parameters: | Index (int) – I (Handle_Message_Printer &) –
    Return type: | None

  `Split`()

    Parameters: | Index (int) – Sub (Message_SequenceOfPrinters &) –
    Return type: | None

  `Value`()

    Parameters: | Index (int) –
    Return type: | Handle_Message_Printer

  `thisown`

    The membership flag

class `Message_SequenceOfProgressScale`(*args)

  Bases: `OCC.TCollection.TCollection_BaseSequence`

  Return type: | None
  Parameters: | Other (Message_SequenceOfProgressScale &) –
  Return type: | None

  `Append`()

    Parameters: | T (Message_ProgressScale &) – S (Message_SequenceOfProgressScale &) –
    Return type: | None
    Return type: | None

  `Assign`()

    Parameters: | Other (Message_SequenceOfProgressScale &) –
    Return type: | Message_SequenceOfProgressScale

  `ChangeValue`()

    Parameters: | Index (int) –
    Return type: | Message_ProgressScale

  `Clear`()

    Return type: | None

  `First`()

    Return type: | Message_ProgressScale

  `InsertAfter`()

    Parameters: | Index (int) – T (Message_ProgressScale &) – Index – S (Message_SequenceOfProgressScale &) –
    Return type: | None
    Return type: | None

  `InsertBefore`()

    Parameters: | Index (int) – T (Message_ProgressScale &) – Index – S (Message_SequenceOfProgressScale &) –
    Return type: | None
    Return type: | None

  `Last`()

    Return type: | Message_ProgressScale

  `Prepend`()

    Parameters: | T (Message_ProgressScale &) – S (Message_SequenceOfProgressScale &) –
    Return type: | None
    Return type: | None

  `Remove`()

    Parameters: | Index (int) – FromIndex (int) – ToIndex (int) –
    Return type: | None
    Return type: | None

  `Set`()

    Parameters: | Other (Message_SequenceOfProgressScale &) –
    Return type: | Message_SequenceOfProgressScale

  `SetValue`()

    Parameters: | Index (int) – I (Message_ProgressScale &) –
    Return type: | None

  `Split`()

    Parameters: | Index (int) – Sub (Message_SequenceOfProgressScale &) –
    Return type: | None

  `Value`()

    Parameters: | Index (int) –
    Return type: | Message_ProgressScale

  `thisown`

    The membership flag

class `SwigPyIterator`(*args, **kwargs)

  Bases: `object`

  `advance`()
  `copy`()
  `decr`()
  `distance`()
  `equal`()
  `incr`()
  `next`()
  `previous`()
  `thisown`

    The membership flag

  `value`()

class `message`

  Bases: `object`

  `DefaultMessenger`()
    - Defines default messenger for OCCT applications. This is global static instance of the messenger. By default, it contains single printer directed to cout. It can be customized according to the application needs.

    Return type: | Handle_Message_Messenger

  static `FillTime`(*args)
    - Returns the string filled with values of hours, minutes and seconds. Example: 1. (5, 12, 26.3345) returns ‘05h:12m:26.33s’, 2. (0, 6, 34.496 ) returns ‘06m:34.50s’, 3. (0, 0, 4.5 ) returns ‘4.50s’

    Parameters: | Hour (int) – Minute (int) – Second (float) –
    Return type: | TCollection_AsciiString

  `thisown`

    The membership flag

`message_FillTime`(*args)
  - Returns the string filled with values of hours, minutes and seconds. Example: 1. (5, 12, 26.3345) returns ‘05h:12m:26.33s’, 2. (0, 6, 34.496 ) returns ‘06m:34.50s’, 3. (0, 0, 4.5 ) returns ‘4.50s’

  Parameters: | Hour (int) – Minute (int) – Second (float) –
  Return type: | TCollection_AsciiString

`register_handle`(handle, base_object)

  Inserts the handle into the base object to prevent memory corruption in certain cases