Package ASAM :: Package HILAPI :: Package Concurrent :: Package Common :: Package Capturing :: Module Capture :: Class Capture

Class Capture

                                  object --+    
                                           |    
Interfaces.Common.Capturing.Capture.ICapture --+
                                               |
                                              Capture

Instance Methods

AddBookmarkNow(self, message)

ClearConfiguration(self)

CaptureResult

Fetch(self, whenFinished=False)
Fetch the capture data.

SetStartTriggerCondition(self, triggerDefinition, delay=None)
This is how you set the start trigger condition.

SetStopTriggerCondition(self, triggerDefinition, delay=None)
This is how you set the stop trigger condition.

Start(self, captureResultWriter=None)
Start the capture task.

Stop(self)
Stop the capture.

__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature

__repr__(self)
repr(x)

BookmarkDefinitionCollection

getBookmarkDefinitions(self)

CaptureResult

getCaptureResult(self)
Returns the Capture data results as a CaptureResult object.

float

getDownsampling(self)
Return the downsampling (decimation) value.

EDurationUnit

getDurationUnit(self)
Return the duration units value.

long

getMinBufferSize(self)
Unused by SimWB

Port

getPort(self)
Returns the model access port for this capture.

ECaptureState

getState(self)
This is the ASAM capture state (eCONFIGURED, eRUNNING, etc).

getStateMessage(self)
The target capture passes state back to the capture object over the course of a capture.

getTaskName(self)
Returns the task name of this capture.

unicode[]

getVariables(self)
Returns the list of variables to capture.

setBookmarkDefinitions(self, BMDefCollection)

setDownsampling(self, downSampling)
Set the capture data downsampling (decimation) value.

setDurationUnit(self, durationUnit)
Set the capture duration units.

setMinBufferSize(self, minBufferSize)
Unused by SimWB

setPort(self, port)
This should only be done by the CreateCapture() method.

setTaskName(self, task)
This should only be done by the CreateCapture() method.

setVariables(self, variableNames)
The variable(s) to be captured.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
	BookmarkDefinitions
	CaptureResult
	Downsampling
	DurationUnit
	MinBufferSize
	Port
	State
	TaskName
	Variables
Inherited from `object`: `__class__`

Method Details

AddBookmarkNow(self, message)

Overrides: Interfaces.Common.Capturing.Capture.ICapture.AddBookmarkNow: (inherited documentation)

ClearConfiguration(self)

Overrides: Interfaces.Common.Capturing.Capture.ICapture.ClearConfiguration

Fetch(self, whenFinished=False)

Fetch the capture data. When 'whenFinished' is true we block here until the stop condition is satisfied. Otherwise the data since the last fetch (or the start trigger) is returned in a capture result object.

Returns: CaptureResult
Overrides: Interfaces.Common.Capturing.Capture.ICapture.Fetch

SetStartTriggerCondition(self, triggerDefinition, delay=None)

This is how you set the start trigger condition. The delay is in seconds, and may be positive (post-trigger) or negative (pre-trigger).

Overrides: Interfaces.Common.Capturing.Capture.ICapture.SetStartTriggerCondition

SetStopTriggerCondition(self, triggerDefinition, delay=None)

This is how you set the stop trigger condition. The delay is in seconds, and may be positive (post-trigger) or negative (pre-trigger).

Overrides: Interfaces.Common.Capturing.Capture.ICapture.SetStopTriggerCondition

Start(self, captureResultWriter=None)

Start the capture task.

Overrides: Interfaces.Common.Capturing.Capture.ICapture.Start

Stop(self)

Stop the capture. This is an asynchronous operation and does not block.

Overrides: Interfaces.Common.Capturing.Capture.ICapture.Stop

init(self)
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

repr(self)
(Representation operator)

repr(x)

Overrides: object.__repr__: (inherited documentation)

getBookmarkDefinitions(self)

Returns: BookmarkDefinitionCollection
Overrides: Interfaces.Common.Capturing.Capture.ICapture.getBookmarkDefinitions: (inherited documentation)

getCaptureResult(self)

Returns the Capture data results as a CaptureResult object. This routine will block if the capture has not completed.

Returns: CaptureResult
Overrides: Interfaces.Common.Capturing.Capture.ICapture.getCaptureResult

getDownsampling(self)

Return the downsampling (decimation) value.

Returns: float
Overrides: Interfaces.Common.Capturing.Capture.ICapture.getDownsampling

getDurationUnit(self)

Return the duration units value.

Returns: EDurationUnit
Overrides: Interfaces.Common.Capturing.Capture.ICapture.getDurationUnit

getMinBufferSize(self)

Unused by SimWB

Returns: long
Overrides: Interfaces.Common.Capturing.Capture.ICapture.getMinBufferSize

getPort(self)

Returns the model access port for this capture.

Returns: Port
Overrides: Interfaces.Common.Capturing.Capture.ICapture.getPort

getState(self)

This is the ASAM capture state (eCONFIGURED, eRUNNING, etc).

Returns: ECaptureState
Overrides: Interfaces.Common.Capturing.Capture.ICapture.getState

getStateMessage(self)

The target capture passes state back to the capture object over the course of a capture. There may be a message attached to that state change, especially if there is an error. This method will return that message.

getVariables(self)

Returns the list of variables to capture.

Returns: unicode[]
Overrides: Interfaces.Common.Capturing.Capture.ICapture.getVariables

setBookmarkDefinitions(self, BMDefCollection)

Overrides: Interfaces.Common.Capturing.Capture.ICapture.setBookmarkDefinitions: (inherited documentation)

setDownsampling(self, downSampling)

Set the capture data downsampling (decimation) value. Must be >= 1.

Note that SimWB always records data at the simulation cycle rate. The downsampling is performed on the client side during creation of the CaptureResult object.

Overrides: Interfaces.Common.Capturing.Capture.ICapture.setDownsampling

setDurationUnit(self, durationUnit)

Set the capture duration units. This must be either eSAMPLES or eSECONDS (the default is ESECONDS).

This effects the units interpretation for the capture start and stop conditions and pre- and post-trigger delays.

Overrides: Interfaces.Common.Capturing.Capture.ICapture.setDurationUnit

setMinBufferSize(self, minBufferSize)

Unused by SimWB

Overrides: Interfaces.Common.Capturing.Capture.ICapture.setMinBufferSize

setVariables(self, variableNames)

The variable(s) to be captured. This can be a single name or a list of names. Multiple calls will append the names.

Overrides: Interfaces.Common.Capturing.Capture.ICapture.setVariables

Property Details

BookmarkDefinitions

Get Method:: getBookmarkDefinitions(self)
Set Method:: setBookmarkDefinitions(self, BMDefCollection)

CaptureResult

Get Method:: getCaptureResult(self) - Returns the Capture data results as a CaptureResult object.

Downsampling

Get Method:: getDownsampling(self) - Return the downsampling (decimation) value.
Set Method:: setDownsampling(self, downSampling) - Set the capture data downsampling (decimation) value.

DurationUnit

Get Method:: getDurationUnit(self) - Return the duration units value.
Set Method:: setDurationUnit(self, durationUnit) - Set the capture duration units.

MinBufferSize

Get Method:: getMinBufferSize(self) - Unused by SimWB
Set Method:: setMinBufferSize(self, minBufferSize) - Unused by SimWB

Port

Get Method:: getPort(self) - Returns the model access port for this capture.
Set Method:: setPort(self, port) - This should only be done by the CreateCapture() method.

State

Get Method:: getState(self) - This is the ASAM capture state (eCONFIGURED, eRUNNING, etc).

TaskName

Get Method:: getTaskName(self) - Returns the task name of this capture.
Set Method:: setTaskName(self, task) - This should only be done by the CreateCapture() method.

Variables

Get Method:: getVariables(self) - Returns the list of variables to capture.
Set Method:: setVariables(self, variableNames) - The variable(s) to be captured.

Class Capture

AddBookmarkNow(self, message)

ClearConfiguration(self)

Fetch(self, whenFinished=False)

SetStartTriggerCondition(self, triggerDefinition, delay=None)

SetStopTriggerCondition(self, triggerDefinition, delay=None)

Start(self, captureResultWriter=None)

Stop(self)

__init__(self) (Constructor)

__repr__(self) (Representation operator)

getBookmarkDefinitions(self)

getCaptureResult(self)

getDownsampling(self)

getDurationUnit(self)

getMinBufferSize(self)

getPort(self)

getState(self)

getStateMessage(self)

getVariables(self)

setBookmarkDefinitions(self, BMDefCollection)

setDownsampling(self, downSampling)

setDurationUnit(self, durationUnit)

setMinBufferSize(self, minBufferSize)

setVariables(self, variableNames)

BookmarkDefinitions

CaptureResult

Downsampling

DurationUnit

MinBufferSize

Port

State

TaskName

Variables

init(self)
(Constructor)

repr(self)
(Representation operator)