GO2cam Pascal API

Topics

 Parameters creation
 
 Parameters update
 
 Parameters reading
 

Functions

int ecyc_B_PARAMETRE (int index, const std::string &txt, int bval)
 Write a boolean parameter in a macro.
 
int ecyc_C_PARAMETRE (const std::string &txt)
 Write a comment in a macro.
 
int ecyc_DOMAINE_PARAMETRE (const std::string &interval)
 Write a interval mode of this parameter.
This function use between format and definition.
 
int ecyc_E_PARAMETRE (int index, const std::string &txt, int ival)
 Write a integer parameter in a macro.
 
int ecyc_FORMAT_PARAMETRE (int format, int line, int column, int large, int height)
 Define the parameter format.
 
int ecyc_R_PARAMETRE (int index, const std::string &txt, double rval)
 Write a real parameter in a macro.
 
int ecyc_S_PARAMETRE (int index, const std::string &txt, const std::string &sval)
 Write a string parameter in a macro.
 
int ecyc_T_PARAMETRE (const std::string &txt)
 Write a separator in a macro.
 
int ecyc_TITRE_PARAMETRE (const std::string &txt)
 Write a title in a macro.
 

Detailed Description

Macro parameters

Display Allows the creation and management of the display of a dialog box containing parameters

Attention
The functions of this module are reserved for Pascal. They do not work in COM mode (VB net, C ++, C # ...)
For COM, the dialog boxes are managed from the GO2cam client application

Function Documentation

◆ ecyc_B_PARAMETRE()

int ecyc_B_PARAMETRE ( int index,
const std::string & txt,
int bval )

Write a boolean parameter in a macro.

Parameters
[in]indexIndex of parameter ETF_PARAM1...
[in]txtText of the parameter. Answer are separate by a dash.
for example 'Right-Left'
[in]bvalDefault boolean value of the parameter
Remarks
Don't forget to create a format before
parameter ecyc_FORMAT_PARAMETRE
PCALL(ecyc_B_PARAMETRE,ETF_PARAM1,'Choix :-choix1-choix2',1);
int ecyc_B_PARAMETRE(int index, const std::string &txt, int bval)
Write a boolean parameter in a macro.
Definition pa_cyc01.c:185
See also
ecyc_FORMAT_PARAMETRE, ecyc_DOMAINE_PARAMETRE

◆ ecyc_C_PARAMETRE()

int ecyc_C_PARAMETRE ( const std::string & txt)

Write a comment in a macro.

Parameters
[in]txtComment
Remarks
Don't forget to create a format before
parameter ecyc_FORMAT_PARAMETRE
PCALL(ecyc_C_PARAMETRE,'Comment');
int ecyc_C_PARAMETRE(const std::string &txt)
Write a comment in a macro.
Definition pa_cyc01.c:301
See also
ecyc_FORMAT_PARAMETRE

◆ ecyc_DOMAINE_PARAMETRE()

int ecyc_DOMAINE_PARAMETRE ( const std::string & interval)

Write a interval mode of this parameter.
This function use between format and definition.

Version
4.3
Parameters
[in]intervalInterval definition [10..20]
Remarks
The interval definition is between hook.
PCALL(ecyc_FORMAT_PARAMETRE,0,10,200,10,1);
PCALL(ecyc_DOMAINE_PARAMETRE,'[10,20,30,50..60,80..100]');
PCALL(ecyc_E_PARAMETRE,'LBL','Nb=',10);
{ 10,20,30, 50 --> 60 , 80 --> 100 : OK }
PCALL(ecyc_FORMAT_PARAMETRE,1,30,200,10,1);
PCALL(ecyc_DOMAINE_PARAMETRE,'[0.0..3.14159,6.283]');
PCALL(ecyc_R_PARAMETRE,'LBL2','Diam=',1.0);
{ 6.283 , 0.0 --> 3.14159 : OK }
int ecyc_R_PARAMETRE(int index, const std::string &txt, double rval)
Write a real parameter in a macro.
Definition pa_cyc01.c:224
int ecyc_E_PARAMETRE(int index, const std::string &txt, int ival)
Write a integer parameter in a macro.
Definition pa_cyc01.c:143
int ecyc_FORMAT_PARAMETRE(int format, int line, int column, int large, int height)
Define the parameter format.
Definition pa_cyc01.c:42
int ecyc_DOMAINE_PARAMETRE(const std::string &interval)
Write a interval mode of this parameter. This function use between format and definition.
Definition pa_cyc01.c:402
See also
ecyc_FORMAT_PARAMETRE

◆ ecyc_E_PARAMETRE()

int ecyc_E_PARAMETRE ( int index,
const std::string & txt,
int ival )

Write a integer parameter in a macro.

Parameters
[in]indexindex of parameter ETF_PARAM1...
[in]txtText of the parameter. Request and answer are separate by a dash.
for example 'Side-Rigth-Middle-Left'
[in]ivalDefault integer value of the parameter
Remarks
Don't forget to create a format before
parameter ecyc_FORMAT_PARAMETRE
PCALL(ecyc_E_PARAMETRE,ETF_PARAM1,'Nb=',10);
See also
ecyc_FORMAT_PARAMETRE, ecyc_DOMAINE_PARAMETRE

◆ ecyc_FORMAT_PARAMETRE()

int ecyc_FORMAT_PARAMETRE ( int format,
int line,
int column,
int large,
int height )

Define the parameter format.

Parameters
[in]formatSee down
[in]lineLine location of the field (10=1 charactere)
[in]columnColumn location of the field (10=1 charactere)
[in]largefield length (characteres)
[in]heightfield height (characteres)
Remarks
Possible value for the format
  • Boolean :
    0 : Button + message
    1 : Horizontal choice
    2 : icone button
    3 : Vertical choice
  • Integer :
    0 : message + field
    1 : message + combo box
    2 : Vertical scroll
    3 : Horizontal scroll
    4 : message + booleen choice
  • Real :
    SPI_FORMAT_REAL_STD : message + input field
    SPI_FORMAT_REAL_DISTANCE : message + distance input field (millimeter / Inch)
    SPI_FORMAT_REAL_ANGLE : message + angle input field (Degre)
    SPI_FORMAT_REAL_TEMPS : message + time input field (Hour, Minute, seconde)
    SPI_FORMAT_REAL_DBL_DISTANCE : message + double distance for tolerance input field (millimeter / Inch)
    SPI_FORMAT_REAL_WEIGHT : message + weight input field (grams,pound)
    SPI_FORMAT_REAL_CURRENCY : message + currency input field (€, $)
    SPI_FORMAT_REAL_TEMPS_MINUTE : message + time input field (minute)
    SPI_FORMAT_REAL_DURATION : message + duration input field (seconde)
    SPI_FORMAT_REAL_ROTATION_SPEED : message + rotation speed input field (tr/min)
    SPI_FORMAT_REAL_CUTTING_SPEED : message + cutting speed input field (metre/min, feed/min)
    SPI_FORMAT_REAL_FEEDRATE : message + feedrate input field (millimeter/min, Inch/min)
    SPI_FORMAT_REAL_FEEDRATE_TOOTH : message + feedrate tooth input field (millimeter/tooth, Inch/tooth)
    SPI_FORMAT_REAL_POWER : message + power input field (Kwatt)
    SPI_FORMAT_REAL_MASS_DENSITY : message + density input field (kg/m3, pound/inch3)
    SPI_FORMAT_REAL_ULTIMATE_STRENGTH : message + ultimate strength input field (Newton/mm2, pound force/inch2)
    SPI_FORMAT_REAL_TORQUE : message + torque input field (Newton/metre)
    SPI_FORMAT_REAL_FEEDRATE_ROTATE : message + feedrate rotate input field (mm/tr, inch/tr) (VCC)
    SPI_FORMAT_REAL_FLOW : message + flow input field (cm3/minute, inch3/min) - String :
  • Comment :
    0 : message
  • Frame :
    0 : Horizontal _line
    1 : Vertical _line
    2 : Frame + message
PCALL(ecyc_FORMAT_PARAMETRE,1,10,200,10,1);
See also
ecyc_E_PARAMETRE, ecyc_B_PARAMETRE
ecyc_R_PARAMETRE, ecyc_S_PARAMETRE

◆ ecyc_R_PARAMETRE()

int ecyc_R_PARAMETRE ( int index,
const std::string & txt,
double rval )

Write a real parameter in a macro.

Parameters
[in]indexIndex of the parameter RTF_PARAM1...
[in]txtText of the parameter.
[in]rvalDefault real value of the parameter
Remarks
Don't forget to create a format before
parameter ecyc_FORMAT_PARAMETRE
PCALL(ecyc_R_PARAMETRE,RTF_PARAM1,'Val :',20);
See also
ecyc_FORMAT_PARAMETRE, ecyc_DOMAINE_PARAMETRE

◆ ecyc_S_PARAMETRE()

int ecyc_S_PARAMETRE ( int index,
const std::string & txt,
const std::string & sval )

Write a string parameter in a macro.

Parameters
[in]indexIndex of the parameter STF_PARAM1...
[in]txtText of the parameter.
[in]svalDefault string value of the parameter
Remarks
Don't forget to create a format before
parameter ecyc_FORMAT_PARAMETRE
PCALL(ecyc_S_PARAMETRE,STF_PARAM1,'Chaine :','default');
int ecyc_S_PARAMETRE(int index, const std::string &txt, const std::string &sval)
Write a string parameter in a macro.
Definition pa_cyc01.c:262
See also
ecyc_FORMAT_PARAMETRE, ecyc_DOMAINE_PARAMETRE

◆ ecyc_T_PARAMETRE()

int ecyc_T_PARAMETRE ( const std::string & txt)

Write a separator in a macro.

Parameters
[in]txtSeparator
Remarks
Don't forget to create a format before
parameter ecyc_FORMAT_PARAMETRE
PCALL(ecyc_T_PARAMETRE,'Title');
int ecyc_T_PARAMETRE(const std::string &txt)
Write a separator in a macro.
Definition pa_cyc01.c:368
See also
ecyc_FORMAT_PARAMETRE

◆ ecyc_TITRE_PARAMETRE()

int ecyc_TITRE_PARAMETRE ( const std::string & txt)

Write a title in a macro.

Parameters
[in]txtTitle in the macro
Remarks
The title is write in a banner of
dialog box
PCALL(ecyc_TITRE_PARAMETRE,'Title');
int ecyc_TITRE_PARAMETRE(const std::string &txt)
Write a title in a macro.
Definition pa_cyc01.c:335