## On this page

  

 

 # ensightservice::AnimQueryProgressReply Struct Reference

 Last update: 16.07.2025 

## <a id="pub-types" name="pub-types"></a>Public Types

enum [Status](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3) {   
 [IN\_PROGRESS](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3a8d5bd7ab98f75ad9075c688fed50b624) = 0 , [COMPLETE](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3ad4088e7f9222e0c7c7dac02ebf67e633) = 1 , [CANCEL\_REQUESTED](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3a0f42169fcc38699ccba3da0020ca89ad) = 2 , [CANCELLED](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3a61f072e6d795f6d19ae9478520aee776) = 3 ,   
 [WRITE\_ERROR](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3a833167b5ad8686ad147784dff9cb4256) = 4   
 } ## <a id="pub-attribs" name="pub-attribs"></a>Public Attributes

string [id](structensightservice_1_1_anim_query_progress_reply.xhtml#af63f10e954b89055deca8728fb274c83) = 1 uint32 [num\_frames\_finished](structensightservice_1_1_anim_query_progress_reply.xhtml#aaa25eee1d9e5f2b5358ed71d9098f870) = 2 uint32 [num\_frames](structensightservice_1_1_anim_query_progress_reply.xhtml#a25531173d585182fd80d864580b8b89b) = 3 [Status](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3) [status](structensightservice_1_1_anim_query_progress_reply.xhtml#a4d9e6cf495beafbed3f444a673e14820) = 4 string [error\_msg](structensightservice_1_1_anim_query_progress_reply.xhtml#af59568db7fe2d5d8a358af9a9d2973fd) = 5 <a id="details" name="details"></a>## Detailed Description

Reply to query of animation progress

Definition at line [281](ensight_8proto_source.xhtml#l00281) of file [ensight.proto](ensight_8proto_source.xhtml).



## Member Enumeration Documentation

<a id="acf97ca8571bba823e4a3449a749fa7d3" name="acf97ca8571bba823e4a3449a749fa7d3"></a>## [◆ ](#acf97ca8571bba823e4a3449a749fa7d3)Status

 enum [ensightservice::AnimQueryProgressReply::Status](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3)

The current status of the animation rendering operation.

Enumerator<a id="acf97ca8571bba823e4a3449a749fa7d3a8d5bd7ab98f75ad9075c688fed50b624" name="acf97ca8571bba823e4a3449a749fa7d3a8d5bd7ab98f75ad9075c688fed50b624"></a>IN\_PROGRESS Saving.

<a id="acf97ca8571bba823e4a3449a749fa7d3ad4088e7f9222e0c7c7dac02ebf67e633" name="acf97ca8571bba823e4a3449a749fa7d3ad4088e7f9222e0c7c7dac02ebf67e633"></a>COMPLETE Successfully completed.

<a id="acf97ca8571bba823e4a3449a749fa7d3a0f42169fcc38699ccba3da0020ca89ad" name="acf97ca8571bba823e4a3449a749fa7d3a0f42169fcc38699ccba3da0020ca89ad"></a>CANCEL\_REQUESTED Cancellation requested, but not yet cancelled.

<a id="acf97ca8571bba823e4a3449a749fa7d3a61f072e6d795f6d19ae9478520aee776" name="acf97ca8571bba823e4a3449a749fa7d3a61f072e6d795f6d19ae9478520aee776"></a>CANCELLED Cancellation completed.

<a id="acf97ca8571bba823e4a3449a749fa7d3a833167b5ad8686ad147784dff9cb4256" name="acf97ca8571bba823e4a3449a749fa7d3a833167b5ad8686ad147784dff9cb4256"></a>WRITE\_ERROR Animation could not be saved - file not writable, output size too big, ...

Definition at line [284](ensight_8proto_source.xhtml#l00284) of file [ensight.proto](ensight_8proto_source.xhtml).





## Member Data Documentation

<a id="af59568db7fe2d5d8a358af9a9d2973fd" name="af59568db7fe2d5d8a358af9a9d2973fd"></a>## [◆ ](#af59568db7fe2d5d8a358af9a9d2973fd)error\_msg

 string ensightservice::AnimQueryProgressReply::error\_msg = 5

If the status==WRITE\_ERROR, the error message.

Definition at line [295](ensight_8proto_source.xhtml#l00295) of file [ensight.proto](ensight_8proto_source.xhtml).





<a id="af63f10e954b89055deca8728fb274c83" name="af63f10e954b89055deca8728fb274c83"></a>## [◆ ](#af63f10e954b89055deca8728fb274c83)id

 string ensightservice::AnimQueryProgressReply::id = 1

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

Definition at line [291](ensight_8proto_source.xhtml#l00291) of file [ensight.proto](ensight_8proto_source.xhtml).





<a id="a25531173d585182fd80d864580b8b89b" name="a25531173d585182fd80d864580b8b89b"></a>## [◆ ](#a25531173d585182fd80d864580b8b89b)num\_frames

 uint32 ensightservice::AnimQueryProgressReply::num\_frames = 3

Same as num\_frames in request, unless num\_frames in request == -1.

Definition at line [293](ensight_8proto_source.xhtml#l00293) of file [ensight.proto](ensight_8proto_source.xhtml).





<a id="aaa25eee1d9e5f2b5358ed71d9098f870" name="aaa25eee1d9e5f2b5358ed71d9098f870"></a>## [◆ ](#aaa25eee1d9e5f2b5358ed71d9098f870)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](ensight_8proto_source.xhtml#l00292) of file [ensight.proto](ensight_8proto_source.xhtml).





<a id="a4d9e6cf495beafbed3f444a673e14820" name="a4d9e6cf495beafbed3f444a673e14820"></a>## [◆ ](#a4d9e6cf495beafbed3f444a673e14820)status

 [Status](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3) 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](ensight_8proto_source.xhtml#l00294) of file [ensight.proto](ensight_8proto_source.xhtml).





---

The documentation for this struct was generated from the following file:- D:/Product-src/ensight/client/rpc\_interface/[ensight.proto](ensight_8proto_source.xhtml)