Skip to main content

Post-processing tools 2023 R2

ensightservice::AnimQueryProgressReply Struct Reference

Last update: 17.04.2023

Public Types

enum  Status {
  IN_PROGRESS = 0 , COMPLETE = 1 , CANCEL_REQUESTED = 2 , CANCELLED = 3 ,
  WRITE_ERROR = 4
}
 The current status of the animation rendering operation. More...
 

Public Attributes

string id = 1
 Handle for the save operation, same as in the request.
 
uint32 num_frames_finished = 2
 Is 0 at first, will be equal to num_frames when finished.
 
uint32 num_frames = 3
 Same as num_frames in request, unless num_frames in request == -1.
 
Status status = 4
 If 'cancel' is True in the request, but the anim had already completed or errored out, returned status is COMPLETE or ERROR.
 
string error_msg = 5
 If the status==WRITE_ERROR, the error message.
 

Detailed Description

Reply to query of animation progress

Definition at line 281 of file ensight.proto.

Member Enumeration Documentation

◆ Status

The current status of the animation rendering operation.

Enumerator
IN_PROGRESS 

Saving.

COMPLETE 

Successfully completed.

CANCEL_REQUESTED 

Cancellation requested, but not yet cancelled.

CANCELLED 

Cancellation completed.

WRITE_ERROR 

Animation could not be saved - file not writable, output size too big, ...

Definition at line 284 of file ensight.proto.


The documentation for this struct was generated from the following file:
  • D:/ANSYSDev/NoBackup/branches/EnSight-Second-Coming/ensight/client/rpc_interface/ensight.proto