EOQ3 Essential Object Query

https://eoq.gitlab.io/doc/eoq3
Admin
EOQ3 (Essential Object Query) is a framework or specification providing a standardized approach for...
Tokens:87,536
Snippets:818
Trust Score:7
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET Command Serialization Example

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Example of a GET command with a single argument.

```text
GET (!Task{(/type/name=Elevator&AND(/outputs*@SIZE;[]=l1))/name)
```

--------------------------------

### GET command in Javascript

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Example of a GET command implemented in Javascript.

```javascript
CMD.Get(QRY.Cls('Device').Sel( QRY.Pth('type').Pth('name').Equ('CPM')))
```

--------------------------------

### GET command in Python

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Example of a GET command implemented in Python.

```python
Get( Qry().Cls('Device').Sel( Qry().Pth('type').Pth('name').Equ('CPM')))
```

--------------------------------

### Example return value for GET command

Source: https://eoq.gitlab.io/doc/eoq3/10_eoq.html

A sample list of strings returned by a GET command.

```text
['Flight Control','Stick Input','Security Monitor',...]
```

--------------------------------

### GET command textual representation

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Example of a GET command textual representation.

```text
GET !Device{(/type/name='CPM') -> allCPM
```

--------------------------------

### Compound Command Example: Device and Interface Management

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

An example demonstrating how to find all Device instances and create a new Interface instance for each, using a compound transaction.

```text
GET (?Device) -> $a
GET ($a:SIZE) -> $b
CRT *M1OBJECT ($b) [avionicsSystemModel__Interface,(/*MDB/*M1MODELS:l0),Debug] -> $c
SET ($c) [name,direction] [Debug,IN]
ADD ($a) interfaces ($c)
```

```text
Cmp().Get(Cls('Device'),resName='a')
.Get(His('a').Idx('SIZE'), resName='b')
.Crt(CONCEPTS.M1OBJECT,His('b'),['avionicsSystemModel__Interface',Pth('*MDB').Pth('*M1MODELS').Idx(0),'Debug'], resName='c')
.Set(His('c'),['name','direction'],['Debug','IN'])
.Add(His('a'),'interfaces',His('c'))
```

--------------------------------

### Equals Any (EQA) Example

Source: https://eoq.gitlab.io/doc/eoq3/30_query.html

Example showing the inclusion check of elements in a structure.

```text
[[3,7],[1,5]] -> (&EQA[5,6]) -> [[b0,b0],[b0,b1]]
```

--------------------------------

### Get All Changes

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Example of retrieving all changes using the CHG command.

```text
CHG y0 y0
```

```text
Chg(0,0)
```

--------------------------------

### Install jseoq dependencies

Source: https://eoq.gitlab.io/doc/eoq3/15_gettingstarted.html

Run this command in your working directory to install jseoq and its required dependencies after creating the project files.

```bash
npm install
```

--------------------------------

### GET command syntax

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Basic syntax for the GET command using query targets.

```text
GET <target>
```

```text
Get(<target>)
```

--------------------------------

### Get Specific Changes

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Example of retrieving 20 changes starting from change ID 123.

```text
CHG y123 y20
```

```text
Chg(123,20)
```

--------------------------------

### Update Command Result Example

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Example of a successful Update (UPD) command result.

```text
RES y163 y81 [(#l104),*DOCUMENTATION,l0,n0]
```

--------------------------------

### Get (GET) Command Error Example

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

An example of an error response triggered by an invalid path segment in a Get command.

```json
{
   "cmd": "ERR",
   "a": [
      {
         "val": "U32",
         "v": 4
      },
      {
         "val": "STR",
         "v": "Subcommand 5 (GET): Segment 2 (PTH): INVALID is no valid feature: 'Item' object has no attribute 'INVALID'"
      },
      {
         "val": "STR",
         "v": ""
      }
   ]
}
```

--------------------------------

### Install pyeoq3 via pip

Source: https://eoq.gitlab.io/doc/eoq3/15_gettingstarted.html

Install the pyeoq3 package and its modules using pip.

```bash
pip install eoq3utils
```

--------------------------------

### String Serialization Examples

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Examples of serialized strings, using backslashes as escape symbols.

```text
hello-world_to_all
'hello-world_to_all'
'Hello world to all!'
'\'Hello world\'!\n(to all)'
```

--------------------------------

### Basic Textual Query Example

Source: https://eoq.gitlab.io/doc/eoq3/30_query.html

A standard example of an EOQ textual query.

```text
(!Device{(/type/name=CPM))
```

--------------------------------

### Update (UPD) Event Example

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

An example of an Update event payload.

```json
{
   "cmd": "EVT",
   "a": [
      {
         "val": "STR",
         "v": "UPD"
      },
      {
         "val": "LST",
         "v": [
            {
               "val": "U64",
               "v": "81"
            },
            {
               "val": "QRY",
               "v": [
                  {
                     "seg": "OBJ",
                     "v": [
                        {
                           "val": "U64",
                           "v": "94"
                        }
                     ]
                  }
               ]
            },
            {
               "val": "STR",
               "v": "*DOCUMENTATION"
            },
            {
               "val": "NON",
               "v": []
            },
            {
               "val": "I64",
               "v": "0"
            },
            {
               "val": "STR",
               "v": "admin"
            }
         ]
      }
   ]
}
```

--------------------------------

### Update (UPD) event example

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

A concrete example of an Update event with specific argument values.

```text
EVT UPD [y81,(#l104),*DOCUMENTATION,n0,l0,admin]
```

--------------------------------

### Start the WebSocket server

Source: https://eoq.gitlab.io/doc/eoq3/15_gettingstarted.html

Launch the WebSocket server using the pyeoq utility before running the client script.

```bash
python -m eoq3utils.services.wsdomaincli --enableSsl 0 --enableAccessControl 0
```

--------------------------------

### Nested Query Serialization Example

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Example of a query containing two nested queries.

```text
(!Task{(/type/name=Elevator&AND(/outputs*@SIZE;[]=l1))/name)
```

--------------------------------

### Retrieve list of products

Source: https://eoq.gitlab.io/doc/eoq3/10_eoq.html

A simple GET command to retrieve a list of all Product objects.

```text
GET (!Product)
```

--------------------------------

### HEL: Login example

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Initiates a session for user 'herbert'.

```text
HEL herbert topsecret
```

```text
Hel('herbert','topsecret')
```

--------------------------------

### Full result command

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Example of a full result command structure.

```text
RES [l3,l0,[(#y1),(#y2),(#y3)],[allCPM],[0]]
```

--------------------------------

### Query Serialization Example

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

A demonstration of a query string and its corresponding JSON representation.

```text
(!Task{(/type/name=Elevator&AND(/outputs*@SIZE;[]=l1))/name)
```

```json
{
   "val": "QRY",
   "v": [
      {
         "seg": "CLS",
         "v": [
            {
               "val": "STR",
               "v": "Task"
            }
         ]
      },
      {
         "seg": "SEL",
         "v": [
            {
               "val": "QRY",
               "v": [
                  {
                     "seg": "PTH",
                     "v": [
                        {
                           "val": "STR",
                           "v": "type"
                        }
                     ]
                  },
                  {
                     "seg": "PTH",
                     "v": [
                        {
                           "val": "STR",
                           "v": "name"
                        }
                     ]
                  },
                  {
                     "seg": "GRE",
                     "v": [
                        {
                           "val": "STR",
                           "v": "Elevator"
                        }
                     ]
                  },
                  {
                     "seg": "AND",
                     "v": [
                        {
                           "val": "QRY",
                           "v": [
                              {
                                 "seg": "PTH",
                                 "v": [
                                    {
                                       "val": "STR",
                                       "v": "outputs*"
                                    }
                                 ]
                              },
                              {
                                 "seg": "MET",
                                 "v": [
                                    {
                                       "val": "STR",
                                       "v": "SIZE"
                                    },
                                    {
                                       "val": "LST",
                                       "v": []
                                    }
                                 ]
                              },
                              {
                                 "seg": "EQU",
                                 "v": [
                                    {
                                       "val": "I64",
                                       "v": "1"
                                    }
                                 ]
                              }
                           ]
                        }
                     ]
                  }
               ]
            }
         ]
      },
      {
         "seg": "PTH",
         "v": [
            {
               "val": "STR",
               "v": "name"
            }
         ]
      }
   ]
}
```

--------------------------------

### Termination List-wise Result Examples

Source: https://eoq.gitlab.io/doc/eoq3/30_query.html

Examples showing how terminated values are handled in list-wise operations.

```text
[#23, #22, n0 (terminated), n0 (terminated)]
```

```text
[#23, #22, n0].
```

```text
['name1','name2',n0].
```

```text
(=n0)
```

--------------------------------

### Serialized Value Examples

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Examples of serialized values for various types, including primitives, BigInts as strings, and date arrays.

```json
{"val":"NON","v":[]}
{"val":"BOL","v":false}
{"val":"BOL","v":true}
{"val":"U32","v":1234}
{"val":"U64","v":"12345678910111213"}
{"val":"I32","v":1234}
{"val":"I32","v":-1234}
{"val":"I64","v":"12345678910111213"}
{"val":"I64","v":"-12345678910111213"}
{"val":"F32","v":3.145}
{"val":"F32","v":-3.145}
{"val":"F64","v":3.1457891011}
{"val":"F64","v":-3.1457891011}
{"val":"STR","v":"hello"}
{"val":"STR","v":""}
{"val":"DAT","v":[2025,1,1,0,0,0,0.0,0.0]}
{"val":"DAT","v":[2025,1,1,12,34,56,0.0,0.0]}
{"val":"DAT","v":[2025,1,1,12,34,56,789,0.0]}
{"val":"DAT","v":[2025,1,1,12,34,56,789,-1.5]}
{"val":"LST","v":[]}
{"val":"LST","v":[{"val":"U32","v":1},{"val":"U32","v":2},{"val":"U32","v":3}]}
```

--------------------------------

### Successful Update (UPD) Result Example

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

An example of a successful Update command result payload.

```json
{
   "cmd": "RES",
   "a": [
      {
         "val": "U64",
         "v": "69"
      },
      {
         "val": "U64",
         "v": "41"
      },
      {
         "val": "LST",
         "v": [
            {
               "val": "QRY",
               "v": [
                  {
                     "seg": "OBJ",
                     "v": [
                        {
                           "val": "U64",
                           "v": "82"
                        }
                     ]
                  }
               ]
            },
            {
               "val": "STR",
               "v": "*DOCUMENTATION"
            },
            {
               "val": "I64",
               "v": "0"
            },
            {
               "val": "NON",
               "v": []
            }
         ]
      },
      {
         "val": "LST",
         "v": []
      },
      {
         "val": "LST",
         "v": []
      }
   ]
}
```

--------------------------------

### Contains All (ALL) Variants

Source: https://eoq.gitlab.io/doc/eoq3/30_query.html

Examples showing how to check the inclusion of elements in a struct.

```text
[[3,7,5],[5,1,6]] -> (&ALL[1,5]) -> [b0,b1]
```

```text
Arr([[3,7,5],[5,1,6]]).All([1,5])
```

--------------------------------

### GET command result

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Typical result for a GET command as a list of object references.

```text
[(#y1),(#y2),(#y3)]
```

--------------------------------

### GET command and result interaction

Source: https://eoq.gitlab.io/doc/eoq3/10_eoq.html

A GET command to find all Device instances where the type name is 'CPM', followed by the corresponding RES response containing the transaction ID, change ID, and result values.

```text
GET (!Device{/type/name=CPM)
```

```text
RES y1 y0 [#y14,#15]
```

--------------------------------

### JSON Serialization: Textual Command

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Example of a JSON frame holding a textual command.

```json
{
   "frm":"ami",
   "ver":"2.9.13",
   "typ":"CMD",
   "uid":33,
   "sid":"00000000-0000-0000-0000-000000000000",
   "ser":"TXT",
   "roc":false,
   "dat":"UPD (#l104) *DOCUMENTATION n0 l0"
}
```

--------------------------------

### Terminate for Null Values

Source: https://eoq.gitlab.io/doc/eoq3/30_query.html

Example of using termination to handle null values in a path.

```text
(!ConnectionAssignmentSegment/location&TRM/name) -> ['name1','name2',n0]
```

```text
Cls('ConnectionAssignmentSegment').Pth('location').Trm().Pth('name')
```

--------------------------------

### Run AvionicsSystemSample.py

Source: https://eoq.gitlab.io/doc/eoq3/15_gettingstarted.html

Execute the sample script to demonstrate pyeoq functionality.

```bash
python AvionicsSystemSample.py
```

--------------------------------

### Addition (ADD) Variants

Source: https://eoq.gitlab.io/doc/eoq3/30_query.html

Examples of using the ADD operator for task inputs and filtering.

```text
(!Task/inputs@SIZE&ADD5)
```

```text
Cls('Task').Pth('inputs').Met('SIZE').Add(5)
```

```text
(!Task{(/type/name=Elevator&ADD(/outputs@SIZE~1)))
```

```text
Cls('Task').Sel(Pth('type').Pth('name').Equ('Elevator').Add(Pth('outputs').Met('SIZE').Neq(1)))
```

--------------------------------

### JSON Serialization: Compound Command

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Example of a compound command frame using JSON serialization.

```json
{
   "frm":"ami",
   "ver":"2.9.13",
   "typ":"CMD",
   "uid":10,
   "sid":"10000000-0000-0000-0000-000000000001",
   "ser":"JSO",
   "roc":false,
   "dat":"{\"cmd\":\"CMP\",\"a\":[{\"cmd\":\"GET\",\"a\":[{\"val\":\"STR\",\"v\":\"test\"}]},{\"cmd\":\"OBS\",\"a\":[{\"val\":\"STR\",\"v\":\"ELM\"},{\"cmd\":\"QRY\",\"v\":[{\"seg\":\"OBJ\",\"v\":[{\"val\":\"U64\",\"v\":\"58\"}]}]},{\"cmd\":\"OBS\",\"a\":[{\"val\":\"STR\",\"v\":\"ELM\"},{\"cmd\":\"QRY\",\"v\":[{\"seg\":\"OBJ\",\"v\":[{\"val\":\"U64\",\"v\":\"58\"}]}]},{\"cmd\":\"UPD\",\"a\":[{\"val\":\"QRY\",\"v\":[{\"seg\":\"OBJ\",\"v\":[{\"val\":\"U64\",\"v\":\"93\"}]}]},{\"val\":\"STR\",\"v\":\"*DOCUMENTATION\"},{\"val\":\"STR\",\"v\":\"test2\"},{\"val\":\"I64\",\"v\":\"0\"}]},{\"cmd\":\"GET\",\"a\":[{\"val\":\"QRY\",\"v\":[{\"seg\":\"OBJ\",\"v\":[{\"val\":\"U64\",\"v\":\"93\"}]},{\"seg\":\"PTH\",\"v\":[{\"val\":\"STR\",\"v\":\"INVALID\"}]}]}]}]}"
}
```

--------------------------------

### Instance of (INO) variants

Source: https://eoq.gitlab.io/doc/eoq3/30_query.html

Examples of retrieving instances of tasks, variant-dependent elements, and class objects.

```text
(?Task)
```

```text
Ino('Task')
```

```text
(/resources{(/name='MinimalFlightControl.oaam'):0/contents:0/functions?VariantDependentElementA)
```

```text
Pth('resources').Sel(Pth('name').Equ('MinimalFlightControl.oaam')).Idx(0).Pth('contents').Idx(0).Pth('functions').Ino('VariantDependentElementA')
```

```text
?(#123/*NAME)
```

```text
Ino(Obj(123).Pth('*NAME'))
```

--------------------------------

### AvionicsSystemSample.py implementation

Source: https://eoq.gitlab.io/doc/eoq3/15_gettingstarted.html

A complete Python script demonstrating how to initialize a domain, load models, and execute EOQ3 commands. It includes examples of serializing commands and results into text, Python, and JavaScript formats.

```python
1""" The 'Getting Started with pyeoq' example from the EOQ3 documentation.

Requires the following files to be in the same directory:
- avionicsSystemModel.ecore
- My.avionicssystemmodel

2025 Bjoern Annighoefer
"""
from eoq3.value import * # needed for EOQ3 programmatic value types, e.g. BOL(...), NON, STR(...), LST([...]), ...
from eoq3.command import * # needed for EOQ3 programmatic command types, e.g. Get(...), Set(...), Add(...), ...
from eoq3.query import * # needed for EOQ3 programmatic query types, e.g. Pth(...), Obj(...), Idx(...), Sel(...), ...
from eoq3.concepts import * # needed for EOQ3 concept constants, e.g. M2CLASS, M1OBJECT, M1MODEL, M2MODEL, ...
from eoq3.util.eoqfile import * # needed for EOQ3 file utilities, e.g. LoadEcoreFile, SaveEcoreFile
from eoq3.error import * # needed for to catch EOQ-specific exceptions, e.g. EOQ_ERROR, EOQ_ERROR_RUNTIME
from eoq3.serializer import TextSerializer, PySerializer, JsSerializer # needed to translate commands in different formats
from eoq3utils import DOMAIN_TYPES, CreateDomain, CleanUpDomain # helpers to simplify domain creation and cleanup
from eoq3pyecoreutils.loadecorefile import LoadEcoreFile # optional helper to load ecore files to the domain


if "__main__" == __name__:
    """The main function creates a domain, loads the metamodel and model, and executes a commands.
    """
    m2model = "avionicsSystemModel.ecore" # M2 input model
    m1model = "My.avionicssystemmodel" # M1 output model (must match the meta-model in the M2 model)
    txtSer = TextSerializer() # create a serializer to read text commands
    pySer = PySerializer() # create a serializer to show Python commands
    jsSer = JsSerializer() # create a serializer to show JavaScript commands
    # create a domain. Open CreateDomain to see how to create a domain with different types and parameters
    domain = CreateDomain(DOMAIN_TYPES.LOCAL, {}) # LOCAL domain runs in the same thread
    try:
        LoadEcoreFile(m1model,domain,metafile=m2model,loadMetamodelInAddition=True)
        # Put your command in the next line
        cmdStr = """GET (!Interface{(/direction=IN))""" # a text command
        # convert to programmatic command
        cmd = txtSer.DesCmd(cmdStr)
        # print the command
        print(f'Command as text: {cmdStr}')
        print(f'Command as python code: {pySer.SerCmd(cmd)}')
        print(f'Command as JavaScript code: {jsSer.SerCmd(cmd)}')
        # Issue command to the domain and get the result
        res = domain.Do(cmd)
        # print the result
        print(f'Result debug: {res}') # the program output (automatically converted to a string by Python)
        print(f'Result as text: {txtSer.SerVal(res)}') # the result as textual representation
        print(f'Result as python code: {pySer.SerVal(res)}')  # the result as python code
        print(f'Result as JavaScript code: {jsSer.SerVal(res)}')  # the result as JavaScript code
    finally: #make sure to clean up the domain to prevent leftover threads or processes
        CleanUpDomain(domain)
        
        
''' EXAMPLE COMMANDS FOR TRY-OUT (copy to line 33 to test)
GET (!Interface{(/direction=IN))

GET (?Device) -> $devices
SET ($devices) type B"""))

GET (?CPIOM) -> $devices
SET ($devices) type B

GET (!Interface{(/direction=IN)/name)

GET (?Device{(/interfaces/name=Analog&ANYb1&AND(/interfaces:SIZE>l1))/name)

GET (?Device) -> $a
GET ($a:SIZE) -> $b
CRT *M1OBJECT ($b) [avionicsSystemModel__Interface,(/*MDB/*M1MODELS:l0),Debug] -> $c
SET ($c) [name,direction] [Debug,IN]
ADD ($a) interfaces ($c)


GET (?Device&ARR[(/name),(/interfaces/name)])

GET (?Device{(/interfaces:SIZE>l0))

SET (!Interface) [name,direction] [Debug,IN]

GET (&ARR[(#l30),(#l2),(#l28)]{(&ARR[b1,b0,b1]))

GET (#l45)
GET hallo
GET l2
GET ($l-2)
'''
```

--------------------------------

### JSON Serialization: Update Command Frame

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Example of an update command frame using JSON serialization.

```json
{
   "frm":"ami",
   "ver":"2.9.13",
   "typ":"CMD",
   "uid":33,
   "sid":"00000000-0000-0000-0000-000000000000",
   "ser":"JSO",
   "roc":false,
   "dat":"{\"cmd\":\"UPD\",\"a\":[{\"val\":\"QRY\",\"v\":[{\"seg\":\"OBJ\",\"v\":[{\"val\":\"U64\",\"v\":\"82\"}]}]},{\"val\":\"STR\",\"v\":\"*DOCUMENTATION\"},{\"val\":\"NON\",\"v\":[]},{\"val\":\"I64\",\"v\":\"0\"}]}"
}
```

--------------------------------

### Run AvionicsSystemSample.js

Source: https://eoq.gitlab.io/doc/eoq3/15_gettingstarted.html

Execute the compiled JavaScript sample using node.

```bash
node AvionicsSystemSample.js
```

--------------------------------

### Text Serialization: Compound Command

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Example of a compound command frame using text serialization.

```text
AMI|2.9.7   |CMD|00000015|10000000-0000-0000-0000-000000000001|TXT|0
GET test
UBS ELM (#l68)
UBS ELM (#l68)
UPD (#l104) *DOCUMENTATION test2 l0
GET (#l104/INVALID)
```

--------------------------------

### Text Serialization: Result Frame

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Example of a result frame matching the update command.

```text
AMI|2.9.7   |RES|00000016|00000000-0000-0000-0000-000000000000|TXT|0
RES y163 y81 [(#l104),*DOCUMENTATION,l0,n0]
```

--------------------------------

### Text Serialization: Update Command Frame

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Example of an update command frame using text serialization.

```text
AMI|2.9.7   |CMD|00000016|00000000-0000-0000-0000-000000000000|TXT|0
UPD (#l104) *DOCUMENTATION n0 l0
```

--------------------------------

### Error response for invalid GET command

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Example of an error message returned when a GET command contains an invalid path segment.

```text
ERR u4 'Subcommand 5 (GET): Segment 2 (PTH): INVALID is no valid feature: \'Item\' object has no    attribute \'INVALID\''
```

--------------------------------

### Text Serialization: Stringified JSON Command

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Example of a text frame holding a stringified JSON command.

```text
AMI|2.9.7   |CMD|00000016|00000000-0000-0000-0000-000000000000|JSO|0
"{\"cmd\":\"UPD\",\"a\":[{\"val\":\"QRY\",\"v\":[{\"seg\":\"OBJ\",\"v\":[{\"val\":\"U64\",\"v\":\"82\"}]}]},{\"val\":\"STR\",\"v\":\"*DOCUMENTATION\"},{\"val\":\"NON\",\"v\":[]},{\"val\":\"I64\",\"v\":\"0\"}]}"
```

--------------------------------

### GET (!Product{(/sells<l3))

Source: https://eoq.gitlab.io/doc/eoq3/10_eoq.html

Retrieves a list of products that have been sold less than 3 times.

```APIDOC
## GET (!Product{(/sells<l3))

### Description
Retrieves a list of product identifiers that meet the criteria of having fewer than 3 sales.

### Method
GET

### Endpoint
!Product{(/sells<l3)

### Response
#### Success Response (200)
- **Result** (array) - A list of product identifiers (e.g., [(#y77),(#y87),...])
```

--------------------------------

### Muted GET Command with Result Name

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Example of a muted command (indicated by a leading '-') with a result name added at the end.

```text
-GET (!Task{(/type/name>Elevator)) -> $tasks
```

--------------------------------

### Contains Any (ANY) Variants

Source: https://eoq.gitlab.io/doc/eoq3/30_query.html

Examples of checking element inclusion in structures and finding functions containing specific tasks.

```text
[[3,7],[1,5]] -> (&ANY[5,6]) -> [b1,b0]
```

```text
Arr([[3,7],[1,5]]).Any([5,6])
```

```text
(!Functions{(/tasks&ANY[#43,#34]))
```

```text
Cls('Functions').Sel(Pth('tasks').Any(Arr([Obj(43),Obj(34)])))
```

--------------------------------

### HEL: Command syntax

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

General syntax for the hello command to initiate a session.

```text
HEL <user> <password>
```

```text
Hel(<user>,<password>)
```

--------------------------------

### Python representation of EOQ values

Source: https://eoq.gitlab.io/doc/eoq3/20_values.html

Example showing how BOL, I32, F32, LST, and NON values are represented in Python.

```python
true, 12, 3.14, 'string', [], None
```

--------------------------------

### Instantiate M1 model elements

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Example showing how to use the previously defined M2 model to instantiate specific M1 model elements like objects, attributes, associations, and compositions.

```text
CRT *M1MODEL u1 [STARWARS,mymodel] -> $m1MStarwars;
CRT *M1OBJECT u1 [Jedi,($m1MStarwars),Yoda] -> $m1OYoda;
CRT *M1OBJECT u1 [Jedi,($m1MStarwars),ObiWan] -> $m1OObiWan;
CRT *M1OBJECT u1 [Lightsaber,($m1MStarwars),Blue] -> $m1OBlue;
CRT *M1OBJECT u1 [Lightsaber,($m1MStarwars),Green] -> $m1OGreen;
CRT *M1OBJECT u1 [Lightsaber,($m1MStarwars),Lila] -> $m1OLila;
CRT *M1OBJECT u1 [Lightsaber,($m1MStarwars),Red] -> $m1ORed;
CRT *M1OBJECT u1 [Spaceship,($m1MStarwars),XWing] -> $m1OXWing;
CRT *M1OBJECT u1 [Spaceship,($m1MStarwars),UWing] -> $m1OUWing;
CRT *M1OBJECT u1 [Engine,($m1MStarwars),EngineA] -> $m1OEngineA;
CRT *M1OBJECT u1 [Engine,($m1MStarwars),EngineB] -> $m1OEngineB;
CRT *M1ATTRIBUTE u1 [force,($m1OYoda),l10] -> $m1Aforce1;
CRT *M1ASSOCIATION u1 [spaceship,($m1OYoda),($m1OXWing)] -> $m1Pspaceship;
CRT *M1COMPOSITION u1 [lightsabers,($m1OYoda),($m1OBlue)] -> $m1Plightsabers;
CRT *M1COMPOSITION u1 [engines,($m1OXWing),($m1OEngineA)] -> $m1Sengines;
```

--------------------------------

### Python Domain Observe Method

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Example of the pyeoq Domain.Observe method used to register a callback for received events.

```python
class Domain:
#...
   def Observe(self, callback:Callable[[List[Evt],Any,object],None], context:Any=None,
            sessionId:str=None)->None: #by default register for all events
   """Register a callback function, which is invoked when an event is received.
      callback: Callable[[List[Evt],Any,object],None] - The callback function that
         is invoked when an event is received. The first argument is a list of events,
         the second argument is the context, the third argument is the domain.
      context: Any - A unique context that helps the callback to identify the specific
         Observe registration. Context must be hashable.
      sessionId: str - The session ID of the session that wants to observe events.
         This session must have registered for the desired events before using OBS commands.
   """
```

--------------------------------

### M2Package Creation and MDB

Source: https://eoq.gitlab.io/doc/eoq3/25_concepts.html

Command to create an M2Package and access its MDB.

```text
CRT *M2PACKAGE u1 [NAME:STR, SUPERPACKAGE:M2Package]
```

```text
M2PACKAGE.MDB
```

--------------------------------

### Create Starwars M2 model elements

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Example demonstrating the creation of various M2 meta-model elements such as models, classes, attributes, associations, inheritance, and compositions for a Starwars domain.

```text
CRT *M2MODEL u1 [STARWARS] -> $m2MStarwars;
CRT *M2CLASS u1 [ForceEntity,b1,($m2MStarwars)] -> $m2CForceEntity;
CRT *M2CLASS u1 [Jedi,b0,($m2MStarwars)] -> $m2CJedi;
CRT *M2CLASS u1 [Sith,b0,($m2MStarwars)] -> $m2CSith;
CRT *M2CLASS u1 [Lightsaber,b0,($m2MStarwars)] -> $m2CLightsaber;
CRT *M2CLASS u1 [Spaceship,b0,($m2MStarwars)] -> $m2CSpaceship;
CRT *M2CLASS u1 [Engine,b0,($m2MStarwars)] -> $m2CEngine;
CRT *M2ATTRIBUTE u1 [force,($m2CForceEntity),*I64,l1,n0,n0] -> $m2Aforce;
CRT *M2ATTRIBUTE u1 [darkside,($m2CSith),*STR,l1,n0,n0] -> $m2Adarkside;
CRT *M2ATTRIBUTE u1 [knowledge,($m2CJedi),*STR,l1,n0,n0] -> $m2Aknowledge;
CRT *M2ATTRIBUTE u1 [discipline,($m2CJedi),*STR,l1,n0,n0] -> $m2Adiscipline;
CRT *M2ATTRIBUTE u1 [velocity,($m2CSpaceship),*STR,l1,n0,n0] -> $m2Avelocity;
CRT *M2ATTRIBUTE u1 [fuel,($m2CSpaceship),*STR,l1,n0,n0] -> $m2Afule;
CRT *M2ASSOCIATION u1 [owner,($m2CForceEntity),l1,spaceship,($m2CSpaceship),l1,b0] -> $m2Sspaceship_owner;
CRT *M2INHERITANCE u1 [($m2CJedi),($m2CForceEntity)] -> $m2IJedi_ForceEntity;
CRT *M2INHERITANCE u1 [($m2CSith),($m2CForceEntity)] -> $m2ASith_ForceEntity;
CRT *M2COMPOSITION u1 [lightsabers,($m2CForceEntity),($m2CLightsaber),l2,b0] -> $m2Plightsabers;
CRT *M2COMPOSITION u1 [engines,($m2CSpaceship),($m2CEngine),l4,b0] -> $m2Pengines;
```

--------------------------------

### Create command syntax for concepts

Source: https://eoq.gitlab.io/doc/eoq3/25_concepts.html

Lists the command-line syntax for creating various modeling concepts.

```text
CRT *MXMDB u1 []
CRT *MXCONSTRAINT u1 [ELEMENT:MxElement, EXPRESSION:STR]
CRT *M2PACKAGE u1 [NAME:STR, SUPERPACKAGE:M2Package]
CRT *M2MODEL u1 [NAME:STR]
CRT *M2ENUM u1 [NAME:STR, PACKAGE:M2Package]
CRT *M2OPTIONOFENUM u1 [NAME:STR, VALUE:U64, ENUM:M2Enum]
CRT *M2CLASS u1 [NAME:STR, ISABSTRACT:BOL, PACKAGE:M2Package]
CRT *M2ATTRIBUTE u1 [NAME:STR, CLASS:M2Class, PRIMTYPE:STR, MUL:I64, UNIT:STR, ENUM:M2Enum]
CRT *M2ASSOCIATION u1 [SRCNAME:STR, SRCCLASS:M2Class, SRCMUL:I64, DSTNAME:STR, DSTCLASS:M2Class, DSTMUL:I64, ANYDST:BOL]
CRT *M2COMPOSITION u1 [NAME:STR, PARENTCLASS:M2Class, CHILDCLASS:M2Class, MULCHILD:I64, ANYCHILD:BOL]
CRT *M2INHERITANCE u1 [SUBCLASS:M2Class, SUPERCLASS:M2Class]
CRT *M1MODEL u1 [M2MODEL:M2Model, NAME:STR]
CRT *M1OBJECT u1 [M2CLASS:M2Class, MODEL:M1Model, NAME:STR]
CRT *M1ATTRIBUTE u1 [M2ATTRIBUTE:M2Attribute, OBJECT:M1Object, VALUE:PRM]
CRT *M1ASSOCIATION u1 [M2ASSOCIATION:M2Association, SRC:M1Object, DST:M1Object]
CRT *M1COMPOSITION u1 [M2COMPOSITION:M2Composition, PARENT:M1Object, CHILD:M1Object]
```

--------------------------------

### Terminate Query Segment Example

Source: https://eoq.gitlab.io/doc/eoq3/60_frame.html

Example of a Terminate (TRM) query segment with arguments.

```text
&TRMn0;name
```

--------------------------------

### AvionicsSystemSample.ts implementation

Source: https://eoq.gitlab.io/doc/eoq3/15_gettingstarted.html

A complete TypeScript example demonstrating how to connect to a WebSocket domain server, execute a text-based command, and serialize the result. It requires a server running on port 5141 and specific model files to be loaded.

```typescript
/**
 * The 'Getting Started with jseoq' example from the EOQ3 documentation.
 * Requires the following files to be in the same directory:
 * - avionicsSystemModel.ecore
 * - My.avionicssystemmodel
 * - package.json
 * - tsconfig.json
 * Requires a WebSocket domain server listening on port 5141.
 * Requires the models to be loaded into the domain server beforehand.
 * 2025 Bjoern Annighoefer
 */
import { VAL,BOL,U32,U64,I32,I64,F32,F64,STR,DAT,NON,LST } from 'eoq3/value';// needed for EOQ3 programmatic value types, e.g. BOL(...), NON, STR(...), LST([...]), ...
import { Get, Set, Add } from 'eoq3/command';// needed for EOQ3 programmatic command types, e.g. Get(...), Set(...), Add(...), ...
import { Pth, Obj, Idx, Sel } from 'eoq3/query';// needed for EOQ3 programmatic query types, e.g. Pth(...), Obj(...), Idx(...), Sel(...), ...
import { CONCEPTS, M2CLASS, M1OBJECT, M1MODEL, M2MODEL  } from 'eoq3/concepts';// needed for EOQ3 concept constants, e.g. M2CLASS, M1OBJECT, M1MODEL, M2MODEL, ...
import { EOQ_ERROR, EOQ_ERROR_RUNTIME } from 'eoq3/error';// needed for to catch EOQ-specific exceptions, e.g. EOQ_ERROR, EOQ_ERROR_RUNTIME, ...
import { TextSerializer, PySerializer, JsSerializer } from 'eoq3/serializer';
import { WebSocketDomainClient } from 'eoq3/domainwrappers';


async function main() {
    let txtSer = new TextSerializer(); // create a serializer to read text commands
    let pySer = new PySerializer(); // create a serializer to show Python commands
    let jsSer = new JsSerializer(); // create a serializer to show JavaScript commands
    // Initialize a the WebSocket domain client
    let domain = new WebSocketDomainClient();
    await domain.Connect('ws://localhost:5141');
    try {
        // Put your command in the next line
        let cmdStr = `GET (!Interface{(/direction=IN))`; // a text command
        // convert to programmatic command
        let cmd = txtSer.DesCmd(cmdStr);
        // print the command
        console.log(`Command as text: ${cmdStr}`);
        console.log(`Command as python code: ${pySer.SerCmd(cmd)}`);
        console.log(`Command as JavaScript code: ${jsSer.SerCmd(cmd)}`);
        // Issue command to the domain and get the result
        let res = await domain.Do(cmd);
        // print the result
        console.log(`Result debug: ${res}`); // the program output (automatically converted to a string by TypeScript)
        if (res instanceof VAL) { // check if the result is a value, since typescript is type safe
            console.log(`Result as text: ${txtSer.SerVal(res)}`); // the result as textual representation
            console.log(`Result as python code: ${pySer.SerVal(<VAL>res)}`);  // the result as python code
            console.log(`Result as JavaScript code: ${jsSer.SerVal(res)}`);  // the result as JavaScript code
        }
    } catch (error) {
        if (error instanceof EOQ_ERROR || error instanceof EOQ_ERROR_RUNTIME) {
            console.error('EOQ specific error:', error);
        } else {
            console.error('Unexpected error:', error);
        }
    } finally {
        // make sure to clean up the domain to prevent leftover threads or processes
        domain.Close();
    }
}

main();

/** EXAMPLE COMMANDS FOR TRY-OUT (copy to line 33 to test)
GET (!Interface{(/direction=IN))

GET (?Device) -> $devices
SET ($devices) type B"""))

GET (?CPIOM) -> $devices
SET ($devices) type B

GET (!Interface{(/direction=IN)/name)

GET (?Device{(/interfaces/name=Analog&ANYb1&AND(/interfaces:SIZE>l1))/name)

GET (?Device) -> $a
GET ($a:SIZE) -> $b
CRT *M1OBJECT ($b) [avionicsSystemModel__Interface,(/*MDB/*M1MODELS:l0),Debug] -> $c
SET ($c) [name,direction] [Debug,IN]
ADD ($a) interfaces ($c)


GET (?Device&ARR[(/name),(/interfaces/name)])

GET (?Device{(/interfaces:SIZE>l0))

SET (!Interface) [name,direction] [Debug,IN]

GET (&ARR[(#l30),(#l2),(#l28)]{(&ARR[b1,b0,b1]))

GET (#l45)
GET hallo
GET l2
GET ($l-2)
*/
```

--------------------------------

### Example UUID4 Session ID

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

An example of a valid session ID following the UUID4 standard.

```text
550e8400-e29b-41d4-a716-446655440000.
```

--------------------------------

### Run AvionicsSystemSample.ts

Source: https://eoq.gitlab.io/doc/eoq3/15_gettingstarted.html

Execute the TypeScript sample using ts-node.

```bash
npx ts-node AvionicsSystemSample.ts
```

--------------------------------

### M2Class Creation and MDB

Source: https://eoq.gitlab.io/doc/eoq3/25_concepts.html

Command to create an M2Class and access its MDB.

```text
CRT *M2CLASS u1 [NAME:STR, ISABSTRACT:BOL, PACKAGE:M2Package]
```

```text
M2CLASS.MDB
```

--------------------------------

### GET Command

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

The GET command retrieves elements or objects based on a provided query. The result returned is the final context of the outermost query.

```APIDOC
## GET <target>

### Description
Retrieves elements or objects based on a query. The query is evaluated before the command is executed.

### Parameters
- **target** (VAL) - Required - A query evaluated by the GET command.

### Results
- **value** (VAL) - The value(s) obtained by executing the query, depending on the MDB content.
```

--------------------------------

### My.avionicssystemmodel instance model

Source: https://eoq.gitlab.io/doc/eoq3/95_appendix.html

This file is an instance of the avionicsSystemModel.ecore meta-model, representing a specific topology of devices, interfaces, and connections.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<avionicsSystemModel:AvionicsSystem xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:avionicsSystemModel="http://www.example.org/avionicsSystemModel">
  <links name="link 1" source="//@devices.2/@interfaces.0" destination="//@devices.0/@interfaces.0"/>
  <links name="link 2" source="//@devices.4/@interfaces.0" destination="//@devices.0/@interfaces.1"/>
  <links name="link 3" source="//@devices.4/@interfaces.1" destination="//@devices.1/@interfaces.0"/>
  <links name="link 4" source="//@devices.3/@interfaces.0" destination="//@devices.1/@interfaces.1"/>
  <devices xsi:type="avionicsSystemModel:CPIOM" name="CPIOM front">
    <interfaces name="Analog"/>
    <interfaces name="Afdx" direction="BOTH"/>
  </devices>
  <devices xsi:type="avionicsSystemModel:CPIOM" name="CPIOM back" type="B">
    <interfaces name="Afdx" direction="BOTH"/>
    <interfaces name="A653" direction="OUT"/>
  </devices>
  <devices xsi:type="avionicsSystemModel:Peripheral" name="Side Stick">
    <interfaces name="Analog" direction="OUT"/>
  </devices>
  <devices xsi:type="avionicsSystemModel:Peripheral" name="Rudder">
    <interfaces name="A429"/>
  </devices>
  <devices xsi:type="avionicsSystemModel:Switch" name="Switch center">
    <interfaces name="Afdx port 1" direction="BOTH"/>
    <interfaces name="Afdx port 2" direction="BOTH"/>
  </devices>
</avionicsSystemModel:AvionicsSystem>
```

--------------------------------

### MxConstraint Creation and MDB

Source: https://eoq.gitlab.io/doc/eoq3/25_concepts.html

Creation command and MDB reference for MxConstraint.

```text
CRT *MXCONSTRAINT u1 [ELEMENT:MxElement, EXPRESSION:STR]
```

```text
MXCONSTRAINT.MDB
```

--------------------------------

### GET a single feature

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Retrieves a single feature from an object.

```text
GET (#y20/name) -> myname
```

```text
Get(Obj(20).Pth('name'))
```

--------------------------------

### MSG command variant

Source: https://eoq.gitlab.io/doc/eoq3/40_command.html

Example of sending an alert message.

```text
MSG ALERT 'The MDB is going down for maintenance in 10 minutes'
```

```text
Msg('ALERT','The system is going down for maintenance in 10 minutes')
```
Tokens:
Raw