jupedsim.library#

Module Contents#

set_debug_callback(fn: Callable[[str], None]) → None[source]#

Set receiver for debug messages.

Parameters:

fn (fn<str>) – function that accepts a msg as string

Return type:

None

set_info_callback(fn: Callable[[str], None]) → None[source]#

Set receiver for info messages.

Parameters:

fn (fn<str>) – function that accepts a msg as string

Return type:

None

set_warning_callback(fn: Callable[[str], None]) → None[source]#

Set receiver for warning messages.

Parameters:

fn (fn<str>) – function that accepts a msg as string

Return type:

None

set_error_callback(fn: Callable[[str], None]) → None[source]#

Set receiver for error messages.

Parameters:

fn (fn<str>) – function that accepts a msg as string

Return type:

None

class BuildInfo[source]#
property git_commit_hash: str[source]#

SHA1 commit hash of this version.

Returns:

SHA1 of this version.

Return type:

str

property git_commit_date: str[source]#

Date this commit was created.

Returns:

Date the commit of this version as string.

Return type:

str

property git_branch: str[source]#

Branch this commit was crated from.

Returns:

name of the branch this version was build from.

Return type:

str

property compiler: str[source]#

Compiler the native code was compiled with.

Returns:

Compiler identification.

Return type:

str

property compiler_version: str[source]#

Compiler version the native code was compiled with.

Returns:

Compiler version number.

Return type:

str

property library_version: str[source]#
Return type:

str

get_build_info() → BuildInfo[source]#

Get build information about jupedsim.

The received BuildInfo is printable, e.g.

print(get_build_info())

This will display a human-readable string stating basic information about this library.

Return type:

BuildInfo