Commit 7f170853 authored by Claes's avatar Claes Committed by Esteban Blanc

Doc changes

parent 23672a06
...@@ -10156,6 +10156,7 @@ PlcConnect() <LINK> plcconnect() ...@@ -10156,6 +10156,7 @@ PlcConnect() <LINK> plcconnect()
exit() <LINK> exit() exit() <LINK> exit()
system() <LINK> system() system() <LINK> system()
time() <LINK> time() time() <LINK> time()
tzset() <LINK> tzset()
verify() <LINK> verify() verify() <LINK> verify()
<h2>Miscellaneous functions <h2>Miscellaneous functions
...@@ -10182,6 +10183,7 @@ SetIoDeviceData() <LINK> setiodevicedata() ...@@ -10182,6 +10183,7 @@ SetIoDeviceData() <LINK> setiodevicedata()
GetVersion() <LINK> getversion() GetVersion() <LINK> getversion()
get_pwr_config() <LINK> get_pwr_config() get_pwr_config() <LINK> get_pwr_config()
get_node_name() <LINK> get_node_name() get_node_name() <LINK> get_node_name()
getmsg() <LINK> getmsg()
EVEN() <LINK> EVEN() EVEN() <LINK> EVEN()
ODD() <LINK> ODD() ODD() <LINK> ODD()
...@@ -10965,7 +10967,7 @@ int <t><t>Length of string. ...@@ -10965,7 +10967,7 @@ int <t><t>Length of string.
</TOPIC> </TOPIC>
<TOPIC> strstr() <style> function <TOPIC> strstr() <style> function
strchr() strstr()
int strstr( string str, string substr) int strstr( string str, string substr)
...@@ -11045,6 +11047,7 @@ System functions ...@@ -11045,6 +11047,7 @@ System functions
exit <t>Exit script. <link> exit() exit <t>Exit script. <link> exit()
system <t>Execute shell command. <link> system() system <t>Execute shell command. <link> system()
time <t>Get system time. <link> time() time <t>Get system time. <link> time()
tzset <t>Set time zone. <link> tzset()
verify <t>Print executed lines. <link> verify() verify <t>Print executed lines. <link> verify()
</TOPIC> </TOPIC>
...@@ -11103,6 +11106,20 @@ Returns the current time in string format. ...@@ -11103,6 +11106,20 @@ Returns the current time in string format.
<c> t = time(); <c> t = time();
</TOPIC> </TOPIC>
<TOPIC> tzset() <style> function
tzset()
string tzset( string timezone)
<b>Description
Set time zone.
<b>Example
<c> tzset("Europe/Stockholm");
</TOPIC>
<TOPIC> verify() <style> function <TOPIC> verify() <style> function
verify() verify()
...@@ -11849,6 +11866,7 @@ SetIoDeviceData() <t>Set data in IO configuration. <LINK> setiodevicedata() ...@@ -11849,6 +11866,7 @@ SetIoDeviceData() <t>Set data in IO configuration. <LINK> setiodevicedata()
GetVersion() <t>Get ProviewR version. <LINK> getversion() GetVersion() <t>Get ProviewR version. <LINK> getversion()
get_pwr_config() <t>Get configuration values. <LINK> get_pwr_config() get_pwr_config() <t>Get configuration values. <LINK> get_pwr_config()
get_node_name() <t>Get node name. <LINK> get_node_name() get_node_name() <t>Get node name. <LINK> get_node_name()
getmsg() <t>Get status text. <LINK> getmsg()
EVEN() <t>Check if value is even. <LINK> EVEN() EVEN() <t>Check if value is even. <LINK> EVEN()
ODD() <t>Check if value is odd. <LINK> ODD() ODD() <t>Check if value is odd. <LINK> ODD()
</TOPIC> </TOPIC>
...@@ -12333,6 +12351,21 @@ Returns the host name. ...@@ -12333,6 +12351,21 @@ Returns the host name.
<c> name = get_node_name(); <c> name = get_node_name();
</TOPIC> </TOPIC>
<TOPIC> getmsg() <style> function
getmsg()
string getmsg(int status)
<b>Description
Get the corresponding text for a status variable.
Returns the text.
<b>Example
<c> msg = getmsg(sts);
</TOPIC>
<TOPIC> EVEN() <style> function <TOPIC> EVEN() <style> function
EVEN() EVEN()
......
...@@ -2838,6 +2838,7 @@ GetRootList() <LINK> getrootlist() ...@@ -2838,6 +2838,7 @@ GetRootList() <LINK> getrootlist()
exit() <LINK> exit() exit() <LINK> exit()
system() <LINK> system() system() <LINK> system()
time() <LINK> time() time() <LINK> time()
tzset() <LINK> tzset()
verify() <LINK> verify() verify() <LINK> verify()
<h2>Miscellaneous functions <h2>Miscellaneous functions
...@@ -2849,6 +2850,7 @@ GetCurrentText() <LINK> getcurrenttext() ...@@ -2849,6 +2850,7 @@ GetCurrentText() <LINK> getcurrenttext()
GetCurrentObject() <LINK> getcurrentobject() GetCurrentObject() <LINK> getcurrentobject()
get_pwr_config() <LINK> get_pwr_config() get_pwr_config() <LINK> get_pwr_config()
get_node_name() <LINK> get_node_name() get_node_name() <LINK> get_node_name()
getmsg() <LINK> getmsg()
EVEN() <LINK> EVEN() EVEN() <LINK> EVEN()
ODD() <LINK> ODD() ODD() <LINK> ODD()
get_language() <LINK> get_language() get_language() <LINK> get_language()
...@@ -3638,7 +3640,7 @@ int <t><t>Length of string. ...@@ -3638,7 +3640,7 @@ int <t><t>Length of string.
</TOPIC> </TOPIC>
<TOPIC> strstr() <style> function <TOPIC> strstr() <style> function
strchr() strstr()
int strstr( string str, string substr) int strstr( string str, string substr)
...@@ -3718,6 +3720,7 @@ System functions ...@@ -3718,6 +3720,7 @@ System functions
exit <t>Exit script. <link> exit() exit <t>Exit script. <link> exit()
system <t>Execute shell command. <link> system() system <t>Execute shell command. <link> system()
time <t>Get system time. <link> time() time <t>Get system time. <link> time()
tzset <t>Set time zone. <link> tzset()
verify <t>Print executed lines. <link> verify() verify <t>Print executed lines. <link> verify()
</TOPIC> </TOPIC>
...@@ -3776,6 +3779,20 @@ Returns the current time in string format. ...@@ -3776,6 +3779,20 @@ Returns the current time in string format.
<c> t = time(); <c> t = time();
</TOPIC> </TOPIC>
<TOPIC> tzset() <style> function
tzset()
string tzset( string timezone)
<b>Description
Set time zone.
<b>Example
<c> tzset("Europe/Stockholm");
</TOPIC>
<TOPIC> verify() <style> function <TOPIC> verify() <style> function
verify() verify()
...@@ -4074,6 +4091,7 @@ GetCurrentText() <t>Get selected text. <LINK> getcurrenttext() ...@@ -4074,6 +4091,7 @@ GetCurrentText() <t>Get selected text. <LINK> getcurrenttext()
GetCurrentObject() <t>Get selected object. <LINK> getcurrentobject() GetCurrentObject() <t>Get selected object. <LINK> getcurrentobject()
get_pwr_config() <t>Get configuration values <LINK> get_pwr_config() get_pwr_config() <t>Get configuration values <LINK> get_pwr_config()
get_node_name() <t>Get node name <LINK> get_node_name() get_node_name() <t>Get node name <LINK> get_node_name()
getmsg() <t>Get status text. <LINK> getmsg()
EVEN() <t>Check if value is even. <LINK> EVEN() EVEN() <t>Check if value is even. <LINK> EVEN()
ODD() <t>Check if value is odd. <LINK> ODD() ODD() <t>Check if value is odd. <LINK> ODD()
get_language() <t>Get the current language <LINK> get_language() get_language() <t>Get the current language <LINK> get_language()
...@@ -4228,6 +4246,21 @@ Returns the host name. ...@@ -4228,6 +4246,21 @@ Returns the host name.
<c> name = get_node_name(); <c> name = get_node_name();
</TOPIC> </TOPIC>
<TOPIC> getmsg() <style> function
getmsg()
string getmsg(int status)
<b>Description
Get the corresponding text for a status variable.
Returns the text.
<b>Example
<c> msg = getmsg(sts);
</TOPIC>
<TOPIC> EVEN() <style> function <TOPIC> EVEN() <style> function
EVEN() EVEN()
......
...@@ -10023,6 +10023,7 @@ PlcConnect() <LINK> plcconnect() ...@@ -10023,6 +10023,7 @@ PlcConnect() <LINK> plcconnect()
exit() <LINK> exit() exit() <LINK> exit()
system() <LINK> system() system() <LINK> system()
time() <LINK> time() time() <LINK> time()
tzset() <LINK> tzset()
verify() <LINK> verify() verify() <LINK> verify()
<h2>Diverse funktioner <h2>Diverse funktioner
...@@ -10049,6 +10050,7 @@ SetIoDeviceData() <LINK> setiodevicedata() ...@@ -10049,6 +10050,7 @@ SetIoDeviceData() <LINK> setiodevicedata()
GetVersion() <LINK> getversion() GetVersion() <LINK> getversion()
get_pwr_config() <LINK> get_pwr_config() get_pwr_config() <LINK> get_pwr_config()
get_node_name() <LINK> get_node_name() get_node_name() <LINK> get_node_name()
getmsg() <LINK> getmsg()
EVEN() <LINK> EVEN() EVEN() <LINK> EVEN()
ODD() <LINK> ODD() ODD() <LINK> ODD()
...@@ -10824,7 +10826,7 @@ int <t><t>Str ...@@ -10824,7 +10826,7 @@ int <t><t>Str
</TOPIC> </TOPIC>
<TOPIC> strstr() <style> function <TOPIC> strstr() <style> function
strchr() strstr()
int strstr( string str, string substr) int strstr( string str, string substr)
...@@ -10904,6 +10906,7 @@ System funktioner ...@@ -10904,6 +10906,7 @@ System funktioner
exit <t>Avsluta scriptet. <link> exit() exit <t>Avsluta scriptet. <link> exit()
system <t>Exekvera ett shell kommando. <link> system() system <t>Exekvera ett shell kommando. <link> system()
time <t>Hämta systemtiden. <link> time() time <t>Hämta systemtiden. <link> time()
tzset <t>Sätt tidszon. <link> tzset()
verify <t>Skriv ut exekverade rader. <link> verify() verify <t>Skriv ut exekverade rader. <link> verify()
</TOPIC> </TOPIC>
...@@ -10962,6 +10965,20 @@ Returnerar nuvarande tid i str ...@@ -10962,6 +10965,20 @@ Returnerar nuvarande tid i str
<c> t = time(); <c> t = time();
</TOPIC> </TOPIC>
<TOPIC> tzset() <style> function
tzset()
string tzset( string timezone)
<b>Beskrivning
Sätt tidszon.
<b>Exempel
<c> tzset("Europe/Stockholm");
</TOPIC>
<TOPIC> verify() <style> function <TOPIC> verify() <style> function
verify() verify()
...@@ -11710,6 +11727,7 @@ SetIoDeviceData() <LINK> setiodevicedata() ...@@ -11710,6 +11727,7 @@ SetIoDeviceData() <LINK> setiodevicedata()
GetVersion() <LINK> getversion() GetVersion() <LINK> getversion()
get_pwr_config() <LINK> get_pwr_config() get_pwr_config() <LINK> get_pwr_config()
get_node_name() <LINK> get_node_name() get_node_name() <LINK> get_node_name()
getmsg() <LINK> getmsg()
EVEN() <LINK> EVEN() EVEN() <LINK> EVEN()
ODD() <LINK> ODD() ODD() <LINK> ODD()
</TOPIC> </TOPIC>
...@@ -12194,6 +12212,21 @@ Returnerar nodnamnet. ...@@ -12194,6 +12212,21 @@ Returnerar nodnamnet.
<c> name = get_node_name(); <c> name = get_node_name();
</TOPIC> </TOPIC>
<TOPIC> getmsg() <style> function
getmsg()
string getmsg(int status)
<b>Beskrivning
Hämta texten för ett status värde.
Returnerar texten.
<b>Exempel
<c> msg = getmsg(sts);
</TOPIC>
<TOPIC> EVEN() <style> function <TOPIC> EVEN() <style> function
EVEN() EVEN()
......
...@@ -2612,6 +2612,7 @@ GetRootList() <LINK> getrootlist() ...@@ -2612,6 +2612,7 @@ GetRootList() <LINK> getrootlist()
exit() <LINK> exit() exit() <LINK> exit()
system() <LINK> system() system() <LINK> system()
time() <LINK> time() time() <LINK> time()
tzset() <LINK> tzset()
verify() <LINK> verify() verify() <LINK> verify()
<h2>Diverse funktioner <h2>Diverse funktioner
...@@ -2623,6 +2624,7 @@ GetCurrentText() <LINK> getcurrenttext() ...@@ -2623,6 +2624,7 @@ GetCurrentText() <LINK> getcurrenttext()
GetCurrentObject() <LINK> getcurrentobject() GetCurrentObject() <LINK> getcurrentobject()
get_pwr_config() <LINK> get_pwr_config() get_pwr_config() <LINK> get_pwr_config()
get_node_name() <LINK> get_node_name() get_node_name() <LINK> get_node_name()
getmsg() <LINK> getmsg()
EVEN() <LINK> EVEN() EVEN() <LINK> EVEN()
ODD() <LINK> ODD() ODD() <LINK> ODD()
get_language() <LINK> get_language() get_language() <LINK> get_language()
...@@ -3402,7 +3404,7 @@ int <t><t>Str ...@@ -3402,7 +3404,7 @@ int <t><t>Str
</TOPIC> </TOPIC>
<TOPIC> strstr() <style> function <TOPIC> strstr() <style> function
strchr() strstr()
int strstr( string str, string substr) int strstr( string str, string substr)
...@@ -3482,6 +3484,7 @@ System funktioner ...@@ -3482,6 +3484,7 @@ System funktioner
exit <t>Avsluta scriptet. <link> exit() exit <t>Avsluta scriptet. <link> exit()
system <t>Exekvera ett shell kommando. <link> system() system <t>Exekvera ett shell kommando. <link> system()
time <t>Hämta systemtiden. <link> time() time <t>Hämta systemtiden. <link> time()
tzset <t>Sätt tidszon. <link> tzset()
verify <t>Skriv ut exekverade rader. <link> verify() verify <t>Skriv ut exekverade rader. <link> verify()
</TOPIC> </TOPIC>
...@@ -3540,6 +3543,20 @@ Returnerar nuvarande tid i str ...@@ -3540,6 +3543,20 @@ Returnerar nuvarande tid i str
<c> t = time(); <c> t = time();
</TOPIC> </TOPIC>
<TOPIC> tzset() <style> function
tzset()
string tzset( string timezone)
<b>Beskrivning
Sätt tidszon.
<b>Exempel
<c> tzset("Europe/Stockholm");
</TOPIC>
<TOPIC> verify() <style> function <TOPIC> verify() <style> function
verify() verify()
...@@ -3838,6 +3855,7 @@ GetCurrentText() <t>H ...@@ -3838,6 +3855,7 @@ GetCurrentText() <t>H
GetCurrentObject() <t>Hämta utvalt objekt. <LINK> getcurrentobject() GetCurrentObject() <t>Hämta utvalt objekt. <LINK> getcurrentobject()
get_pwr_config() <t>Hämta konfigurations-värden <LINK> get_pwr_config() get_pwr_config() <t>Hämta konfigurations-värden <LINK> get_pwr_config()
get_node_name() <t>Hämta nodnamn <LINK> get_node_name() get_node_name() <t>Hämta nodnamn <LINK> get_node_name()
getmsg() <t>Hämta text för status. <LINK> getmsg()
EVEN() <t>Testa om ett värde är jämnt. <LINK> EVEN() EVEN() <t>Testa om ett värde är jämnt. <LINK> EVEN()
ODD() <t>Testa om ett värde är udda. <LINK> ODD() ODD() <t>Testa om ett värde är udda. <LINK> ODD()
get_language() <t>Hämta nuvarande språk <LINK> get_language() get_language() <t>Hämta nuvarande språk <LINK> get_language()
...@@ -3993,6 +4011,21 @@ Returnerar nodnamnet. ...@@ -3993,6 +4011,21 @@ Returnerar nodnamnet.
<c> name = get_node_name(); <c> name = get_node_name();
</TOPIC> </TOPIC>
<TOPIC> getmsg() <style> function
getmsg()
string getmsg(int status)
<b>Beskrivning
Hämta texten för ett status värde.
Returnerar texten.
<b>Exempel
<c> msg = getmsg(sts);
</TOPIC>
<TOPIC> EVEN() <style> function <TOPIC> EVEN() <style> function
EVEN() EVEN()
......
...@@ -99,7 +99,7 @@ subscriptions etc. ...@@ -99,7 +99,7 @@ subscriptions etc.
<td>Get the object identity of the next object in the list of <td>Get the object identity of the next object in the list of
objects of a certain class.</td></tr> objects of a certain class.</td></tr>
<tr><td>gdh_GetPreviousObject()</td> <tr><td>gdh_GetPreviousObject()</td>
<td>Get the object identity of the previous obuect in the list <td>Get the object identity of the previous object in the list
of objects of a certain class.</td></tr> of objects of a certain class.</td></tr>
<tr><td>gdh_GetClassListAttrRef()</td> <tr><td>gdh_GetClassListAttrRef()</td>
<td>Get the attribute reference of the first object in the list <td>Get the attribute reference of the first object in the list
...@@ -260,7 +260,7 @@ subscriptions etc. ...@@ -260,7 +260,7 @@ subscriptions etc.
<h3>Object alarm status</h3><h4> </h4> <h3>Object alarm status</h3><h4> </h4>
<table border="1" cellspacing="0"> <table border="1" cellspacing="0">
<tr><td>gdh_GetAlarmInfo()</td> <tr><td>gdh_GetAlarmInfo()</td>
<td>Get the alarm status for a certaion object.</td></tr> <td>Get the alarm status for a certain object.</td></tr>
<tr><td>gdh_SetAlarmLevel()</td> <tr><td>gdh_SetAlarmLevel()</td>
<td>This routine sets the alarm level for a certain object.</td></tr> <td>This routine sets the alarm level for a certain object.</td></tr>
<tr><td>gdh_SetAlarmBlockLevel()</td> <tr><td>gdh_SetAlarmBlockLevel()</td>
...@@ -280,6 +280,34 @@ subscriptions etc. ...@@ -280,6 +280,34 @@ subscriptions etc.
<td>Change the data of an object or attribute.</td></tr> <td>Change the data of an object or attribute.</td></tr>
</table> </table>
<h3>Threadsafe functions for times and strings</h3><h4> </h4>
<table border="1" cellspacing="0">
<tr><td>gdh_GetTimeDL()</td>
<td>Fetch a direct linked absolute time value.</td></tr>
<tr><td>gdh_SetTimeDL()</td>
<td>Store a direct linked absolute time value.</td></tr>
<tr><td>gdh_GetDeltaTimeDL()</td>
<td>Fetch a direct linked delta time value.</td></tr>
<tr><td>gdh_SetDeltaTimeDL()</td>
<td>Store a direct linked delta time value.</td></tr>
<tr><td>gdh_GetStrDL()</td>
<td>Fetch a direct linked string value.</td></tr>
<tr><td>gdh_SetStrDL()</td>
<td>Store a direct linked string value.</td></tr>
<tr><td>gdh_GetObjectInfoTime()</td>
<td>Fetch an absolute time value from an attribute.</td></tr>
<tr><td>gdh_SetObjectInfoTime()</td>
<td>Store a absolute time value from an attribute.</td></tr>
<tr><td>gdh_GetObjectInfoDeltaTime()</td>
<td>Fetch a delta time value from an attribute.</td></tr>
<tr><td>gdh_SetObjectInfoDeltaTime()</td>
<td>Store a delta time value from an attribute.</td></tr>
<tr><td>gdh_GetObjectInfoStr()</td>
<td>Fetch a string value from an attribute.</td></tr>
<tr><td>gdh_SetObjectInfoStr()</td>
<td>Store a string value from an attribute.</td></tr>
</table>
<h3>Translating between different object representations</h3><h4> </h4> <h3>Translating between different object representations</h3><h4> </h4>
<table border="1" cellspacing="0"> <table border="1" cellspacing="0">
<tr><td>gdh_ObjidToName()</td> <tr><td>gdh_ObjidToName()</td>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment