ElementsExamples package

Submodules

ElementsExamples.PyBind11ProgramExample module

ElementsExamples.PythonModuleExample module

Small example for a python module

class ElementsExamples.PythonModuleExample.ClassExample(my_list)

Bases: object

This is an example of the most basic Python class

logger = <Logger ClassExample (INFO)>

static product(first, second)

This is an example static method

Parameters:

• first – The first number
• second – The second number

Returns:

The product of the two numbers

sumListValues()

Method summing the elements of the list

ElementsExamples.PythonProgramExample module

Small example for a python based script

ElementsExamples.PythonProgramExample.defineSpecificProgramOptions()

Allows to define the (command line and configuration file) options specific to this program. See the ElementsProgram documentation for more details.

Returns:An ArgumentParser.

ElementsExamples.PythonProgramExample.mainMethod(args)

The “main” method. This method is the entry point to the program. In this sense, it is similar to a main (and it is why it is called mainMethod()). The code below contains the calls to the different classes created for the first developer’s workshop

See the ElementsProgram documentation for more details.

ElementsExamples.PythonProgramExample.myLocalLogTestFunc()

example of logging from a function

ElementsExamples.PythonTestProgramExample module

Small example for a python based script

ElementsExamples.PythonTestProgramExample.defineSpecificProgramOptions()

Allows to define the (command line and configuration file) options specific to this program. See the ElementsProgram documentation for more details.

Returns:An ArgumentParser.

ElementsExamples.PythonTestProgramExample.mainMethod(args)

The “main” method. This method is the entry point to the program. In this sense, it is similar to a main (and it is why it is called mainMethod()). The code below contains the calls to the different classes created for the first developer’s workshop. See the ElementsProgram documentation for more details.

ElementsExamples.SpawnExample module

Small example for a python based script using multiprocessing

ElementsExamples.SpawnExample.defineSpecificProgramOptions()

@brief Allows to define the (command line and configuration file) options specific to this program

@details See the Elements documentation for more details. @return An ArgumentParser.

ElementsExamples.SpawnExample.mainMethod(args)

@brief The “main” method.

@details This method is the entry point to the program. In this sense, it is similar to a main (and it is why it is called mainMethod()).

ElementsExamples.SpawnExample.worker_func(i)

ElementsExamples.SwigProgramExample module

Module contents

Definition of a python package using extend_path to create a namespace