Pepperl+Fuchs OPC - Page 63

OPC / OPD / OPE
Appendix
2015-07
63
Library Events
void SaveSettingsToFile(string filename)
Saves the current parameter set to the specified file. The current parameter set is
retrieved from the sensor and saved after receipt. After a successful save, a
SaveDataOnHdd event is triggered. If an error occurs during a save, an
InternalError event is triggered with ErrorType = SAVE_FILE_ERROR.
filename: Valid path and file name
bool SetAllParameters(string filename)
Loads a parameter set from the specified file and sends the parameters to the
sensor. After the sensor has acknowledged receipt of the parameter set, a
ParameterDataReceived event is triggered with Modifier = NONE. If the
data set cannot be loaded correctly, an InternalError event is triggered with
ErrorType = LOAD_FILE_ERROR.
filename: Valid path and file name
void SetNetworkSettings(string·ipAddress, string networkMask,
string gateway)
ipAddress: Valid IP address
networkMask: Valid network mask
gateway: Valid gateway
Converts the n etwork parameters on the se nsor. The connection to the sensor is
then disconnected and a DisconnectReceived event is triggered. The
connection must be reestablished with the new IP via Connect .
void SendImage(Bitmap image)
Sends an image to the sensor. This function is not supported by all device types.
image: Image to be sent
void SendVsxFile(string filepath)
filepath: Path and file name of a valid VSX file
Sends the content of a file to the sensor. This must comply with the VSX
standard. If the data cannot be loaded properly or does not correspond to the
VSX syntax, an InternalError event with ErrorType =
LOAD_FILE_ERROR is triggered.
string SensorName { get; }
Returns the name of the sensor.
float SensorVsxVersion { get; }
Returns the VSX version installed on the sensor.
event ParameterDataReceived(DataModifier modifier)
This is always triggered if parameter data has been received from the sensor.
This is the case after the following function call:
LoadSensorSettings ·(MODIFIER = LOAD_DATA)
GetAllParametersFromSensor·(MODIFIER = NONE)
SetSingleParameter ·(MODIFIER = NONE)
ResetSensor·(MODIFIER = LOAD_DEFAULT_DATA)
SetAllParameters·(MODIFIER = NONE)
Whenever this event is triggered, the internal list of parameters has been
updated and the individual parameter values should be retrieved with
GetSingleParameter.
event SensorResultDataReceived(ushort framecounter)
This is triggered when result data is received from the sensor. The parameter is
an image number that allows the data to be assigned to the corresponding
image. The individual results data can be retrieved with
GetResultParameter.