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[]	1.0
MAPort	Configure(config :MAPortConfig, forceConfig :A_BOOLEAN) :void	1.0
MAPort	GetDataType(variableName :A_UNICODE2STRING) :DataType	1.0
MAPort	GetVariableInfo(variableName :A_UNICODE2STRING) :MAPortVariableInfo	1.0
MAPort	IsReadable(variableName :A_UNICODE2STRING) :A_BOOLEAN	1.0
MAPort	IsWritable(variableName :A_UNICODE2STRING) :A_BOOLEAN	1.0
MAPort	LoadConfiguration(filepath :A_UNICODE2STRING) :MAPortConfig	1.0
MAPort	StartSimulation() :void	1.0
MAPort	StopSimulation() :void	1.0
MAPort	getConfiguration() :MAPortConfig	1.0
MAPort	getState() :MAPortState	1.0
MAPort	getTaskInfos() :TaskInfo[]	1.0
MAPort	getTaskNames() :A_UNICODE2STRING[]	1.0
MAPort	getVariableNames() :A_UNICODE2STRING[]	1.0
MAPort	Dispose	1.0
MAPort	Disconnect	1.0
MAPort	IBaseValue Read(string variableName);	1.1
MAPort	void Write(string variableName, IBaseValue value);	1.1
MAPort	ICapture CreateCapture(string taskName)	1.1
MAPort	void MAPort::DownloadParameterSets(IList<string> filepaths)	1.2

ECUMPort Class

Class	Method	Introduced in Support Package Version
ECUMPort	CheckVariableNames	1.0
ECUMPort	Configure	1.0
ECUMPort	CreateCapture	1.0
ECUMPort	GetDataType	1.0
ECUMPort	GetMeasuringVariables	1.0
ECUMPort	GetVariableInfo	1.0
ECUMPort	IsReadable	1.0
ECUMPort	LoadConfiguration	1.0
ECUMPort	Read	1.0
ECUMPort	SetMeasuringVariables	1.0
ECUMPort	StartMeasurement	1.0
ECUMPort	StopMeasurement	1.0
ECUMPort	getConfiguration	1.0
ECUMPort	getState	1.0
ECUMPort	getTaskInfos	1.0
ECUMPort	getTaskNames	1.0
ECUMPort	getVariableNames	1.0
ECUMPort	Disconnect	1.0
ECUMPort	Dispose	1.0

ECUCPort Class

Class	Method	Introduced in Support Package Version
ECUCPort	CalculateRefPageCRC	1.0
ECUCPort	CalculateWorkPageCRC	1.0
ECUCPort	CheckVariableNames	1.0
ECUCPort	Configure	1.0
ECUCPort	GetDataType	1.0
ECUCPort	GetVariableInfo	1.0
ECUCPort	IsReadable	1.0
ECUCPort	IsWriteable	1.0
ECUCPort	LoadConfiguration	1.0
ECUCPort	NumberOfPages	1.0
ECUCPort	Read	1.0
ECUCPort	StartOnlineCalibration	1.0
ECUCPort	StopOnlineCalibration	1.0
ECUCPort	SwitchToRefPage	1.0
ECUCPort	SwitchToWorkPage	1.0
ECUCPort	Write	1.0
ECUCPort	getConfiguration	1.0
ECUCPort	getState	1.0
ECUCPort	getVariableNames	1.0
ECUCPort	Disconnect	1.0
ECUCPort	Dispose	1.0

CaptureEvent Class

Class	Method	Introduced in Support Package Version
CaptureEvent	getTimeStamp	1.3
CaptureEvent	setTimeStamp	1.3
CaptureEvent	getType	1.3

Capture Class

Class	Method	Introduced in Support Package Version
Capture	Fetch(whenFinished :A_BOOLEAN) :CaptureResult	1.0
Capture	Start(writer :CaptureResultWriter) :void	1.0
Capture	getCaptureResult() :CaptureResult	1.0
Capture	getState() :CaptureState	1.0
Capture	setVariables(variableNames :A_UNICODE2STRING[]) :void	1.0
Capture	getStartTriggerWatcher	1.3
Capture	getStopTriggerWatcher	1.3
Capture	getRetriggering	1.3
Capture	setRetriggering	1.3
Capture	SetStartTrigger	1.3
Capture	SetStopTrigger	1.3

WatcherFactory Class

Class	Method	Introduced in Support Package Version
WatcherFactory	CreateConditionWatcher(condition :A_UNICODE2STRING, defines :StringNamedCollection) :ConditionWatcher	1.3
WatcherFactory	CreateDurationWatcher(duration :A_FLOAT64) :DurationWatcher	1.3
WatcherFactory	CreateDurationWatcherByCycleNumber(cycleNumber :A_INT64) :DurationWatcher	1.3
WatcherFactory	CreateDurationWatcherByTimeSpan(timeSpan :A_FLOAT64) :DurationWatcher	1.3

ConditionWatcher Class

Class	Method	Introduced in Support Package Version
ConditionWatcher	getCondition	1.3
ConditionWatcher	setCondition	1.3
ConditionWatcher	getDefines	1.3
ConditionWatcher	setDefines	1.3
ConditionWatcher	getTimeOut	1.3
ConditionWatcher	setTimeOut	1.3

CapturingFactory Class

Class	Method	Introduced in Support Package Version
CapturingFactory	CreateCaptureResult	1.0
CapturingFactory	ICaptureResultMDFWriter CapturingFactory::CreateCaptureResultMDFWriter()	1.2
CapturingFactory	ICaptureResultMDFWriter CapturingFactory ::CreateCaptureResultMDFWriterByFileName(string fileName)	1.2

CapturingResult Class

Class	Method	Introduced in Support Package Version
CaptureResult	void CaptureResult::Save(ICaptureResultWriter writer)	1.2
CaptureResult	setEvents	1.3
CaptureResult	getEvents	1.3

CycleNumberDuration Class

Class	Method	Introduced in Support Package Version
CycleNumberDuration	getCycleNumber	1.3
CycleNumberDuration	setCycleNumber	1.3
CycleNumberDuration	getType	1.3

TimeSpanDuration Class

Class	Method	Introduced in Support Package Version
TimeSpanDuration	getTimeSpan	1.3
TimeSpanDuration	setTimeSpan	1.3
TimeSpanDuration	getType	1.3

DurationFactory Class

Class	Method	Introduced in Support Package Version
DurationFactory	CreateCycleNumberDuration	1.3
DurationFactory	CreateTimeSpanDuration	1.3

DurationWatcher Class

Class	Method	Introduced in Support Package Version
DurationWatcher	getDuration	1.3
DurationWatcher	setDuration	1.3
DurationWatcher	getDuration2	1.3

ConditionWatcher Class

Class	Method	Introduced in Support Package Version
ConditionWatcher	getCondition	1.3
ConditionWatcher	setCondition	1.3
ConditionWatcher	getDefines	1.3
ConditionWatcher	setDefines	1.3
ConditionWatcher	getTimeOut	1.3
ConditionWatcher	setTimeOut	1.3

MAPORTFactory Class

Class	Method	Introduced in Support Package Version
MAPortFactory	CreateMAPort	1.0
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	1.3
Testbench	DurationFactory	1.3
Testbench	MAPortFactory	1.3
Testbench	ValueFactory	1.3
Testbench	CapturingFactory	1.3
Testbench	ECUCPortFactory	1.3
Testbench	ECUMPortFactory	1.3
Testbench	SignalGeneratorFactory	1.3
Testbench	BuildNumber	1.3
Testbench	MajorNumber	1.3
Testbench	VendorName	1.3
Testbench	ProductName	1.3
Testbench	ProductVersion	1.3
Testbench	AvailablePortTypes	1.3
Testbench	MinorNumber	1.3
Testbench	RevisionNumber	1.3
Testbench	SignalFactory	1.3
Testbench	SymbolFactory	1.3
Testbench	DurationFactory	1.3

SignalFactory Class

Class	Method	Introduced in Support Package Version
SignalFactory	CreateConstSegment():IConstSegment	1.1
SignalFactory	CreateConstSegment(IConstSymbol duration, IWatcher stopTrigger, ISymbol value):IConstSegment	1.1
SignalFactory	CreateDataFileSegment():IDataFileSegment	1.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	1.1
SignalFactory	CreateExpSegment():IExpSegment	1.1
SignalFactory	CreateExpSegmentBySymbols(IConstSymbol duration, ISymbol start, ISymbol stop, IWatcher stopTrigger, ISymbol tau):IExpSegment	1.1
SignalFactory	CreateIdleSegment():IIdleSegment:IIdleSegment	1.1
SignalFactory	CreateIdleSegmentByDuration(IConstSymbol duration, IWatcher stopTrigger):IIdleSegment	1.1
SignalFactory	CreateLoopSegment():ILoopSegment	1.1
SignalFactory	CreateLoopSegmentByLoopCount(ulong loopCount):ILoopSegment	1.1
SignalFactory	CreateNoiseSegment():INoiseSegment	1.1
SignalFactory	CreateNoiseSegmentBySymbols(IConstSymbol duration, ISymbol mean, ISymbol sigma, IConstSymbol seed, IWatcher stopTrigger): INoiseSegment	1.1
SignalFactory	CreateOperationSegment():IOperationSegment	1.1
SignalFactory	CreateOperationSegmentBySignalSegmentsAndOperationTypes(ISignalSegment leftSegment, ISignalSegment rightSegment, OperationTypes operation): IOperationSegment	1.1
SignalFactory	CreatePulseSegment():IPulseSegment	1.1
SignalFactory	CreatePulseSegmentBySymbols(IConstSymbol duration, ISymbol offset, ISymbol amplitude, ISymbol period, ISymbol dutyCycle, ISymbol phase, IWatcher stopTrigger):IPulseSegment	1.1
SignalFactory	CreateRampSegment():IRampSegment	1.1
SignalFactory	CreateRampSegmentBySymbols(IConstSymbol duration, ISymbol start, ISymbol stop):IRampSegment	1.1
SignalFactory	CreateRampSlopeSegment():IRampSlopeSegment	1.1
SignalFactory	CreateRampSlopeSegmentBySymbols(IConstSymbol duration, ISymbol offset, ISymbol slope, IWatcher stopTrigger):IRampSlopeSegment	1.1
SignalFactory	CreateSawSegment():ISawSegment	1.1
SignalFactory	CreateSawSegmentBySymbols(IConstSymbol duration, ISymbol offset, ISymbol amplitude, ISymbol period, ISymbol dutyCycle, ISymbol phase, IWatcher stopTrigger):ISawSegment	1.1
SignalFactory	CreateSegmentSignalDescription():ISegmentSignalDescription	1.1
SignalFactory	CreateSegmentSignalDescriptionByName(string name):ISegmentSignalDescription	1.1
SignalFactory	CreateSignalDescriptionSet():ISignalDescriptionSet	1.1
SignalFactory	CreateSignalDescriptionSetByReader(ISignalDescriptionSetReader reader):ISignalDescriptionSet	1.1
SignalFactory	CreateSignalDescriptionSetSTIReaderByFileName(string fileName):ISignalDescriptionSetSTIReader	1.1
SignalFactory	CreateSignalDescriptionSetSTIWriterByFileName(string fileName):ISignalDescriptionSetSTIWriter	1.1
SignalFactory	CreateSignalDescriptionSetSTZReaderByFileName(string fileName):ISignalDescriptionSetSTZReader	1.1
SignalFactory	CreateSignalDescriptionSetSTZWriterByFileName(string fileName):ISignalDescriptionSetSTZWriter	1.1
SignalFactory	CreateSignalValueSegment():ISignalValueSegment	1.1
SignalFactory	CreateSignalValueSegmentByValueAndInterpolation(ISignalValue value, InterpolationTypes interpolation):ISignalValueSegment	1.1
SignalFactory	CreateSineSegment():ISineSegment	1.1
SignalFactory	CreateSineSegmentBySymbols(IConstSymbol duration, ISymbol offset, ISymbol amplitude, ISymbol period, ISymbol phase, IWatcher stopTrigger):ISineSegment	1.1

SignalGeneratoryFactory Class

Class	Method	Introduced in Support Package Version
SignalGeneratorFactory	CreateSignalGenerator():ISignalGenerator	1.1
SignalGeneratorFactory	CreateSignalGeneratorSTIReader():ISignalGeneratorSTIReader	1.1
SignalGeneratorFactory	CreateSignalGeneratorSTIReaderByFileName(string fileName):ISignalGeneratorSTIReader	1.1
SignalGeneratorFactory	CreateSignalGeneratorSTIWriter():ISignalGeneratorSTIWriter	1.1
SignalGeneratorFactory	CreateSignalGeneratorSTIWriterByFileName(string fileName):ISignalGeneratorSTIWriter	1.1
SignalGeneratorFactory	CreateSignalGeneratorSTZReader():ISignalGeneratorSTZReader	1.1
SignalGeneratorFactory	CreateSignalGeneratorSTZReaderByFileName(string fileName):ISignalGeneratorSTZReader	1.1
SignalGeneratorFactory	CreateSignalGeneratorSTZWriter():ISignalGeneratorSTZWriter	1.1
SignalGeneratorFactory	CreateSignalGeneratorSTZWriterByFileName(string fileName):ISignalGeneratorSTZWriter	1.1

SignalGenerator Class

Class	Method	Introduced in Support Package Version
SignalGenerator	Load(ISignalGeneratorReader reader)	1.1
SignalGenerator	Save(ISignalGeneratorWriter writer)	1.1
SignalGenerator	Assignments	1.1
SignalGenerator	SignalDescriptionSet	1.1
SignalGenerator	State	1.1
SignalGenerator	DestryOnTarget()	1.1
SignalGenerator	Dispose()	1.1
SignalGenerator	LoadToTarget()	1.1
SignalGenerator	Pause()	1.1
SignalGenerator	Start()	1.1
SignalGenerator	Stop()	1.1
SignalGeneratorSTIReader	Load(out ISignalGenerator signalGenerator)	1.1
SignalGeneratorSTIWriter	Save(ISignalGenerator signalGenerator)	1.1
SignalGeneratorSTZReader	Load(out ISignalGenerator signalGenerator)	1.1
SignalGeneratorSTZWriter	Save(ISignalGenerator signalGenerator)	1.1