maxon.System

Description

Application wide system functions.

Do not use any of those functions directly.

Implement this interface to link against the kernel library.

Inheritance diagram

Methods Signature

FindDefinitionGetData(type, id[, expected])	Returns the definition of the given entity type.
GetConfiguration(index, config)	Gets the configuration value by a given index.
GetConfigurationCount()	Returns the number of configuration values registered with ConfigurationRegister.
GetConsoleOutputType()	Retrieves which types of output shall be supported.
GetCustomTimer()	Returns the current system time which is being used by the Timer class.
GetDefinitionCount(type)	Returns the total number of definitions for the given entity type.
PrivateGetInternedId(value)	Retrieve a maxon.Componenent from a maxon.Id.

Methods Definition

static System.FindDefinitionGetData(type, id, expected=None)

Returns the definition of the given entity type.

Parameters

• type (maxon.EntityBase.TYPE) –

  Entity type.

  Use maxon.EntityBase.TYPE.COUNT for the total number of methods of all (virtual and non-virtual) interfaces.

• id (maxon.Id) – Entity id.

• expected (maxon.DataType) – The expected maxon.DataType of the return value

Returns

The definition of the given entity type.

Return type

maxon.DataType specified for expected

classmethod System.GetConfiguration(index, config)

Gets the configuration value by a given index.

Parameters

• index (int) – index Index of the configuration value. 0 <= index < System.GetConfigurationCount()

• config (maxon.ConfigInit) – The config that will be filled with the data.

Returns

True on success or false if the index is out of range.

Return type

bool

static System.GetConfigurationCount()

Returns the number of configuration values registered with ConfigurationRegister.

Returns

Number of configuration values.

Return type

int

static System.GetConsoleOutputType()

Retrieves which types of output shall be supported.

Returns

Diagnostic, warning and/or critical output.

Return type

maxon.OUTPUT

static System.GetCustomTimer()

Returns the current system time which is being used by the Timer class.

Returns

maxon.Seconds of the system time.

Return type

float

static System.GetDefinitionCount(type)

Returns the total number of definitions for the given entity type.

This is used for statistics about the complexity of the whole application.

Parameters

type (maxon.EntityBase.TYPE) –

Entity type.

Use maxon.EntityBase.TYPE.COUNT for the total number of methods of all (virtual and non-virtual) interfaces.

Returns

Number of definitions of the given type.

Return type

int

static System.PrivateGetInternedId(value)

Retrieve a maxon.Componenent from a maxon.Id.

Parameters

value (maxon.Id) – The maxon.Id of the registered maxon component you want to retrieve.

Returns

The maxon component

Return type

maxon.Data