Functions

Parent Previous Next


void debugEnable() 
void debugDisable()




Description:

Enable or disable the debug mode for log messages.

If enabled, debug messages are shown. 



 bool isConsoleRun()


Description:

If the application executing this script is a console application, this function returns true. 

If it is an UI (User Interface) application, it returns false.



_pythonGenericUI getGenericUI()



Description:

Returns a new _pythonGenericUI class. 




_rrPython_CrossBatch getCrossBatch()



Description:

Returns a new _rrPython_CrossBatch class. 





void writeLog2(logLvL rrLog_level, PyObject* message)



Parameters:


logLvL rrLog_level

Log levels, see help section Enumeration logLvl

PyObject* message

The message itself.

message can be string, unicode, integer or float


Description:

Writes an message to the RR log file/log window. 





DEPRECATED - void writeLog(logLvL rrLog_level, PyObject* message, PyObject* location) - DEPRECATED



Parameters:


logLvL rrLog_level

Log levels, see help section Enumeration logLvl

PyObject* message

The message itself.

message can be string, unicode, integer or float

PyObject* location

 - not used any more - kept for compability


Description:

Writes an information to the RR log file/window. 





int messageBox(int rrLog_level, PyObject* msg, PyObject* btn1, PyObject* btn2, bool showCancel, int waitTime )




Parameters:


logLvL rrLog_level

Log levels, see help section Enumeration logLvl

info will display a question dialog and progress and default dialog.

debug will display a message box no matter if the application is running is debug mode or not 

PyObject* msg

error_msg can be string, unicode, integer or float

PyObject* btn1

Label on the first button. (string, unicode, integer or float)

PyObject* btn2

Optional: Label on the second button. If an empty string is set, the button is not shown. (string, unicode, integer or float)

bool showCancel

If true, the message box displays a cancel button. And it is able to return -1.

int waitTime

Countdown how long the message box should be displayed.

An artist who left the workstation should not always be responsible that the script cannot continue.


Description:

Displays a message box for the user. (rrClient and rrServer will not display any message box)

It also writes the text into the RR log file/window.


Return Value:


1

Button 1 was clicked.

0

  • showCancel true:

      Button 2 was clicked.

  • showCancel false:

      Button 2 was clicked OR dialog was closed. 

-1

showCancel true:

"cancel" was clicked or dialog was closed.





void progress_Show()
void progress_Hide()


Part of the progress bar.


Description:

Shows/Hides the progress dialog.


void  progress_HideA() 
void progress_HideB()


Part of the progress bar.


Description:

Hides the first/second progress bar.

If you assign a value to the progress bar, it is shown again.


bool progress_CancelPressed()


Part of the progress bar.


Return Value:

If the cancel button was pressed, then this function returns true.

NOTE: The cancel status is kept for all jobs executed during a perJob script execution. 


void progress_CancelReset()


Part of the progress bar.


Description:

Resets the CancelPressed status to False.



void  progress_CancelShow() 
void progress_CancelHide()


Part of the progress bar.


Description:

Show/hide the cancel button.


void progress_SetInfo( PyObject* text)


Part of the progress bar.


Parameters:

text        The text to be shown (string, unicode, integer or float)



Description:

Shows an information label on the dialog.



void progress_SetMaxA(int maxValue)
void progress_SetMaxB(int maxValue)


Part of the progress bar.


Parameters:

maxValue        the new maximum value



Description:

Sets the maximum value for the first/second progress bar.



void progress_SetProgressA(int value)
void progress_SetProgressB(int value)


Part of the progress bar.


Parameters:

value        The current value of the progress



Description:

Sets the current value for the first/second progress bar.



void progress_SetProgressLabelA( int value, PyObject * label)


Part of the progress bar.


Parameters:


value

The current value of the progress

label

The text to be shown (string, unicode, integer or float)


Description:

Sets the current value for the first/second progress bar.

As well as a text inside the progress bar. 



void refreshUI()



Description:

While python functions are running, the process (rrControl, rrSubmitter) is not able to refresh the UI ( The main ui as well as e.g. the python progress bar).

You probably know this from freezed applications, they do not redraw the UI.

And after some time windows reports that the application might have freezed.

Calling this function gives the UI some time to redraw if necessary. 


rrString rrBinPath()



Description:

Returns the [RR]/bin/os/ path for the current OS.




rrString rrRootPath()



Description:

Returns the root path of the share RR folder.




rrString rrServer()



Description:

Returns the rrServer name or IP.

Can be used for TCP connections to the rrServer