gclib 2.4.0
Galil Communications Library
Loading...
Searching...
No Matches
gclibo.h
Go to the documentation of this file.
1#pragma once
2
3#include "gclib.h"
4
5#ifndef _WIN32
6#pragma GCC visibility push(default)
7#endif
8
9#ifdef __cplusplus
10extern "C" {
11#endif
12
13#define MALLOCBUF G_HUGE_BUFFER
14#define MAXPROG MALLOCBUF
15#define MAXARRAY MALLOCBUF
16#define POLLINGINTERVAL 100
17#define G_USE_GCAPS
18
19GCLIB_DEPRECATED void GSleep(unsigned int timeout_ms);
27
52
85
102
103
115
116
131
132
134GCLIB_DEPRECATED GReturn GCmdT(GCon g, GCStringIn command, GCStringOut trimmed_response, GSize response_len, GCStringOut* front);
151
152
168
169
171GCLIB_DEPRECATED GReturn GCmdD(GCon g, GCStringIn command, double* value);
186
211
229
244
245
258
259
271
272
287
288
304
305
334
354
375
403
427
428
452
478
489
549
550#ifdef __cplusplus
551} //extern "C"
552#endif
553
554#ifndef _WIN32
555#pragma GCC visibility pop
556#endif
int GReturn
Every function returns a value of type GReturn. See gclib_errors.h for possible values.
int GOption
Option integer for various formatting, etc.
#define GCLIB_DEPRECATED
unsigned int GSize
Size of buffers, etc.
struct Context * GCon
Connection handle. Unique for each connection in process. Assigned a non-zero value in GOpen().
char * GCStringOut
C-string output from the library. Implies null-termination.
const char * GCStringIn
C-string input to the library. Implies null-termination.
GCLIB_DEPRECATED void GSleep(unsigned int timeout_ms)
GCLIB_DEPRECATED void GError(GReturn rc, GCStringOut error, GSize error_len)
Provides a human-readable description string for return codes.
GCLIB_DEPRECATED GReturn GVersion(GCStringOut ver, GSize ver_len)
Uses GUtility(), G_UTIL_VERSION and G_UTIL_GCAPS_VERSION to provide the library and gcaps version num...
GCLIB_DEPRECATED GReturn GCmdI(GCon g, GCStringIn command, int *value)
Wrapper around GCommand that provides the return value of a command parsed into an int.
GCLIB_DEPRECATED GReturn GCmdT(GCon g, GCStringIn command, GCStringOut trimmed_response, GSize response_len, GCStringOut *front)
Wrapper around GCommand that trims the response.
GCLIB_DEPRECATED GReturn GCmdD(GCon g, GCStringIn command, double *value)
Wrapper around GCommand that provides the return value of a command parsed into a double.
GCLIB_DEPRECATED GReturn GCmd(GCon g, GCStringIn command)
Wrapper around GCommand for use when the return value is not desired.
GCLIB_DEPRECATED GReturn GIpRequests(GCStringOut requests, GSize requests_len)
Uses GUtility(), G_UTIL_GCAPS_IPREQUEST or G_UTIL_IPREQUEST to provide a list of all Galil controller...
GCLIB_DEPRECATED GReturn GAddresses(GCStringOut addresses, GSize addresses_len)
Uses GUtility(), G_UTIL_GCAPS_ADDRESSES or G_UTIL_ADDRESSES to provide a listing of all available con...
GCLIB_DEPRECATED GReturn GInfo(GCon g, GCStringOut info, GSize info_len)
Uses GUtility() and G_UTIL_INFO to provide a useful connection string.
GCLIB_DEPRECATED GReturn GAssign(GCStringIn ip, GCStringIn mac)
Uses GUtility(), G_UTIL_GCAPS_ASSIGN or G_UTIL_ASSIGN to assign an IP address over the Ethernet to a ...
GCLIB_DEPRECATED GReturn GTimeout(GCon g, short timeout_ms)
Uses GUtility() and G_UTIL_TIMEOUT_OVERRIDE to set the library timeout.
GCLIB_DEPRECATED GReturn GWaitForBool(GCon g, GCStringIn predicate, int trials)
Blocking call that returns when the controller evaluates the predicate as true.
GCLIB_DEPRECATED GReturn GMotionComplete(GCon g, GCStringIn axes)
Blocking call that returns once all axes specified have completed their motion.
GCLIB_DEPRECATED GReturn GSetupDownloadFile(GCon g, GCStringIn file_path, GOption options, GCStringOut info, GSize info_len)
Download a saved controller configuration from a file.
GCLIB_DEPRECATED GReturn GProgramUploadFile(GCon g, GCStringIn file_path)
Program upload to file.
GCLIB_DEPRECATED GReturn GProgramDownloadFile(GCon g, GCStringIn file_path, GCStringIn preprocessor)
Program download from file.
GCLIB_DEPRECATED GReturn GArrayDownloadFile(GCon g, GCStringIn file_path)
Array download from file.
GCLIB_DEPRECATED GReturn GArrayUploadFile(GCon g, GCStringIn file_path, GCStringIn names)
Array upload to file.
GCLIB_DEPRECATED GReturn GRemoteConnections(GCStringOut connections, GSize connections_length)
Uses GUtility(), G_UTIL_GCAPS_REMOTE_CONNECTIONS to get a list of remote addresses connected to the l...
GCLIB_DEPRECATED GReturn GSetServer(GCStringIn server_name)
Uses GUtility(), G_UTIL_GCAPS_SET_SERVER to set the new active server.
GCLIB_DEPRECATED GReturn GPublishServer(GCStringIn name, GOption publish, GOption save)
Uses GUtility(), G_UTIL_GCAPS_PUBLISH_SERVER to publish local gcaps server to the local network.
GCLIB_DEPRECATED GReturn GServerStatus(GCStringOut status, GSize status_len)
Uses GUtility(), G_UTIL_GCAPS_SERVER_STATUS to get information on the local server name and if it is ...
GCLIB_DEPRECATED GReturn GListServers(GCStringOut servers, GSize servers_len)
Uses GUtility(), G_UTIL_GCAPS_LIST_SERVERS to provide a list of all available gcaps services on the l...
GCLIB_DEPRECATED GReturn GRecordRate(GCon g, double period_ms)
Sets the asynchronous data record to a user-specified period via DR.