As each class has many parameter and functions, this help page splits the class into multiple parts.
Parameter:
Type |
Name |
Description |
* |
* |
|
* |
* |
|
rrString |
userName |
User that submitted the job |
rrString |
submitMachine |
Machine that submitted the job |
bool |
seqDivideEnabled |
|
bool |
disabled |
|
rrString |
jobFilesFolderName |
The name of the folder with all render logs, frame rendered table and preview images. |
int |
localTexturesCount |
|
int |
localTexturesSizeMB |
|
byte |
errorCountServer |
Part of error entries in the job that have been created by the rrServer. |
byte |
errorCount |
Number of error entries in the job. See getError() |
int16 |
logCount |
Number of log entries in the job. See getLog() |
int16 |
infoTotalSend |
Number of times the job was send. |
int16 |
infoTotalCrashed |
Number of times the job crashed. |
int16 |
infoTotalAborted |
Number of times the job was aborted. |
int16 |
infoTotalLimitsReached |
Number of times a limit was reached that called an abort. |
float |
infoAverageClients |
Average number of clients that rendered on the job |
float |
infoAverageClientPS |
|
int |
infoAverageFrameTime |
A simple calculation of the frame time: Seconds rendered / Frames done. |
int |
infoAverageFrameTime_FramesReturned |
Each client gets a chunk of frames to render. Once a chunk was finished, the seconds and number of frames of that chunk are used to calculate an accurate frame time. |
bool |
infoAnalyse_done |
Sequence check has processed the rendered image sequence |
UInt8 |
infoAnalyse_error infoAnalyse_warning infoAnalyse_info |
Number of frames with potential issues found |
int64 |
infoRenderTime_seconds |
Total time the job was rendering. |
int64 |
infoRenderTime_Cost |
Cost of the job. (Each client has a cost/h setting) Note: This information is not reset if you reset the job. |
int64 |
infoRenderTime_CostCloudOnly |
Costs spend in the cloud (if properly setup in rrCloudManager) Note: This information is not reset if you reset the job. |
int64 |
infoRenderTimeSum_seconds |
Collected seconds spend on the job. |
int64 |
infoRenderTimeSum_seconds_FramesReturned |
Collected PS spend on the frame chunks completed by the clients. |
int64 |
infoRenderTimeSum_PS |
Collected PS spend on the job. |
int64 |
infoRenderTimeSum_PS_Preview |
Collected PS spend on the jobs preview render. |
int64 |
infoRenderTimeSum_PS_FramesReturned |
Collected PS spend on the frame chunks completed by the clients. |
float |
infoRenderTimeSum_Ghz_h |
Collected Ghz*h spend on the job. Note: This information is not reset if you reset the job. |
time |
lastSettingsChanged |
Last time settings have been changed. |
time |
lastInfoChanged |
The last time something changed with the job. |
time |
lastErrorEmail |
|
UInt8 |
status |
Status of the job. See enumeration _Status for details. |
time |
timeFinished |
The time the job status changed to finished |
bool |
userApproved |
Has the user approved the job (that small check mark in the rrControl job table) |
bool |
scriptPreviewExecuted |
Was the Preview Script executed (if there was one assigned for the job) |
int64 |
renderTime_remaining_seconds |
Assumption of the remaining time |
int64 |
renderTime_remaining_PS |
Assumption of the remaining PS*seconds required |
int |
framesTotal |
Total number of frames of the job. |
int |
framesLeft |
Frames left |
int |
framesDone |
Number of frames of the jobs sequence that are finished. See framesDoneAfterJobStart and infoTotal_FramesReturned as well. |
int |
framesDoneAfterJobStart |
Number of frames of the jobs sequence that have been finished during the render of the job. |
int |
infoTotal_FramesReturned |
Each client gets a chunk of frames to render. Once a chunk was finished, the frames of the chunk are added to this variable. |
int |
framesTotalNonMulti |
Different to framesTotal if the frames are tiled. This is the number of frames if they would not be tiled. |
int |
framesPlaceholderFound |
1kb placeholder frames that are created when the render of that frame starts. |
int |
framesUnAssignedFoundNr |
|
int |
infoLastFrameDone |
The frame number of the last frame of the sequence before a frame is missing |
int16 |
clientsRenderingCount |
|
int32 |
averageMemoryUsage |
Current average memory usage at all clients rendering. |
UInt16 |
fileserverTimeDifference |
Difference of the OS time between the rrServer and the fileserver with the output images. |
int16 |
fileserverTimeDifferenceOffset |
Same as above, but not as absolute value. |
int |
check_interval |
The time between two "Job Checks" of the rrServer. |
time |
check_lastExecution |
|
int |
check_next_seconds |
|
float |
clientNeed |
Number of clients needed to render all frames now |
bool |
isRendering |
|
int |
queueIDAtServer |
|
UInt16 |
foldersearchtime |
Time the rrServer took to check the output folder for frames |
Class _JobSend functions:
Return type |
Name |
Description |
||||||||||||
* |
* |
|||||||||||||
* |
* |
|||||||||||||
bool |
clientAssigned ( int client_number) |
returns true if the client is assigned for the job. |
||||||||||||
|
clientAssigned_Set( int client_number, bool assigned) |
set the client assignment |
||||||||||||
int |
clientValue_Get( int client_number, int valueID) |
Gets some information about the client regarding the job:
|
||||||||||||
int64 |
fileNumber2jobNumber(double filenumber, qint8 MultiFrameID) |
A job counts frames internally 0,1,2,3,.... no matter which frame start or frame step the job has. This function converts a frame number into the internal job number. If you use tile frame, then you need to set MultiFrameID to the tile you want to access. Otherwise use MultiFrameID=0. |
||||||||||||
double |
jobNumber2fileNumber(int64 jobNumber ) |
A job counts frames internally 0,1,2,3,.... no matter which frame start or frame step the job has. This function converts the internal job number into a frame number. |
||||||||||||
int8 |
jobNumber2multiID(int64 jobNumber ) |
A job counts frames internally 0,1,2,3,.... no matter which frame start or frame step the job has. If you use tile frame, this function converts the internal job number into the tile ID. Otherwise it always returns 0. |
||||||||||||
int |
previewID2FrameNr(int id) |
returns the frame number of preview frame with id. There are maximal previewNumberOfFrames. |
||||||||||||
QString |
previewFilenameThumbnail(int id) |
returns the file name of the preview - thumbnail version |
||||||||||||
QString |
previewFilenameRGB(int id) |
returns the file name of the preview - full size RGB version |
||||||||||||
QString |
previewFilenameA(int id) |
returns the file name of the preview - full size Alpha version |
||||||||||||
getError(int index) |
Get the error entry at index. There are max ".errorCount" errors in the current job. |
|||||||||||||
getLog(int index) |
Get the log entry at index. There are max ".logCount" log entries in the current job. |
|||||||||||||
QString |
replaceJobVariables(QString text, bool KeepImageVariables) |
Replaces job variables in the input string text. If KeepImageVariables is false, then the resulting string does not contain any <variable> any more, even unknown variables are replaced by the variable name. If KeepImageVariables is true, some variables are kept: <Channel>, <ImageStereo...>, <Layer>. |
||||||||||||
QString |
statusAsString() |
The status of the job as human readable string. |
||||||||||||
QString |
jobFilesFolderName_Resolved() |
If executed from within an RR application, then it returns the full path of the job files folder. |