# Wrapper

## Modules

The Python Wrapper contains of 5 modules:

`EcWrapperPython.py`
: ### *class* CEcWrapperPython
  <br/>
  EC-Wrapper base class
  <br/>
  ### *class* CEcMasterPython
  <br/>
  EC-Master
  <br/>
  ### *class* CEcMasterRasServerPython
  <br/>
  RAS Server for EC-Master
  <br/>
  ### *class* CEcMasterMbxGatewayClientPython
  <br/>
  Mailbox Gateway Client for EC-Master
  <br/>
  ### *class* CEcMasterMbxGatewayServerPython
  <br/>
  Mailbox Gateway Server for EC-Master
  <br/>
  ### *class* CEcSimulatorPython
  <br/>
  EC-Simulator
  <br/>
  ### *class* CEcSimulatorRasServerPython
  <br/>
  RAS Server for EC-Simulator
  <br/>
  ### *class* CEcRasClientPython
  <br/>
  RAS Client for EC-Master / EC-Simulator

`EcMotionPython.py`
: ### *class* CEcMotionPython
  <br/>
  EC-Motion interface

`EcWrapperPythonTypes.py`
: Python types

`EcWrapper.py`
: CPython interface (internal)

`EcWrapperTypes.py`
: CPython types (internal)

## Return code vs. exception handling

The most of all API functions returns a return code for error handling. This behaviour can be changed to throw an exception in error case by simply setting:

```python
CEcWrapperPython.EnableExceptionHandling = True # default is False
```

## API with “out” or “ref” parameters

The Python Wrapper API is based on C# code. C# supports `out` and `ref` keywords for parameters. This is not supported in Python and is solved by simply submitting `CEcWrapperPythonOutParam` or `CEcWrapperPythonRefParam` to those functions:

```python
# This function has an "out" parameter "out_oSbStatus"
def GetScanBusStatus(self, out_oSbStatus):
    # ...
    return

# Create "out" parameter
out_oStatus = CEcWrapperPythonOutParam()
# Call function
pythonWrapper.GetScanBusStatus(out_oStatus)
# Get the "out" parameter value
oStatus = out_oStatus.value
# Now, the "oStatus" object can be used
print(oStatus.dwResultCode)
```