Skip to main content

Post-processing tools 2024 R1

ensightservice::AnimQueryProgressReply Struct Reference

Last update: 16.07.2025

Public Types

enum  Status {
  IN_PROGRESS = 0 , COMPLETE = 1 , CANCEL_REQUESTED = 2 , CANCELLED = 3 ,
  WRITE_ERROR = 4
}
 

Public Attributes

string id = 1
 
uint32 num_frames_finished = 2
 
uint32 num_frames = 3
 
Status status = 4
 
string error_msg = 5
 

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.

Member Data Documentation

◆ error_msg

string ensightservice::AnimQueryProgressReply::error_msg = 5

If the status==WRITE_ERROR, the error message.

Definition at line 295 of file ensight.proto.

◆ id

string ensightservice::AnimQueryProgressReply::id = 1

Handle for the save operation, same as in the request.

Definition at line 291 of file ensight.proto.

◆ num_frames

uint32 ensightservice::AnimQueryProgressReply::num_frames = 3

Same as num_frames in request, unless num_frames in request == -1.

Definition at line 293 of file ensight.proto.

◆ num_frames_finished

uint32 ensightservice::AnimQueryProgressReply::num_frames_finished = 2

Is 0 at first, will be equal to num_frames when finished.

Definition at line 292 of file ensight.proto.

◆ status

Status ensightservice::AnimQueryProgressReply::status = 4

If 'cancel' is True in the request, but the anim had already completed or errored out, returned status is COMPLETE or ERROR.

Definition at line 294 of file ensight.proto.


The documentation for this struct was generated from the following file:

Connect with Ansys