PyCustomBlock

The behavior of this block can be user-defined in Python language.

    PyCustomBlock

Library

CustomBlocks

Description

The Python Custom block provides a generic interface for specifying its properties and defining its simulation function. The simulation function is specified as an PY code and stored as a block parameter. The Python code is used during simulation.

For more details, see the Extended Definitions for Advanced Users.

Parameters

PyCustomBlock_0

NameLabelDescriptionData TypeValid Values

nin

Number of input ports

Number

inports

Input port parameters

Structure

inports/inrow

Row size

Cell of scalars

inports/incol

Column size

Cell of scalars

inports/it

Type

Cell of strings

'double'
'complex'
'int32'
'int16'
'int8'
'uint32'
'uint16'
'uint8'
'boolean'

inports/depu

Feedthrough

Cell of scalars

0
1

inports/name

Name

Cell of strings

nevin

Number of input event ports

Number

nout

Number of output ports

Number

outports

Output port parameters

Structure

outports/outrow

Row size

Cell of scalars

outports/outcol

Column size

Cell of scalars

outports/ot

Type

Cell of strings

'double'
'complex'
'int32'
'int16'
'int8'
'uint32'
'uint16'
'uint8'
'boolean'

outports/name

Name

Cell of strings

nevout

Number of output event ports

Number

evoutports

Initial firing values

Structure

evoutports/fir

Firing (<0 for no firing)

Cell of scalars

PyCustomBlock_1

NameLabelDescriptionData TypeValid Values

xx

Initial continuous state

Vector

xd

Initial state derivative

Vector

z

Initial discrete state

Vector

noz

Number of initial object states

Number

ozparams

Initial object states

Structure

ozparams/oztyp

Type

Cell of strings

'double'
'complex'
'int32'
'int16'
'int8'
'uint32'
'uint16'
'uint8';
'int64'
'uint64'
'boolean'

ozparams/ozvalue

Value

Cell of matrices

ozparams/name

Name

Cell of strings

PyCustomBlock_2

NameLabelDescriptionData TypeValid Values

rpar

Real parameters vector

Vector

ipar

Integer parameters vector

Vector

nopar

Number of object parameters

Number

oparparams

Object parameters

Structure

oparparams/opartyp

Type

Cell of strings

'double'
'complex'
'int32'
'int16'
'int8'
'uint32'
'uint16'
'uint8'
'boolean'
'int64'
'uint64'
'string'

oparparams/oparvalue

Value

oparparams/name

Name

Cell of strings

PyCustomBlock_3

NameLabelDescriptionData TypeValid Values

inlined

Inlined Python code

Number

0
1

code

Function code

String

fcn

Function

Structure

fcn/slib

Python file path

Cell of strings

fcn/epoint

Python function name

Cell of strings

impl

Implicit block (function)

Number

0
1

PyCustomBlock_4

NameLabelDescriptionData TypeValid Values

nmode

Number of modes

Scalar

nzcr

Number of zero-crossings

Scalar

dept

Activation mode

String

'Always
Active
mode'
'Initially
Active
mode'
'Standard
mode'

Ports

NameTypeDescriptionIO TypeNumber

Port 1

explicit

output

nout

Port 2

explicit

input

nin

Port 3

activation

input

nevin

Port 4

activation

output

nevout

See Also