Main Content

Classes and Methods of ASAM XIL API

To interface with test cases, the Simulink Real-Time XIL API support package supports a subset of the ASAM XIL API. The tables include API methods that you can use with the support package.

The Simulink Real-Time XIL API support package supports XIL stimulation STI/STZ for v2.0-2.2.

MAPort Class

Class

Method

Introduced in Support Package Version

MAPort

CheckVariableNames(variableNames :A_UNICODE2STRING[]) :A_UNICODE2STRING[]

21.2

MAPort

Configure(config :MAPortConfig, forceConfig :A_BOOLEAN) :void

21.2

MAPort

GetDataType(variableName :A_UNICODE2STRING) :DataType

21.2

MAPort

GetVariableInfo(variableName :A_UNICODE2STRING) :MAPortVariableInfo

21.2

MAPort

IsReadable(variableName :A_UNICODE2STRING) :A_BOOLEAN

21.2

MAPort

IsWritable(variableName :A_UNICODE2STRING) :A_BOOLEAN

21.2

MAPort

LoadConfiguration(filepath :A_UNICODE2STRING) :MAPortConfig

21.2

MAPort

StartSimulation() :void

21.2

MAPort

StopSimulation() :void

21.2

MAPort

getConfiguration() :MAPortConfig

21.2

MAPort

getState() :MAPortState

21.2

MAPort

getTaskInfos() :TaskInfo[]

21.2

MAPort

getTaskNames() :A_UNICODE2STRING[]

21.2

MAPort

getVariableNames() :A_UNICODE2STRING[]

21.2

MAPort

Dispose

21.2

MAPort

Disconnect

21.2

MAPort

IBaseValue Read(string variableName);

22.1

MAPort

void Write(string variableName, IBaseValue value);

22.1

MAPort

ICapture CreateCapture(string taskName)

22.1

MAPort

void MAPort::DownloadParameterSets(IList<string> filepaths)

22.2

ECUMPort Class

Class

Method

Introduced in Support Package Version

ECUMPort

CheckVariableNames

21.2

ECUMPort

Configure

21.2

ECUMPort

CreateCapture

21.2

ECUMPort

GetDataType

21.2

ECUMPort

GetMeasuringVariables

21.2

ECUMPort

GetVariableInfo

21.2

ECUMPort

IsReadable

21.2

ECUMPort

LoadConfiguration

21.2

ECUMPort

Read

21.2

ECUMPort

SetMeasuringVariables

21.2

ECUMPort

StartMeasurement

21.2

ECUMPort

StopMeasurement

21.2

ECUMPort

getConfiguration

21.2

ECUMPort

getState

21.2

ECUMPort

getTaskInfos

21.2

ECUMPort

getTaskNames

21.2

ECUMPort

getVariableNames

21.2

ECUMPort

Disconnect

21.2

ECUMPort

Dispose

21.2

ECUCPort Class

Class

Method

Introduced in Support Package Version

ECUCPort

CalculateRefPageCRC

21.2

ECUCPort

CalculateWorkPageCRC

21.2

ECUCPort

CheckVariableNames

21.2

ECUCPort

Configure

21.2

ECUCPort

GetDataType

21.2

ECUCPort

GetVariableInfo

21.2

ECUCPort

IsReadable

21.2

ECUCPort

IsWriteable

21.2

ECUCPort

LoadConfiguration

21.2

ECUCPort

NumberOfPages

21.2

ECUCPort

Read

21.2

ECUCPort

StartOnlineCalibration

21.2

ECUCPort

StopOnlineCalibration

21.2

ECUCPort

SwitchToRefPage

21.2

ECUCPort

SwitchToWorkPage

21.2

ECUCPort

Write

21.2

ECUCPort

getConfiguration

21.2

ECUCPort

getState

21.2

ECUCPort

getVariableNames

21.2

ECUCPort

Disconnect

21.2

ECUCPort

Dispose

21.2

CaptureEvent Class

Class

Method

Introduced in Support Package Version

CaptureEvent

getTimeStamp

23.1

CaptureEvent

setTimeStamp

23.1

CaptureEvent

getType

23.1

Capture Class

Class

Method

Introduced in Support Package Version

Capture

Fetch(whenFinished :A_BOOLEAN) :CaptureResult

21.2

Capture

Start(writer :CaptureResultWriter) :void

21.2

Capture

getCaptureResult() :CaptureResult

21.2

Capture

getState() :CaptureState

21.2

Capture

setVariables(variableNames :A_UNICODE2STRING[]) :void

21.2

Capture

getStartTriggerWatcher

23.1

Capture

getStopTriggerWatcher

23.1

Capture

getRetriggering

23.1

Capture

setRetriggering

23.1

Capture

SetStartTrigger

23.1

Capture

SetStopTrigger

23.1

WatcherFactory Class

Class

Method

Introduced in Support Package Version

WatcherFactory

CreateConditionWatcher(condition :A_UNICODE2STRING, defines :StringNamedCollection) :ConditionWatcher

23.1

WatcherFactory

CreateDurationWatcher(duration :A_FLOAT64) :DurationWatcher

23.1

WatcherFactory

CreateDurationWatcherByCycleNumber(cycleNumber :A_INT64) :DurationWatcher

23.1

WatcherFactory

CreateDurationWatcherByTimeSpan(timeSpan :A_FLOAT64) :DurationWatcher

23.1

ConditionWatcher Class

Class

Method

Introduced in Support Package Version

ConditionWatcher

getCondition

23.1

ConditionWatcher

setCondition

23.1

ConditionWatcher

getDefines

23.1

ConditionWatcher

setDefines

23.1

ConditionWatcher

getTimeOut

23.1

ConditionWatcher

setTimeOut

23.1

CapturingFactory Class

Class

Method

Introduced in Support Package Version

CapturingFactory

CreateCaptureResult

21.2

CapturingFactory

ICaptureResultMemoryWriter CreateCaptureResultMemoryWriter()

21.2

CapturingFactory

ICaptureResultMDFWriter CapturingFactory::CreateCaptureResultMDFWriter()

22.2

CapturingFactory

ICaptureResultMDFWriter CapturingFactory ::CreateCaptureResultMDFWriterByFileName(string fileName)

22.2

CapturingResult Class

Class

Method

Introduced in Support Package Version

CaptureResult

void CaptureResult::Save(ICaptureResultWriter writer)

22.2

CaptureResult

setEvents

23.1

CaptureResult

getEvents

23.1

CaptureResultMemoryWriter Class

Class

Method

Introduced in Support Package Version

CaptureResultMemoryWriter

public void Save(ICaptureResult captureResult)

21.2

CaptureResultMDFWriter Class

Class

Method

Introduced in Support Package Version

CaptureResultMDFWriter

public string FileName

22.2

CaptureResultMDFWriter

public string Version

22.2

CaptureResultMDFWriter

public bool Overwrite

22.2

CaptureResultMDFWriter

public void Save(ICaptureResult captureResult)

22.2

CycleNumberDuration Class

Class

Method

Introduced in Support Package Version

CycleNumberDuration

getCycleNumber

23.1

CycleNumberDuration

setCycleNumber

23.1

CycleNumberDuration

getType

23.1

TimeSpanDuration Class

Class

Method

Introduced in Support Package Version

TimeSpanDuration

getTimeSpan

23.1

TimeSpanDuration

setTimeSpan

23.1

TimeSpanDuration

getType

23.1

DurationFactory Class

Class

Method

Introduced in Support Package Version

DurationFactory

CreateCycleNumberDuration

23.1

DurationFactory

CreateTimeSpanDuration

23.1

DurationWatcher Class

Class

Method

Introduced in Support Package Version

DurationWatcher

getDuration

23.1

DurationWatcher

setDuration

23.1

DurationWatcher

getDuration2

23.1

ConditionWatcher Class

Class

Method

Introduced in Support Package Version

ConditionWatcher

getCondition

23.1

ConditionWatcher

setCondition

23.1

ConditionWatcher

getDefines

23.1

ConditionWatcher

setDefines

23.1

ConditionWatcher

getTimeOut

23.1

ConditionWatcher

setTimeOut

23.1

MAPORTFactory Class

Class

Method

Introduced in Support Package Version

MAPortFactory

CreateMAPort

21.2

MAPortFactory

CreateMAPortBreakpoint

See note.

MAPortFactory

CreateMAPortBreakpoint2

See note.

Note

The signature for the CreateMAPortBreakpoint method is incorrect in ASAM XIL v2.1.0. The signature for the CreateMAPortBreakpoint2 is the corrected version of the method and is contained in ASAM XIL v2.1.1.

TestBench Class

Class

Method

Introduced in Support Package Version

Testbench

WatcherFactory

23.1

Testbench

DurationFactory

23.1

Testbench

MAPortFactory

23.1

Testbench

ValueFactory

23.1

Testbench

CapturingFactory

23.1

Testbench

ECUCPortFactory

23.1

Testbench

ECUMPortFactory

23.1

Testbench

SignalGeneratorFactory

23.1

Testbench

BuildNumber

23.1

Testbench

MajorNumber

23.1

Testbench

VendorName

23.1

Testbench

ProductName

23.1

Testbench

ProductVersion

23.1

Testbench

AvailablePortTypes

23.1

Testbench

MinorNumber

23.1

Testbench

RevisionNumber

23.1

Testbench

SignalFactory

23.1

Testbench

SymbolFactory

23.1

Testbench

DurationFactory

23.1

SignalFactory Class

Class

Method

Introduced in Support Package Version

SignalFactory

CreateConstSegment():IConstSegment

22.1

SignalFactory

CreateConstSegment(IConstSymbol duration, IWatcher stopTrigger, ISymbol value):IConstSegment

22.1

SignalFactory

CreateDataFileSegment():IDataFileSegment

22.1

SignalFactory

CreateDataFileSegmentByParameters(string fileName, string timeVectorName, string dataVectorName, string channelSource, string channelPath, string groupName, string groupSource, string groupPath, IConstSymbol duration, InterpolationTypes interpolation, IConstSymbol start, IWatcher stopTrigger): IDataFileSegment

22.1

SignalFactory

CreateExpSegment():IExpSegment

22.1

SignalFactory

CreateExpSegmentBySymbols(IConstSymbol duration, ISymbol start, ISymbol stop, IWatcher stopTrigger, ISymbol tau):IExpSegment

22.1

SignalFactory

CreateIdleSegment():IIdleSegment:IIdleSegment

22.1

SignalFactory

CreateIdleSegmentByDuration(IConstSymbol duration, IWatcher stopTrigger):IIdleSegment

22.1

SignalFactory

CreateLoopSegment():ILoopSegment

22.1

SignalFactory

CreateLoopSegmentByLoopCount(ulong loopCount):ILoopSegment

22.1

SignalFactory

CreateNoiseSegment():INoiseSegment

22.1

SignalFactory

CreateNoiseSegmentBySymbols(IConstSymbol duration, ISymbol mean, ISymbol sigma, IConstSymbol seed, IWatcher stopTrigger): INoiseSegment

22.1

SignalFactory

CreateOperationSegment():IOperationSegment

22.1

SignalFactory

CreateOperationSegmentBySignalSegmentsAndOperationTypes(ISignalSegment leftSegment, ISignalSegment rightSegment, OperationTypes operation): IOperationSegment

22.1

SignalFactory

CreatePulseSegment():IPulseSegment

22.1

SignalFactory

CreatePulseSegmentBySymbols(IConstSymbol duration, ISymbol offset, ISymbol amplitude, ISymbol period, ISymbol dutyCycle, ISymbol phase, IWatcher stopTrigger):IPulseSegment

22.1

SignalFactory

CreateRampSegment():IRampSegment

22.1

SignalFactory

CreateRampSegmentBySymbols(IConstSymbol duration, ISymbol start, ISymbol stop):IRampSegment

22.1

SignalFactory

CreateRampSlopeSegment():IRampSlopeSegment

22.1

SignalFactory

CreateRampSlopeSegmentBySymbols(IConstSymbol duration, ISymbol offset, ISymbol slope, IWatcher stopTrigger):IRampSlopeSegment

22.1

SignalFactory

CreateSawSegment():ISawSegment

22.1

SignalFactory

CreateSawSegmentBySymbols(IConstSymbol duration, ISymbol offset, ISymbol amplitude, ISymbol period, ISymbol dutyCycle, ISymbol phase, IWatcher stopTrigger):ISawSegment

22.1

SignalFactory

CreateSegmentSignalDescription():ISegmentSignalDescription

22.1

SignalFactory

CreateSegmentSignalDescriptionByName(string name):ISegmentSignalDescription

22.1

SignalFactory

CreateSignalDescriptionSet():ISignalDescriptionSet

22.1

SignalFactory

CreateSignalDescriptionSetByReader(ISignalDescriptionSetReader reader):ISignalDescriptionSet

22.1

SignalFactory

CreateSignalDescriptionSetSTIReaderByFileName(string fileName):ISignalDescriptionSetSTIReader

22.1

SignalFactory

CreateSignalDescriptionSetSTIWriterByFileName(string fileName):ISignalDescriptionSetSTIWriter

22.1

SignalFactory

CreateSignalDescriptionSetSTZReaderByFileName(string fileName):ISignalDescriptionSetSTZReader

22.1

SignalFactory

CreateSignalDescriptionSetSTZWriterByFileName(string fileName):ISignalDescriptionSetSTZWriter

22.1

SignalFactory

CreateSignalValueSegment():ISignalValueSegment

22.1

SignalFactory

CreateSignalValueSegmentByValueAndInterpolation(ISignalValue value, InterpolationTypes interpolation):ISignalValueSegment

22.1

SignalFactory

CreateSineSegment():ISineSegment

22.1

SignalFactory

CreateSineSegmentBySymbols(IConstSymbol duration, ISymbol offset, ISymbol amplitude, ISymbol period, ISymbol phase, IWatcher stopTrigger):ISineSegment

22.1

SignalGeneratoryFactory Class

Class

Method

Introduced in Support Package Version

SignalGeneratorFactory

CreateSignalGenerator():ISignalGenerator

22.1

SignalGeneratorFactory

CreateSignalGeneratorSTIReader():ISignalGeneratorSTIReader

22.1

SignalGeneratorFactory

CreateSignalGeneratorSTIReaderByFileName(string fileName):ISignalGeneratorSTIReader

22.1

SignalGeneratorFactory

CreateSignalGeneratorSTIWriter():ISignalGeneratorSTIWriter

22.1

SignalGeneratorFactory

CreateSignalGeneratorSTIWriterByFileName(string fileName):ISignalGeneratorSTIWriter

22.1

SignalGeneratorFactory

CreateSignalGeneratorSTZReader():ISignalGeneratorSTZReader

22.1

SignalGeneratorFactory

CreateSignalGeneratorSTZReaderByFileName(string fileName):ISignalGeneratorSTZReader

22.1

SignalGeneratorFactory

CreateSignalGeneratorSTZWriter():ISignalGeneratorSTZWriter

22.1

SignalGeneratorFactory

CreateSignalGeneratorSTZWriterByFileName(string fileName):ISignalGeneratorSTZWriter

22.1

SignalGenerator Class

Class

Method

Introduced in Support Package Version

SignalGenerator

Load(ISignalGeneratorReader reader)

22.1

SignalGenerator

Assignments

22.1

SignalGenerator

SignalDescriptionSet

22.1

SignalGenerator

State

22.1

SignalGenerator

DestroyOnTarget()

22.1

SignalGenerator

Dispose()

22.1

SignalGenerator

LoadToTarget()

22.1

SignalGenerator

Pause()

22.1

SignalGenerator

Start()

22.1

SignalGenerator

Stop()

22.1

SignalGeneratorSTIReader

Load(out ISignalGenerator signalGenerator)

22.1

SignalGeneratorSTIWriter

Save(ISignalGenerator signalGenerator)

22.1

SignalGeneratorSTZReader

Load(out ISignalGenerator signalGenerator)

22.1

SignalGeneratorSTZWriter

Save(ISignalGenerator signalGenerator)

22.1

See Also

Related Topics

External Websites