Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python API documentation update pull request (main) #271

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −0
Open

Python API documentation update pull request (main) #271

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions doc/python_api/python_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1192,6 +1192,26 @@ Checks if the referenced element is suitable for inspection with a surface check
This function checks if the given element can be inspected like a surface in the context of scripted
elements. Please see the scripted element documentation for details about the underlying scheme.

## gom.api.scriptedelements

API for handling scripted elements

This API defines various functions for handling scripted elements (actuals, checks, nominal, diagrams, ...)
It is used mostly internal by the scripted element framework.

### gom.api.scriptedelements.get_inspection_definition

```{py:function} gom.api.scriptedelements.get_inspection_definition(typename: str): Any

Return information about the given scripted element type
:param type_name: Type name of the check to query
:return: Dictionary with relevant type information or and empty dictionary if the type is unknown
:rtype: Any
```

This function queries in internal 'scalar registry' database for information about the
check with the given type.

## gom.api.services

API for accessing the script based API extensions (services)
Expand Down