![]() |
tcio
|
Functions | |
DLL_RESULT | TC4GetFnBlockAmplitudeAndInputScalingAct (unsigned int type, double *pAmplitudeAct, double *pInputScalingAct) |
Get amplitude and AAP input scale actual values of a selected function block (e.g. if ramps active) | |
DLL_RESULT | TC4GetFnBlockAmplitudeAndInputScalingRef (unsigned int type, double *pAmplitudeRef, double *pInputScalingRef) |
Get amplitude and AAP input scale reference value of a selected function block (e.g. if ramps active) | |
DLL_RESULT | TC4GetFnBlockSettings (struct T_FnBlock *pFnblock, unsigned int type) |
Amplitude -, offset - and AAP-input-scaling. | |
DLL_RESULT | TC4GetFnSeqActionResult (int *pResult) |
Check state of last started FnSeqAction (e.g. loading, storing, deleting funtion sequences) | |
DLL_RESULT | TC4GetFnSeqMaxSupportedVersion (unsigned int *pMaxVersion) |
This function allows to check the possibilities of the different TFE versions. | |
DLL_RESULT | TC4GetFnSeqSettings (struct T_FnSeq *pFnseq) |
Read header information. | |
DLL_RESULT | TC4GetFuncgenActiveRampsBitmask (unsigned int *pActiveRampsBitmask) |
Determine if any funcgen ramp is active. | |
DLL_RESULT | TC4GetFuncgenRampTimeAct (unsigned int RampSelector, double *pRemainingSeconds) |
Ramp time definition. | |
DLL_RESULT | TC4GetIsAnyFuncgenRampActive (unsigned int *pIsActive) |
Determine if any funcgen ramp is active. | |
DLL_RESULT | TC4SetFnBlockAmplitudeAndInputScalingRef (unsigned int type, double amplitudeRef, double inputScalingRef) |
Set amplitude and AAP input scale reference value of a selected function block (e.g. if ramps active) Not passible if calculated SAS curve active. | |
DLL_RESULT | TC4SetFnBlockSettings (struct T_FnBlock *pFnblock, unsigned int type) |
Amplitude -, offset - and AAP-input-scaling. | |
DLL_RESULT | TC4SetFnBlockUserDataStartAddr (unsigned int type) |
Storing user-defined AAP values After copying of settings to flash, the slope values have to be stored also. The values are copied into flash memory. In order to provide empty space on reserved locations, the function TC4SetFnSeqActionStore does it. | |
DLL_RESULT | TC4SetFnSeqActionLoad (unsigned int SeqNr) |
Loading a slope. | |
DLL_RESULT | TC4SetFnSeqActionStore (unsigned int SeqNr, int copyUserData) |
Transfer of settings into flash. | |
DLL_RESULT | TC4SetFnSeqCommand (unsigned int cmd) |
Start / Stop of a function sequence. | |
DLL_RESULT | TC4SetFnSeqHeader (struct T_FnSeqHeader *pHeader) |
Storing header information. | |
DLL_RESULT | TC4SetFnSeqMaxUserCompatibleVersion (unsigned int MaxUserVersion) |
This function allows to check the possibilities of the different TFE versions. | |
DLL_RESULT | TC4SetFnSeqSettings (struct T_FnSeq *pFnseq) |
Storing header information. | |
DLL_RESULT | TC4SetFuncgenRampTime (double pRampTime) |
Ramp time definition. | |
DLL_RESULT | TC4SetNextUserAAPData (unsigned int type, int *pInput, int *pAmplitude, unsigned int maxAmplitude, unsigned int writeSize) |
This function ist used to store user-defined AAP values into non-volatile flash memory. |
These functions belong to the TopCon Function Engine (internal function generator).
DLL_RESULT TC4GetFnBlockAmplitudeAndInputScalingAct | ( | unsigned int | type, |
double * | pAmplitudeAct, | ||
double * | pInputScalingAct | ||
) |
Get amplitude and AAP input scale actual values of a selected function block (e.g. if ramps active)
[in] | type | select the function block: 0: voltage 1: current 2: power |
[out] | pAmplitudeAct | physical value of selected block type |
[out] | pInputScalingAct | as normalized vales [0.125...10.0] (the values correspond in percentage from [12.5%...1000.0%]) |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetFnBlockAmplitudeAndInputScalingRef | ( | unsigned int | type, |
double * | pAmplitudeRef, | ||
double * | pInputScalingRef | ||
) |
Get amplitude and AAP input scale reference value of a selected function block (e.g. if ramps active)
[in] | type | select the function block: 0: voltage 1: current 2: power |
[out] | pAmplitudeRef | physical value of selected block type |
[out] | pInputScalingRef | as normalized vales [0.125...10.0] (the values correspond in percentage from [12.5%...1000.0%]) |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetFnBlockSettings | ( | struct T_FnBlock * | pFnblock, |
unsigned int | type | ||
) |
Amplitude -, offset - and AAP-input-scaling.
[out] | pFnblock | |
[in] | type |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetFnSeqActionResult | ( | int * | pResult | ) |
Check state of last started FnSeqAction (e.g. loading, storing, deleting funtion sequences)
[out] | pResult | 1: Unit busy, action not finished yet 0: Action completed, no errors <0: Error while execution of action: -1: Timeout during reading from flash -2: Flash location not empty -3: Sequence number doesn't exist -4: Flash full - erase some unused slopes -5: Requested action does not exist -6: No function sequence avalable -7: TCLIN is not responding -8: Wrong context (precondition of requested action not fulfilled) -9: Wrong version (action could not be executed because of an internel version conflict) -10: Tried to confirm "DeleteAllFromFlash"-action after internal timeout (1s) -11: Error on deleting all funcion sequences from flash -12: Invalid internal header detected, execution aborted to ensure data consistency -99: Reserved for internal porposes -100: overall timeout |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetFnSeqMaxSupportedVersion | ( | unsigned int * | pMaxVersion | ) |
This function allows to check the possibilities of the different TFE versions.
[out] | pMaxVersion |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetFnSeqSettings | ( | struct T_FnSeq * | pFnseq | ) |
Read header information.
[out] | pFnseq |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetFuncgenActiveRampsBitmask | ( | unsigned int * | pActiveRampsBitmask | ) |
Determine if any funcgen ramp is active.
[out] | pActiveRampsBitmask | [0...3] Voltage, 0:Amplitude, 1: Offset, 2: InputScaling, 3: OutputTransistion [4...7] Current, 4:Amplitude, 5: Offset, 6: InputScaling, 7: OutputTransistion [8...11] Power, 8:Amplitude, 9: Offset, 10: InputScaling, 11: OutputTransistion |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetFuncgenRampTimeAct | ( | unsigned int | RampSelector, |
double * | pRemainingSeconds | ||
) |
Ramp time definition.
[in] | RampSelector | [0...3] Voltage, 0: Amplitude, 1: Offset, 2: InputScaling, 3: OutputTransistion [4...7] Current, 4: Amplitude, 5: Offset, 6: InputScaling, 7: OutputTransistion [8...11] Power, 8: Amplitude, 9: Offset, 10: InputScaling, 11: OutputTransistion 12: SAS Irradiance 13: SAS Temperature |
[out] | pRemainingSeconds | time in seconds |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetIsAnyFuncgenRampActive | ( | unsigned int * | pIsActive | ) |
Determine if any funcgen ramp is active.
[out] | pIsActive |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4SetFnBlockAmplitudeAndInputScalingRef | ( | unsigned int | type, |
double | amplitudeRef, | ||
double | inputScalingRef | ||
) |
Set amplitude and AAP input scale reference value of a selected function block (e.g. if ramps active) Not passible if calculated SAS curve active.
[in] | type | select the function block: 0: voltage 1: current 2: power |
[in] | amplitudeRef | physical value of selected block type |
[in] | inputScalingRef | as normalized vales [0.125...10.0] (the values correspond in percentage from [12.5%...1000.0%]) |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4SetFnBlockSettings | ( | struct T_FnBlock * | pFnblock, |
unsigned int | type | ||
) |
Amplitude -, offset - and AAP-input-scaling.
[in] | pFnblock | |
[in] | type |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4SetFnBlockUserDataStartAddr | ( | unsigned int | type | ) |
Storing user-defined AAP values
After copying of settings to flash, the slope values have to be stored also. The values are copied into flash memory. In order to provide empty space on reserved locations, the function TC4SetFnSeqActionStore does it.
[in] | type | Defines the assignment of data to a function block: 0: voltage 1: current 2: power |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4SetFnSeqActionLoad | ( | unsigned int | SeqNr | ) |
Loading a slope.
[in] | SeqNr | Sequence number [1...999] |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4SetFnSeqActionStore | ( | unsigned int | SeqNr, |
int | copyUserData | ||
) |
Transfer of settings into flash.
[in] | SeqNr | Sequence number of the stored slope |
[in] | copyUserData | This value has to be set to 0 |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4SetFnSeqCommand | ( | unsigned int | cmd | ) |
Start / Stop of a function sequence.
cmd | Valid values: 1: stop Stops the function sequence 2: start Starts function sequence from beginning 3: pause Pauses the execution of the function sequence 4: resume continues the execution of the function sequence (if paused) |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4SetFnSeqHeader | ( | struct T_FnSeqHeader * | pHeader | ) |
Storing header information.
[in] | pHeader |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4SetFnSeqMaxUserCompatibleVersion | ( | unsigned int | MaxUserVersion | ) |
This function allows to check the possibilities of the different TFE versions.
[in] | MaxUserVersion | 0: first Version 1: additional FnBlock for AAP-Flags 2: additional FnBlock for AAP-Input-Scaling (std.) 3: user knows header extension version (for SAS-Option only) |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4SetFnSeqSettings | ( | struct T_FnSeq * | pFnseq | ) |
Storing header information.
[in] | pFnseq |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4SetFuncgenRampTime | ( | double | pRampTime | ) |
Ramp time definition.
[in] | pRampTime | in [s] |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4SetNextUserAAPData | ( | unsigned int | type, |
int * | pInput, | ||
int * | pAmplitude, | ||
unsigned int | maxAmplitude, | ||
unsigned int | writeSize | ||
) |
This function ist used to store user-defined AAP values into non-volatile flash memory.
[in] | type | Identical to type-value of DLL function TC4SetFnBlockUserDataStartAddr 0: voltage 1: current 2: power |
[in] | pInput | AAP input value (voltage, current, power, depending on AAPInputType) All values normalized to system nominal data. If AAPInputType: 0: 4000 equals system nominal voltage 1: 4000 equals system nominal current 2: 4000 equals system nominal power See also the discription of Structure T_FnBlock |
[in] | pAmplitude | Amplitude value (voltage, current power according to type) Use normalized values [0...4000] If type: 0: 4000 equals system maximum voltage 1: 4000 equals system maximum current 2: 4000 equals system maximum power |
[in] | maxAmplitude | Maximum value of all user-defined amplitudes of the used function block. Use normalized values [0...4000] - Calculate like pAmlitude above. See also the discription of Structure T_FnBlock |
[in] | writeSize | Value range: [1...8] up to 8 data points may be stored per one DLL-call. If value is between [2...8], pInput and pAmplitude will be treated as an array with the size of writeSize. If more than the writeSize values need to be saved, use this DLL-function repeatedly. Example Number of data points (UserDefNumPoints) = 20 1) Call DLL-function 20 times (once for each point) with writeSize = 1 or 2) Call DLL-function 2 times with writeSite = 8 and once with writeSize = 4 |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs