Main Content

getServiceInterface

Class: coder.descriptor.ServiceInterface
Namespace: coder.descriptor

Return service interface object for service interface type

Since R2022b

Syntax

serviceInterfaceTypeObj = getServiceInterface(serviceObj,serviceInterfaceType)

Description

serviceInterfaceTypeObj = getServiceInterface(serviceObj,serviceInterfaceType) returns the type of coder.descriptor.ServiceInterface object associated with the service interface type specified in serviceInterfaceType.

Input Arguments

expand all

Service interface, also referred to as the code configuration object, for which you want to retrieve the information about generated code, specified as a coder.descriptor.ServiceInterface object.

Service interface type defined in Embedded Coder Dictionary, specified as an enumerated value of coder.descriptor.Services. Specify the value as one of the following enumeration variants:

  • coder.descriptor.Services.SenderReceiver

  • coder.descriptor.Services.DataTransfer

  • coder.descriptor.Services.Timer

  • coder.descriptor.Services.Measurement

  • coder.descriptor.Services.ParameterTuning

Output Arguments

expand all

Service interface object associated with the type of service interface with corresponding properties, returned as:

Input argument: serviceInterfaceTypeOutput argument: serviceInterfaceTypeObj
coder.descriptor.Services.SenderReceivercoder.descriptor.SenderReceiverServiceInterface
coder.descriptor.Services.DataTransfercoder.descriptor.DataTransferServiceInterface
coder.descriptor.Services.Timercoder.descriptor.TimerServiceInterface
coder.descriptor.Services.Measurementcoder.descriptor.MeasurementServiceInterface
coder.descriptor.Services.ParameterTuningcoder.descriptor.ParameterTuningServiceInterface

To return a service interface object for the parameter argument tuning service interface type, pass coder.descriptor.Services.ParameterTuning to getServiceInterface, and then pass the output to getParameterArgumentInterfaces.

Version History

Introduced in R2022b