IFdtCommunication::GetSupportedProtocols() method information

M&M FDT 1.2.1 Online Specification
IFdtCommunication::GetSupportedProtocols() method information

Interfaces and Methods - Schemas - FDT Specification - Quicklinks - Abbreviations

4.5.3.4 IFdtCommunication::GetSupportedProtocols()

This method can be called in the states:

HRESULT GetSupportedProtocols (
[out, retval] FdtXmlDocument* result
);

Description:

Gets a document describing the supported protocols of the communication interface.

Parameters:

Return Value:

result

XML document specified by DTMProtocolsSchema describing the protocols supported by the communication interface.

Behavior:

Via this method the DTM that wants to establish a connection asks the next communication component for the supported protocols. The method returns an XML document with fieldbus protocol UUIDs specified by DTMProtocolsSchema. Only protocols supported by the configured sub-device can be returned. If a channel supports more than one protocol during runtime it has to support all protocols in parallel. GetSupportedProtocols() has to return static information if a child is connected to the channel because a change may cause an invalid topology. Which protocols are supported can be determined during topology planning (see ValidateAddChild(), OnAddChild()) . So if the communication channel can be configured to support different protocols, this can only be done if there are no connected childes.

Comments:

A DTM, which wants to use more than one protocol, has to ask the channel for its supported protocols before it starts the communication.

Related dtmINSPECTOR hints:

Thomas Weller
created on 2006-08-03, last updated on 2006-08-03

The element <CommunicationTypeEntry> is mandatory. In DTMInformationSchema is is marked as optional to be backward compatibel. The element was introduced with FDT 1.2 Addendum. Presence of this element is first tested with the official release of dtmINSPECTOR 1.2 The new test case is TcExGetInformation_E.
Other methods which also need to be updated: IDtmInformation::GetInformation() and IDtmParameter::GetParameters().

© by M&M Software GmbH, parts of this website taken from FDT Interface Specification Version 1.2.1, © by FDT Group, AISBL.
This website is published for support of M&M products as granted in license conditions, chapter 2.1.
Last updated 2015-02-05 15:17
Email: FDT Technical Support Line.