GO2cam Pascal API

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.
 

Detailed Description

Procedure to display field and stored data to be used in post-processor

Function Documentation

◆ ParameterCalculateStringLength()

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

Parameters
[in]str_Message: string inside check
Returns
Length of the maximum parameter
strcpy(str_String,'My string-Yes-No');
int_Val := ParameterCalculateStringLength(str_String);
writeln('return value should be 3 : ', int_Val);
INTEGER FUNCTION ParameterCalculateStringLength(str_Message :TC255) INTEGER
Return the length of the longest parameter in the str_Message.
Definition PP67_TOOLS.LIB:1852

◆ ParameterCreateBitmapGO()

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.
Definition PP67_TOOLS.LIB:1649

◆ ParameterCreateBitmapNC()

PROCEDURE ParameterCreateBitmapNC ( )

Load a bitmap in the panel depending with name of post-processor.

◆ ParameterCreateBoolean()

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

Parameters
[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
strcpy(str_Message,'My Field Name');
ParameterCreateBoolean(20,105,0,1,20,20,str_Message);
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.
Definition PP67_TOOLS.LIB:887

◆ ParameterCreateCheck()

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

Parameters
[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
strcpy(str_Message,'My Field Name');
ParameterCreateCheck(20,105,0,1,20,20,str_Message);
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.
Definition PP67_TOOLS.LIB:965

◆ ParameterCreateComment()

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

Parameters
[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
strcpy(str_Message,'My Comment');
ParameterCreateComment(105,1,0,20,str_Message);
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.
Definition PP67_TOOLS.LIB:758

◆ ParameterCreateFrame()

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.

Parameters
[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
strcpy(str_Message,'My Frame title');
ParameterCreateFrame(100,1,1,2,77,str_Message);
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.
Definition PP67_TOOLS.LIB:523

◆ ParameterCreateInteger()

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

Parameters
[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
strcpy(str_Message,'My Field Name');
ParameterCreateInteger(20,105,5,1,20,str_Message);
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.
Definition PP67_TOOLS.LIB:926

◆ ParameterCreateList()

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

Attention
BE CAREFUL, it means we can't use minus sign inside the text
Parameters
[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
strcpy(str_Message,'My Field Name-Choice 1 - Choice 2');
ParameterCreateList(20,105,0,1,20,20,str_Message);
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.
Definition PP67_TOOLS.LIB:1011

◆ ParameterCreatePage()

PROCEDURE ParameterCreatePage ( int_MessageNum :INTEGER ,
str_Message :TC255  )

Create a new page in the panel.

Parameters
[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
strcpy(str_Message, 'Page title');
ParameterCreatePage(105,str_Message);
PROCEDURE ParameterCreatePage(int_MessageNum :INTEGER, str_Message :TC255)
Create a new page in the panel.
Definition PP67_TOOLS.LIB:1822

◆ ParameterCreateReal()

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

Parameters
[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
strcpy(str_Message,'My Field Name');
ParameterCreateReal(20,105,1.25,1,20,20,str_Message);
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.
Definition PP67_TOOLS.LIB:797

◆ ParameterCreateRealFormat()

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

Parameters
[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
Warning
If the value is a distance the user will set the value in the pp unit and the value will be stored in mm

◆ ParameterCreateString()

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

Parameters
[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
ParameterCreateString(20,105,str_Default,1,10,20,str_Message);
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.
Definition PP67_TOOLS.LIB:721

◆ ParameterCreateStringIgnore()

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

Parameters
[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
strcpy(str_Default,'My Field Content');
strcpy(str_Message,'My Field Name');
ParameterCreateStringIgnore(20,105,str_Default,1,10,20,str_Message);
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.
Definition PP67_TOOLS.LIB:681

◆ ParameterHelp()

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 ParameterHelp()
Open a help file.
Definition PP67_TOOLS.LIB:269

◆ ParameterReadBoolean()

PROCEDURE ParameterReadBoolean ( int_Ident :INTEGER ,
VAR int_Val :INTEGER  )

Read a boolean value from a panel.

Parameters
[in]int_Ident: the identification number of the readed value
[out]int_Val: the readed value
PROCEDURE ParameterReadBoolean(int_Ident :INTEGER, VAR int_Val :INTEGER)
Read a boolean value from a panel.
Definition PP67_TOOLS.LIB:1138

◆ ParameterReadInteger()

PROCEDURE ParameterReadInteger ( int_Ident :INTEGER ,
VAR int_Val :INTEGER  )

Read a integer value from a panel.

Parameters
[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.
Definition PP67_TOOLS.LIB:1085

◆ ParameterReadLabel()

PROCEDURE ParameterReadLabel ( int_Ident :INTEGER ,
VAR str_Label :TC255 ,
str_Type :TC255  )

Build the key to read a value in a panel.

Parameters
[in]int_Ident: identifier of the parameter
[out]str_label: reading Label name
[out]str_Type: letter that define the kind of variable read
strcpy(str_Type,'E');
ParameterReadLabel(50,str_Label,str_Type);
writeln('str_Label should be E50 : ', str_Label);
PROCEDURE ParameterReadLabel(int_Ident :INTEGER, VAR str_Label :TC255, str_Type :TC255)
Build the key to read a value in a panel.
Definition PP67_TOOLS.LIB:1193

◆ ParameterReadLabelBoolean()

PROCEDURE ParameterReadLabelBoolean ( int_Ident :INTEGER ,
VAR str_Label :TC255  )

Build the key to read a boolean value in a panel.

Parameters
[in]int_Ident: identifier of the parameter
[out]str_label: reading Label name
writeln('str_Label should be B50 : ', str_Label);
PROCEDURE ParameterReadLabelBoolean(int_Ident :INTEGER, VAR str_Label :TC255)
Build the key to read a boolean value in a panel.
Definition PP67_TOOLS.LIB:1221

◆ ParameterReadLabelInteger()

PROCEDURE ParameterReadLabelInteger ( int_Ident :INTEGER ,
VAR str_Label :TC255  )

Build the key to read an integer value in a panel.

Parameters
[in]int_Ident: identifier of the parameter
[out]str_label: reading Label name
writeln('str_Label should be I50 : ', str_Label);
PROCEDURE ParameterReadLabelInteger(int_Ident :INTEGER, VAR str_Label :TC255)
Build the key to read an integer value in a panel.
Definition PP67_TOOLS.LIB:1247

◆ ParameterReadLabelReal()

PROCEDURE ParameterReadLabelReal ( int_Ident :INTEGER ,
VAR str_Label :TC255  )

Build the key to read a real value in a panel.

Parameters
[in]int_Ident: identifier of the parameter
[out]str_label: reading Label name
ParameterReadLabelReal(50,str_Label);
writeln('str_Label should be R50 : ', str_Label);
PROCEDURE ParameterReadLabelReal(int_Ident :INTEGER, VAR str_Label :TC255)
Build the key to read a real value in a panel.
Definition PP67_TOOLS.LIB:1272

◆ ParameterReadLabelString()

PROCEDURE ParameterReadLabelString ( int_Ident :INTEGER ,
VAR str_Label :TC255  )

Build the key to read a string value in a panel.

Parameters
[in]int_Ident: identifier of the parameter
[out]str_label: reading Label name
writeln('str_Label should be S50 : ', str_Label);
PROCEDURE ParameterReadLabelString(int_Ident :INTEGER, VAR str_Label :TC255)
Build the key to read a string value in a panel.
Definition PP67_TOOLS.LIB:1298

◆ ParameterReadList()

PROCEDURE ParameterReadList ( int_Ident :INTEGER ,
VAR int_Val :INTEGER  )

Read a integer value from a list in a panel.

Parameters
[in]int_Ident: the identification number of the readed value
[out]int_Val: the readed value
ParameterReadList(50,int_Val);
PROCEDURE ParameterReadList(int_Ident :INTEGER, VAR int_Val :INTEGER)
Read a integer value from a list in a panel.
Definition PP67_TOOLS.LIB:1111

◆ ParameterReadMessageCategory()

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

Attention
The number in this procedure must be added with 10 to find the correct section in the MSG_PROC.DAT file
Returns
The number of the category where read a message
INTEGER FUNCTION ParameterReadMessageCategory() INTEGER
Get the number of the category to read a message.
Definition PP67_TOOLS.LIB:1623

◆ ParameterReadReal()

PROCEDURE ParameterReadReal ( int_Ident :INTEGER ,
VAR real_Val :REAL  )

Read a real value from a panel.

Parameters
[in]int_Ident: the identification number of the readed value
[out]real_Val: the readed value
ParameterReadReal(50,real_Val);
PROCEDURE ParameterReadReal(int_Ident :INTEGER, VAR real_Val :REAL)
Read a real value from a panel.
Definition PP67_TOOLS.LIB:1059

◆ ParameterReadString()

PROCEDURE ParameterReadString ( int_Ident :INTEGER ,
VAR str_Val :TC255  )

Read a string value from a panel.

Parameters
[in]int_Ident: the identification number of the readed value
[out]str_Val: the readed value
ParameterReadString(50,str_Val);
PROCEDURE ParameterReadString(int_Ident :INTEGER, VAR str_Val :TC255)
Read a string value from a panel.
Definition PP67_TOOLS.LIB:1164

◆ ParameterUpdateCheck()

PROCEDURE ParameterUpdateCheck ( )

Does the treatment to update modified value in the panel.

It is used only in Parameter_Update GPP call procedure

ParameterUpdateCheck;

◆ ParameterUpdateLabelBoolean()

PROCEDURE ParameterUpdateLabelBoolean ( int_Ident ,
int_Mode ,
int_Val :INTEGER  )

Write a value in a boolean parameter.

Parameters
[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
ParameterUpdateLabelBoolean(50, CONST_YES, 1);
PROCEDURE ParameterUpdateLabelBoolean(int_Ident, int_Mode, int_Val :INTEGER)
Write a value in a boolean parameter.
Definition PP67_TOOLS.LIB:1414

◆ ParameterUpdateLabelInteger()

PROCEDURE ParameterUpdateLabelInteger ( int_Ident ,
int_Mode ,
int_Val :INTEGER  )

Write a value in a integer parameter.

Parameters
[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
ParameterUpdateLabelInteger(50, CONST_YES, 10);
PROCEDURE ParameterUpdateLabelInteger(int_Ident, int_Mode, int_Val :INTEGER)
Write a value in a integer parameter.
Definition PP67_TOOLS.LIB:1352

◆ ParameterUpdateLabelList()

PROCEDURE ParameterUpdateLabelList ( int_Ident ,
int_Mode ,
int_Val :INTEGER  )

Write a value in a list parameter.

Parameters
[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
ParameterUpdateLabelList(50, CONST_YES, 3);
PROCEDURE ParameterUpdateLabelList(int_Ident, int_Mode, int_Val :INTEGER)
Write a value in a list parameter.
Definition PP67_TOOLS.LIB:1380

◆ ParameterUpdateLabelReal()

PROCEDURE ParameterUpdateLabelReal ( int_Ident ,
int_Mode :INTEGER ,
real_Val :REAL  )

Write a value in a real parameter.

Parameters
[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
ParameterUpdateLabelReal(50, CONST_YES, 2.15);
PROCEDURE ParameterUpdateLabelReal(int_Ident, int_Mode :INTEGER, real_Val :REAL)
Write a value in a real parameter.
Definition PP67_TOOLS.LIB:1441

◆ ParameterUpdateLabelString()

PROCEDURE ParameterUpdateLabelString ( int_Ident ,
int_Mode :INTEGER ,
str_Val :TC255  )

Write a value in a string parameter.

Parameters
[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
strcpy(str_Val,'String value');
ParameterUpdateLabelString(50, CONST_YES, str_Val);
PROCEDURE ParameterUpdateLabelString(int_Ident, int_Mode :INTEGER, str_Val :TC255)
Write a value in a string parameter.
Definition PP67_TOOLS.LIB:1324

◆ ParameterValidate()

PROCEDURE ParameterValidate ( )

Valid the parameter when Parameter_Update is called by GPP.

This function is obsolete, use ParameterUpdateCheck insted

◆ ParameterVersionPP()

PROCEDURE ParameterVersionPP ( )

Write the post processor version in the title of frame The post processor version is read in the GPP.

PROCEDURE ParameterVersionPP()
Write the post processor version in the title of frame The post processor version is read in the GPP.
Definition PP67_TOOLS.LIB:40

◆ ReadMessage()

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

Parameters
[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
strcpy(str_Message,'My message');
ReadMessage(800, str_Message);
PROCEDURE ReadMessage(int_MessageNum :INTEGER, VAR str_Message :TC255,)
Read a message to display in the panel.
Definition PP67_TOOLS.LIB:1946

◆ ReadMessageSpe()

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 :

  • 4 last digit is int_Number
  • Previous digit is the language code
    2 : English
    3 : French
    4 : German
    5 : Italian
    6 : Spanish
    7 : Brazilian
    8 : Dutch
    9 : Greek
    10 : Russian
    11 : Polish
    12 : Korean
    13 : Chinese
    14 : Simplify Chinese
    15 : Japanese
    16 : Romanian
    17 : Czech
    18 : Turkish
Parameters
[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
Version
V6.09.207
ReadMessage(2,str_Text);

◆ StoreGlobalBoolean()

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

Parameters
[in]int_GlobalInc: id of the variable
PROCEDURE StoreGlobalBoolean(int_GlobalInc :INTEGER)
Store a boolean value in the memory.
Definition PP67_TOOLS.LIB:1472

◆ StoreGlobalInteger()

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

Parameters
[in]int_GlobalInc: id of the variable
PROCEDURE StoreGlobalInteger(int_GlobalInc :INTEGER)
Store a integer value in the memory.
Definition PP67_TOOLS.LIB:1502

◆ StoreGlobalList()

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

Parameters
[in]int_GlobalInc: id of the variable
PROCEDURE StoreGlobalList(int_GlobalInc :INTEGER)
Store a integer value from list in the memory.
Definition PP67_TOOLS.LIB:1532

◆ StoreGlobalReal()

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

Parameters
[in]int_GlobalInc: id of the variable
PROCEDURE StoreGlobalReal(int_GlobalInc :INTEGER)
Store a integer value from list in the memory.
Definition PP67_TOOLS.LIB:1563

◆ StoreGlobalString()

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

Parameters
[in]int_GlobalInc: id of the variable
PROCEDURE StoreGlobalString(int_GlobalInc :INTEGER)
Store a integer value from list in the memory.
Definition PP67_TOOLS.LIB:1592