Functions | |
| INTEGER FUNCTION | ParameterCalculateStringLength (str_Message :TC255) INTEGER |
| Return the length of the longest parameter in the str_Message. | |
| PROCEDURE | ParameterCreateBitmapGO () |
| Load a bitmap in the panel depending with name of post-processor. | |
| PROCEDURE | ParameterCreateBitmapNC () |
| Load a bitmap in the panel depending with name of post-processor. | |
| PROCEDURE | ParameterCreateBoolean (int_Format :INTEGER, int_GlobalInc, int_MessageNum, int_Default :INTEGER, VAR int_Line :INTEGER, int_Column :INTEGER, VAR str_Message :TC255) |
| Create a field to store a boolean value. | |
| PROCEDURE | ParameterCreateCheck (int_GlobalInc, int_MessageNum, int_Default :INTEGER, VAR int_Line :INTEGER, int_Column :INTEGER, VAR str_Message:TC255) |
| Create a field to store an integer value from a checkbox. | |
| PROCEDURE | ParameterCreateComment (int_MessageNum :INTEGER, VAR int_Line :INTEGER, int_Column, int_CharNb :INTEGER, VAR str_Message :TC255) |
| Create a field to store a comment. | |
| PROCEDURE | ParameterCreateFrame (int_MessageNum, int_LineBegin, int_ColumnBegin, int_NbLine, int_NbColumn :INTEGER, VAR str_Message :TC255) |
| Create a new frame will be contain informations. | |
| PROCEDURE | ParameterCreateInteger (int_GlobalInc, int_MessageNum, int_Default :INTEGER, VAR int_Line :INTEGER, int_Column :INTEGER, VAR str_Message:TC255) |
| Create a field to store an integr value. | |
| PROCEDURE | ParameterCreateList (int_GlobalInc, int_MessageNum, int_Default :INTEGER, VAR int_Line :INTEGER, int_Column :INTEGER, VAR str_Message :TC255) |
| Create a field to store an integer value from a list. | |
| PROCEDURE | ParameterCreatePage (int_MessageNum :INTEGER, str_Message :TC255) |
| Create a new page in the panel. | |
| PROCEDURE | ParameterCreateReal (int_GlobalInc, int_MessageNum :INTEGER, real_Default :REAL, VAR int_Line :INTEGER, int_Column :INTEGER, VAR str_Message:TC255) |
| Create a field to store a real value. | |
| PROCEDURE | ParameterCreateRealFormat (int_GlobalInc, int_MessageNum :INTEGER, real_Default :REAL, VAR int_Line :INTEGER, int_Column :INTEGER, VAR str_Message:TC255, int_FormatReal :INTEGER) |
| Create a field to store a real value. The field will can be typed as length or angle. | |
| PROCEDURE | ParameterCreateString (int_GlobalInc, int_MessageNum :INTEGER, str_Default :TC255, VAR int_Line :INTEGER, int_Column, int_CharNb :INTEGER, VAR str_Message :TC255) |
| Create a field to store a string parameter. | |
| PROCEDURE | ParameterCreateStringIgnore (int_GlobalInc, int_MessageNum :INTEGER, str_Default :TC255, VAR int_Line :INTEGER, int_Column, int_CharNb :INTEGER, VAR Str_Message :TC255) |
| Create a field to store a string parameter and ignore the value stored in the .USR. | |
| PROCEDURE | ParameterHelp () |
| Open a help file. | |
| PROCEDURE | ParameterHelpPPStd () |
| PROCEDURE | ParameterHelpPPstdUpdate () |
| PROCEDURE | ParameterReadBoolean (int_Ident :INTEGER, VAR int_Val :INTEGER) |
| Read a boolean value from a panel. | |
| PROCEDURE | ParameterReadInteger (int_Ident :INTEGER, VAR int_Val :INTEGER) |
| Read a integer value from a panel. | |
| PROCEDURE | ParameterReadLabel (int_Ident :INTEGER, VAR str_Label :TC255, str_Type :TC255) |
| Build the key to read a value in a panel. | |
| PROCEDURE | ParameterReadLabelBoolean (int_Ident :INTEGER, VAR str_Label :TC255) |
| Build the key to read a boolean value in a panel. | |
| PROCEDURE | ParameterReadLabelInteger (int_Ident :INTEGER, VAR str_Label :TC255) |
| Build the key to read an integer value in a panel. | |
| PROCEDURE | ParameterReadLabelReal (int_Ident :INTEGER, VAR str_Label :TC255) |
| Build the key to read a real value in a panel. | |
| PROCEDURE | ParameterReadLabelString (int_Ident :INTEGER, VAR str_Label :TC255) |
| Build the key to read a string value in a panel. | |
| PROCEDURE | ParameterReadList (int_Ident :INTEGER, VAR int_Val :INTEGER) |
| Read a integer value from a list in a panel. | |
| INTEGER FUNCTION | ParameterReadMessageCategory () INTEGER |
| Get the number of the category to read a message. | |
| PROCEDURE | ParameterReadReal (int_Ident :INTEGER, VAR real_Val :REAL) |
| Read a real value from a panel. | |
| PROCEDURE | ParameterReadString (int_Ident :INTEGER, VAR str_Val :TC255) |
| Read a string value from a panel. | |
| PROCEDURE | ParameterUpdateCheck () |
| Does the treatment to update modified value in the panel. | |
| PROCEDURE | ParameterUpdateLabelBoolean (int_Ident, int_Mode, int_Val :INTEGER) |
| Write a value in a boolean parameter. | |
| PROCEDURE | ParameterUpdateLabelInteger (int_Ident, int_Mode, int_Val :INTEGER) |
| Write a value in a integer parameter. | |
| PROCEDURE | ParameterUpdateLabelList (int_Ident, int_Mode, int_Val :INTEGER) |
| Write a value in a list parameter. | |
| PROCEDURE | ParameterUpdateLabelReal (int_Ident, int_Mode :INTEGER, real_Val :REAL) |
| Write a value in a real parameter. | |
| PROCEDURE | ParameterUpdateLabelString (int_Ident, int_Mode :INTEGER, str_Val :TC255) |
| Write a value in a string parameter. | |
| PROCEDURE | ParameterValidate () |
| Valid the parameter when Parameter_Update is called by GPP. | |
| PROCEDURE | ParameterVersionPP () |
| Write the post processor version in the title of frame The post processor version is read in the GPP. | |
| PROCEDURE | ReadMessage (int_MessageNum :INTEGER, VAR str_Message :TC255,) |
| Read a message to display in the panel. | |
| PROCEDURE | ReadMessageSpe (int_Number :INTEGER, VAR str_Text :TC255) |
| Read a message in a specific file name as the pp with '.dico' extension. | |
| PROCEDURE | StoreGlobalBoolean (int_GlobalInc :INTEGER) |
| Store a boolean value in the memory. | |
| PROCEDURE | StoreGlobalInteger (int_GlobalInc :INTEGER) |
| Store a integer value in the memory. | |
| PROCEDURE | StoreGlobalList (int_GlobalInc :INTEGER) |
| Store a integer value from list in the memory. | |
| PROCEDURE | StoreGlobalReal (int_GlobalInc :INTEGER) |
| Store a integer value from list in the memory. | |
| PROCEDURE | StoreGlobalString (int_GlobalInc :INTEGER) |
| Store a integer value from list in the memory. | |
Procedure to display field and stored data to be used in post-processor
| INTEGER FUNCTION ParameterCalculateStringLength | ( | str_Message :TC255 | ) |
Return the length of the longest parameter in the str_Message.
A parameter string like 'My string-Yes-No' is sended
The function returns the length of Yes because it was the longest word in the choices
| [in] | str_Message | : string inside check |
| PROCEDURE ParameterCreateBitmapGO | ( | ) |
Load a bitmap in the panel depending with name of post-processor.
| PROCEDURE ParameterCreateBitmapNC | ( | ) |
Load a bitmap in the panel depending with name of post-processor.
| PROCEDURE ParameterCreateBoolean | ( | int_Format :INTEGER | , |
| int_GlobalInc | , | ||
| int_MessageNum | , | ||
| int_Default :INTEGER | , | ||
| VAR int_Line :INTEGER | , | ||
| int_Column :INTEGER | , | ||
| VAR str_Message :TC255 | ) |
Create a field to store a boolean value.
At the end of procedure the int_Line is auto increment
| [in] | int_GlobalInc | : Id of the string parameter |
| [in] | int_MessageNum | : number of the message read in MSG_PROC.DAT |
| [in] | int_Default | : default value show in the field |
| [in] | int_Line | : Line where the field will be inserted |
| [in] | int_Column | : Column wher the field will be inserted |
| [in] | int_CharNb | : width of the field in number of characters |
| [in] | str_Message | : message to be use if int_MessageNum doesn't exist |
| PROCEDURE ParameterCreateCheck | ( | int_GlobalInc | , |
| int_MessageNum | , | ||
| int_Default :INTEGER | , | ||
| VAR int_Line :INTEGER | , | ||
| int_Column :INTEGER | , | ||
| VAR str_Message:TC255 | ) |
Create a field to store an integer value from a checkbox.
At the end of procedure the int_Line is auto increment
| [in] | int_GlobalInc | : Id of the string parameter |
| [in] | int_MessageNum | : number of the message read in MSG_PROC.DAT |
| [in] | int_Default | : default value show in the field |
| [in] | int_Line | : Line where the field will be inserted |
| [in] | int_Column | : Column wher the field will be inserted |
| [in] | str_Message | : message to be use if int_MessageNum doesn't exist |
| PROCEDURE ParameterCreateComment | ( | int_MessageNum :INTEGER | , |
| VAR int_Line :INTEGER | , | ||
| int_Column | , | ||
| int_CharNb :INTEGER | , | ||
| VAR str_Message :TC255 | ) |
Create a field to store a comment.
At the end of procedure the int_Line is auto incremented
| [in] | int_MessageNum | : number of the message read in MSG_PROC.DAT |
| [in] | int_Line | : Line where the field will be inserted |
| [in] | int_Column | : Column wher the field will be inserted |
| [in] | int_CharNb | : width of the field in number of characters |
| [in] | str_Message | : message to be use if int_MessageNum doesn't exist |
| PROCEDURE ParameterCreateFrame | ( | int_MessageNum | , |
| int_LineBegin | , | ||
| int_ColumnBegin | , | ||
| int_NbLine | , | ||
| int_NbColumn :INTEGER | , | ||
| VAR str_Message :TC255 | ) |
Create a new frame will be contain informations.
| [in] | int_MessageNum | : Number of the message stored in MSG_PROC.DAT |
| [in] | int_LineBegin | : Line position for the frame in the Page |
| [in] | int_ColumnBegin | : Column position for the frame in the page |
| [in] | int_NbLine | : Number of lines in the frame |
| [in] | int_NbColumn | : Number of columns in the frame |
| [in] | str_Message | : Message used if the int_MessageNum doesn't exist |
| PROCEDURE ParameterCreateInteger | ( | int_GlobalInc | , |
| int_MessageNum | , | ||
| int_Default :INTEGER | , | ||
| VAR int_Line :INTEGER | , | ||
| int_Column :INTEGER | , | ||
| VAR str_Message:TC255 | ) |
Create a field to store an integr value.
At the end of procedure the int_Line is auto increment
| [in] | int_GlobalInc | : Id of the string parameter |
| [in] | int_MessageNum | : number of the message read in MSG_PROC.DAT |
| [in] | int_Default | : default value show in the field |
| [in] | int_Line | : Line where the field will be inserted |
| [in] | int_Column | : Column wher the field will be inserted |
| [in] | str_Message | : message to be use if int_MessageNum doesn't exist |
| PROCEDURE ParameterCreateList | ( | int_GlobalInc | , |
| int_MessageNum | , | ||
| int_Default :INTEGER | , | ||
| VAR int_Line :INTEGER | , | ||
| int_Column :INTEGER | , | ||
| VAR str_Message :TC255 | ) |
Create a field to store an integer value from a list.
The list is created from Message. Each choice begin by minus sign and is positioned after the message.
ex : 'MyList-First-Second'
We will create MyList with two choices "First" and "Second"
At the end of procedure the int_Line is auto increment
| [in] | int_GlobalInc | : Id of the string parameter |
| [in] | int_MessageNum | : number of the message read in MSG_PROC.DAT |
| [in] | real_Default | : default value show in the field |
| [in] | int_Line | : Line where the field will be inserted |
| [in] | int_Column | : Column wher the field will be inserted |
| [in] | str_Message | : message to be use if int_MessageNum doesn't exist |
| PROCEDURE ParameterCreatePage | ( | int_MessageNum :INTEGER | , |
| str_Message :TC255 | ) |
Create a new page in the panel.
| [in] | int_MessageNum | : Number of message to search in MSG_PROC.DAT |
| [in] | str_Message | : Default message to use if int_MessageNum doesn't exist |
| PROCEDURE ParameterCreateReal | ( | int_GlobalInc | , |
| int_MessageNum :INTEGER | , | ||
| real_Default :REAL | , | ||
| VAR int_Line :INTEGER | , | ||
| int_Column :INTEGER | , | ||
| VAR str_Message:TC255 | ) |
Create a field to store a real value.
At the end of procedure the int_Line is auto increment
| [in] | int_GlobalInc | : Id of the string parameter |
| [in] | int_MessageNum | : number of the message read in MSG_PROC.DAT |
| [in] | real_Default | : default value show in the field |
| [in] | int_Line | : Line where the field will be inserted |
| [in] | int_Column | : Column wher the field will be inserted |
| [in] | int_CharNb | : width of the field in number of characters |
| [in] | str_Message | : message to be use if int_MessageNum doesn't exist |
| PROCEDURE ParameterCreateRealFormat | ( | int_GlobalInc | , |
| int_MessageNum :INTEGER | , | ||
| real_Default :REAL | , | ||
| VAR int_Line :INTEGER | , | ||
| int_Column :INTEGER | , | ||
| VAR str_Message:TC255 | , | ||
| int_FormatReal :INTEGER | ) |
Create a field to store a real value. The field will can be typed as length or angle.
At the end of procedure the int_Line is auto increment
| [in] | int_GlobalInc | : Id of the string parameter |
| [in] | int_MessageNum | : number of the message read in MSG_PROC.DAT |
| [in] | real_Default | : default value show in the field |
| [in] | int_Line | : Line where the field will be inserted |
| [in] | int_Column | : Column wher the field will be inserted |
| [in] | int_CharNb | : width of the field in number of characters |
| [in] | str_Message | : message to be use if int_MessageNum doesn't exist |
| [in] | int_FormatReal | : kind of real of the field SPI_FORMAT_REAL_ANGLE : the value is an angle SPI_FORMAT_REAL_DISTANCE or SPI_FORMAT_REAL_DBL_DISTANCE : the value is a distance (inch, mm, ...) no unit otherwise |
| PROCEDURE ParameterCreateString | ( | int_GlobalInc | , |
| int_MessageNum :INTEGER | , | ||
| str_Default :TC255 | , | ||
| VAR int_Line :INTEGER | , | ||
| int_Column | , | ||
| int_CharNb :INTEGER | , | ||
| VAR str_Message :TC255 | ) |
Create a field to store a string parameter.
At the end of procedure the int_Line is auto incremented
| [in] | int_GlobalInc | : Id of the string parameter will be stored |
| [in] | int_MessageNum | : number of the message read in MSG_PROC.DAT |
| [in] | str_Default | : default value show int the string field |
| [in] | int_Line | : Line where the field will be inserted |
| [in] | int_Column | : Column where the field will be inserted |
| [in] | int_CharNb | : width of the field in number of characters |
| [in] | str_Message | : message to be use if int_MessageNum doesn't exist |
| PROCEDURE ParameterCreateStringIgnore | ( | int_GlobalInc | , |
| int_MessageNum :INTEGER | , | ||
| str_Default :TC255 | , | ||
| VAR int_Line :INTEGER | , | ||
| int_Column | , | ||
| int_CharNb :INTEGER | , | ||
| VAR Str_Message :TC255 | ) |
Create a field to store a string parameter and ignore the value stored in the .USR.
At the end of procedure the int_Line is auto incremented
| [in] | int_GlobalInc | : Id of the string parameter will be stored |
| [in] | int_MessageNum | : number of the message read in MSG_PROC.DAT |
| [in] | str_Default | : default value show int the string field |
| [in] | int_Line | : Line where the field will be inserted |
| [in] | int_Column | : Column where the field will be inserted |
| [in] | int_CharNb | : width of the field in number of characters |
| [in] | str_Message | : message to be use if int_MessageNum doesn't exist |
| PROCEDURE ParameterHelp | ( | ) |
Open a help file.
The filed to open is named like the post-processor following with
_GO.pdf or _GO.docx or _GO.doc or _GO.html or _GO.txt if the button is named BMP_GO
_NC.pdf or _NC.docx or _NC.doc or _NC.html or _NC.txt if the button is named BMP_NC
| PROCEDURE ParameterReadBoolean | ( | int_Ident :INTEGER | , |
| VAR int_Val :INTEGER | ) |
Read a boolean value from a panel.
| [in] | int_Ident | : the identification number of the readed value |
| [out] | int_Val | : the readed value |
| PROCEDURE ParameterReadInteger | ( | int_Ident :INTEGER | , |
| VAR int_Val :INTEGER | ) |
Read a integer value from a panel.
| [in] | int_Ident | : the identification number of the readed value |
| [out] | int_Val | : the readed value |
| PROCEDURE ParameterReadLabel | ( | int_Ident :INTEGER | , |
| VAR str_Label :TC255 | , | ||
| str_Type :TC255 | ) |
Build the key to read a value in a panel.
| [in] | int_Ident | : identifier of the parameter |
| [out] | str_label | : reading Label name |
| [out] | str_Type | : letter that define the kind of variable read |
| PROCEDURE ParameterReadLabelBoolean | ( | int_Ident :INTEGER | , |
| VAR str_Label :TC255 | ) |
Build the key to read a boolean value in a panel.
| [in] | int_Ident | : identifier of the parameter |
| [out] | str_label | : reading Label name |
| PROCEDURE ParameterReadLabelInteger | ( | int_Ident :INTEGER | , |
| VAR str_Label :TC255 | ) |
Build the key to read an integer value in a panel.
| [in] | int_Ident | : identifier of the parameter |
| [out] | str_label | : reading Label name |
| PROCEDURE ParameterReadLabelReal | ( | int_Ident :INTEGER | , |
| VAR str_Label :TC255 | ) |
Build the key to read a real value in a panel.
| [in] | int_Ident | : identifier of the parameter |
| [out] | str_label | : reading Label name |
| PROCEDURE ParameterReadLabelString | ( | int_Ident :INTEGER | , |
| VAR str_Label :TC255 | ) |
Build the key to read a string value in a panel.
| [in] | int_Ident | : identifier of the parameter |
| [out] | str_label | : reading Label name |
| PROCEDURE ParameterReadList | ( | int_Ident :INTEGER | , |
| VAR int_Val :INTEGER | ) |
Read a integer value from a list in a panel.
| [in] | int_Ident | : the identification number of the readed value |
| [out] | int_Val | : the readed value |
| INTEGER FUNCTION ParameterReadMessageCategory | ( | ) |
Get the number of the category to read a message.
The number returned depends of the technology selected in GO2cam
The message are stored in the file MSG_PROC.DAT depending of selected language in GO2cam
| PROCEDURE ParameterReadReal | ( | int_Ident :INTEGER | , |
| VAR real_Val :REAL | ) |
Read a real value from a panel.
| [in] | int_Ident | : the identification number of the readed value |
| [out] | real_Val | : the readed value |
| PROCEDURE ParameterReadString | ( | int_Ident :INTEGER | , |
| VAR str_Val :TC255 | ) |
Read a string value from a panel.
| [in] | int_Ident | : the identification number of the readed value |
| [out] | str_Val | : the readed value |
| PROCEDURE ParameterUpdateCheck | ( | ) |
Does the treatment to update modified value in the panel.
It is used only in Parameter_Update GPP call procedure
| PROCEDURE ParameterUpdateLabelBoolean | ( | int_Ident | , |
| int_Mode | , | ||
| int_Val :INTEGER | ) |
Write a value in a boolean parameter.
| [in] | int_Ident | : identifier of the parameter |
| [in] | int_Mode | : CONST_YES or CONST_NO to enable or disable the field |
| [in] | int_Val | : value to put in the field |
| PROCEDURE ParameterUpdateLabelInteger | ( | int_Ident | , |
| int_Mode | , | ||
| int_Val :INTEGER | ) |
Write a value in a integer parameter.
| [in] | int_Ident | : identifier of the parameter |
| [in] | int_Mode | : CONST_YES or CONST_NO to enable or disable the field |
| [in] | int_Val | : value to put in the field |
| PROCEDURE ParameterUpdateLabelList | ( | int_Ident | , |
| int_Mode | , | ||
| int_Val :INTEGER | ) |
Write a value in a list parameter.
| [in] | int_Ident | : identifier of the parameter |
| [in] | int_Mode | : CONST_YES or CONST_NO to enable or disable the field |
| [in] | int_Val | : value to put in the field |
| PROCEDURE ParameterUpdateLabelReal | ( | int_Ident | , |
| int_Mode :INTEGER | , | ||
| real_Val :REAL | ) |
Write a value in a real parameter.
| [in] | int_Ident | : identifier of the parameter |
| [in] | int_Mode | : CONST_YES or CONST_NO to enable or disable the field |
| [in] | real_Val | : value to put in the field |
| PROCEDURE ParameterUpdateLabelString | ( | int_Ident | , |
| int_Mode :INTEGER | , | ||
| str_Val :TC255 | ) |
Write a value in a string parameter.
| [in] | int_Ident | : identifier of the parameter |
| [in] | int_Mode | : CONST_YES or CONST_NO to enable or disable the field |
| [in] | str_Val | : value to put in the field |
| PROCEDURE ParameterValidate | ( | ) |
Valid the parameter when Parameter_Update is called by GPP.
This function is obsolete, use ParameterUpdateCheck insted
| PROCEDURE ParameterVersionPP | ( | ) |
Write the post processor version in the title of frame The post processor version is read in the GPP.
| PROCEDURE ReadMessage | ( | int_MessageNum :INTEGER | , |
| VAR str_Message :TC255 | ) |
Read a message to display in the panel.
The message is read in MSG_PROC.DAT file depending of selected language in GO2cam
Display error if the message doesn't exist in the file
| [in] | int_MessageNum | : is the number of message to read |
| [out] | str_Message | : is the default message return if the int_MessageNum doesn't exist |
| PROCEDURE ReadMessageSpe | ( | int_Number :INTEGER | , |
| VAR str_Text :TC255 | ) |
Read a message in a specific file name as the pp with '.dico' extension.
The file have to be in UTF-8-BOM FORMAT
If the PP is named 'MonPP' the message file name is 'MonPP.dico'
The # is a comment line in the file
A line of message is like : 6.9.A|0|<Message Number>|<Text of message>
The message number is coded as follwing :
| [in] | int_Number | : Number of message to read. To |
| [in,out] | str_Text | : text read in the file. If the text doesn't exit in the active language the English is search. If nothing is find the original message is not change |
| PROCEDURE StoreGlobalBoolean | ( | int_GlobalInc :INTEGER | ) |
Store a boolean value in the memory.
The value is read in the panel and stored in the memory
If int_GlobalInc = 100 then the storage adress is 100
It can be read with using int_Val := INTRD(100); to be used in post-processor
| [in] | int_GlobalInc | : id of the variable |
| PROCEDURE StoreGlobalInteger | ( | int_GlobalInc :INTEGER | ) |
Store a integer value in the memory.
The value is read in the panel and stored in the memory
If int_GlobalInc = 100 then the storage adress is 100
It can be read with using int_Val := INTRD(100); to be used in post-processor
| [in] | int_GlobalInc | : id of the variable |
| PROCEDURE StoreGlobalList | ( | int_GlobalInc :INTEGER | ) |
Store a integer value from list in the memory.
The value is read in the panel and stored in the memory
If int_GlobalInc = 100 then the storage adress is 100
It can be read with using int_Val := INTRD(100); to be used in post-processor
| [in] | int_GlobalInc | : id of the variable |
| PROCEDURE StoreGlobalReal | ( | int_GlobalInc :INTEGER | ) |
Store a integer value from list in the memory.
The value is read in the panel and stored in the memory
If int_GlobalInc = 100 then the storage adress is 100
It can be read with using real_Val := DOUBLERD(100); to be used in post-processor
| [in] | int_GlobalInc | : id of the variable |
| PROCEDURE StoreGlobalString | ( | int_GlobalInc :INTEGER | ) |
Store a integer value from list in the memory.
The value is read in the panel and stored in the memory
If int_GlobalInc = 100 then the storage adress is 100
It can be read with using STRINGRD(100,str_String); to be used in post-processor
| [in] | int_GlobalInc | : id of the variable |