Ident |
Type |
Attributes |
Description |
TypeIdent |
String |
public readonly |
Contains the type ident of the class. |
PortNumber |
Int |
public |
This field enables a scripted assignment to the TCP/IP port number. By default it is initialised to 6000 |
IsActive |
Bool |
public readonly |
TRUE : Instance is active remote interface,
FALSE : Instance is inactive. |
Dest_Dir |
Directory |
public pointer |
Pointer to the Directory object where the measurement data should be stored.
For a grouped measurement intended, the group directory will be created here if not already existing. |
DefaultGroupname |
String |
public |
With this field, the invoking script may supply the RemoteInterface object with a default groupname
for the next PTU -file to create, even though this value will
be overridden if a groupname is given by the client with an incoming remote request.
The default name given may contain symbolic placeholders
like e.g. SYMB_DATECODE, that will be replaced before file creation.
If neither this field nor the remote request provides a groupname, RemoteInterface will
create the new file directly in the destination directory given by <Dest_Dir> . |
RawGroupname |
String |
public |
Groupname as given by the client with an incoming remote request.
This name still contains all symbolic placeholders
just as it came from the client. Use this to compare for substitutions. |
DefaultFilename |
String |
public |
With this field, the invoking script should supply the RemoteInterface object with a default name
for the next PTU -file to create, even though this value will
be overridden if a filename is given by the client with an incoming remote request.
The default name given may contain symbolic placeholders
like e.g. SYMB_TIMECODE, that will be replaced before file creation.
If neither this field nor the remote request provides a filename, RemoteInterface will
automatically name the file "RemoteMeas_" + SYMB_DATETIMECODE + "." + SYMB_MEAS_EXT |
RawFilename |
String |
public |
Filename as given by the client with an incoming remote request.
This name still contains all symbolic placeholders
just as it came from the client. Use this to compare for substitutions. |
DefaultComment |
String |
public |
With this field, the invoking script may supply the RemoteInterface object with a default comment
for the next PTU -file to create, even though this value will
be overridden if a comment is given by the client with an incoming remote request. |
Meas_File |
TTTRFile |
public pointer |
Pointer to the logical TTTRFile object wherein the measurement data should be stored. |
TCSPC_Dev |
TCSPC |
public pointer |
Pointer to the TCSPC device which is to be used for the measurement. |
RIVariables |
RIVarEntry[*] |
public |
An array of all variables registered as feedback parameters.
For registration of a new variable use RegisterRIVar ,
to clear all registered variables or a context related subset of them use UnregisterRIVars . |
StopSendingRIVariables |
Bool |
public readonly |
TRUE : Interface received a stop measurement request, so no more feedback data is required by the client
FALSE : Currently registered feedback data will be sent to the client. |
RequestData |
RIRequestData |
public readonly |
Structure wherein the measurement descriptive data is stored as requested by the remote client. |
StopReason_Code |
Int |
public readonly |
This field enables the mentioned below events to pass a stopreason code
from the RemoteInterface requesting client. |
StopReason_Expl |
String |
public readonly |
This field enables the mentioned below events to pass a human readable explanation with the stopreason code from the RemoteInterface client.
Initially set to an empty string when a valid measurement request was received by the remote interface,
the content was received with the stop measurement message. |
ErrorCode |
Int |
public |
This field enables the mentioned below methods and events to pass an error returncode
to the RemoteInterface requesting client.
Initially set to recOK when a valid measurement request was received by the remote interface,
the content is sent with the server reply on the request message and the status reply answering on the stop measurement message. |
ErrorExpl |
String |
public |
This field enables the mentioned below events to pass a human readable explanation with the stopreason code from the RemoteInterface client.
Initially set to an empty string when a valid measurement request was received by the remote interface,
the content was received with the stop measurement message. |
IsReadyForNextRequest |
Bool |
public readonly |
TRUE : Interface is ready to receive the next request by remote control,
FALSE : Instance is still busy or blocked. |
OnMeasStart |
Event |
public |
Event hook; If defined, this event is called when a valid measurement request was received by the remote interface. |
OnMeasStop |
Event |
public |
Event hook; If defined, this event is called when a valid stop measurement message was received by the remote interface. |