SNIP_CLASSIC_STD_SECTION_8_API_specification_TRANSFORMERGENERAL
Wortlaut
General Specification of Transformers
in the ordered transformerChain of a DataTransformation if the DataTransformation is referenced by an ISignal in the role dataTransformation where
the ISignal references a SystemSignal which is referenced by a TriggerToSignalMapping.⌋(SRS_Xfrm_00002)
[SWS_Xfrm_00046] Definition of API function <Mip>_Inv_<transformerId> ⌈
Service Name
<Mip>_Inv_<transformerId>
Syntax
uint8 <Mip>_Inv_<transformerId> (
[Std_ExtractProtocolHeaderFieldsType extractProtocolHeaderFields],
[<datatype>* csTransactionHandle],
uint8* buffer,
uint32* bufferLength,
[const uint8* inputBuffer],
uint32 inputBufferLength
)
Service ID [hex]
0x04
Sync/Async
Synchronous
Reentrancy
Non Reentrant Depends on specific transformer
extractProtocolHeader
Fields
Optional pointer to the function that shall be used to extract
relevant protocol header fields of a previous transformer in the
transformer chain. This argument only exists if the corresponding
XfrmImplementationMapping has a XfrmTransformerClassExtract
ProtocolHeaderFields.
inputBuffer
This argument only exists for transformers configured for
out-of-place transformation. It holds the input data for the
transformer. If executeDespiteDataUnavailability is set to true and
the RTE cannot provide data as input to the transformer, it will
hand over a NULL pointer to the transformer.
Parameters (in)
inputBufferLength
This argument holds the length of the transformer’s input data (in
the inputBuffer argument). If executeDespiteDataUnavailability is
set to true and the RTE cannot provide data as input to the
transformer, the length will be equal to 0.
Parameters (inout)
buffer
This argument is only an INOUT argument for transformers which
are not configured for out-of-place transformation. It is the buffer
where the input data are placed by the RTE and which is filled by
the transformer with its output. If executeDespiteData
Unavailability is set to true and the RTE cannot provide data as
input to the transformer, it will hand over a NULL pointer to the
transformer.
csTransactionHandle
Optional pointer to the transaction handle for the C/S method call.
- Used to tunnel the relevant information from the request to the
response at the server side via the RTE. This argument only
exists if the corresponding XfrmImplementationMapping has a
XfrmCSTansactionHandleImplementationDataTypeRef which
references an ImplementationDataType.
buffer
This argument is only an OUT argument for transformers
configured for out-of-place transformation. It is the buffer
allocated by the RTE, where the transformed data has to be
stored by the transformer.
Parameters (out)
bufferLength
Here, the transformer informs the Rte how large the output data
really were. It is possible that the length of the output is shorter
than the maximum buffer size allocated.
Return value
uint8
0x00 (E_OK): Transformation successful
0x01 - 0xff: Specific errors
▽
Versionen & Provenienz · Zugeordnete Anforderungen
Diese Angaben zeigt der Versions-Explorer.
Begründung & Zuweisungs-Evidenz
Preceding requirement context for trigger transformation
Dokumenten-Herkunft & Rückverfolgbarkeit
| Spezifikations-Dokument | ASWS_TransformerGeneral.pdf |
|---|---|
| Dokumentseite | Seite 40 |
| Ziel-Modul | std (classic) |
| Ziel-Anforderung | SWS_Xfrm_00105 |
| Semantische Rolle | heuristic |
| Automatisierungs-Konfidenz | 0.80 |