lin-epics-modules/sinqMotor
0
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added documentation regarding virtual methods
All checks were successful
Test And Build / Lint (push) Successful in 4s
Details
Test And Build / Build (push) Successful in 6s
Details

Browse Source
This commit is contained in:
mathis_s
2025-07-24 11:54:10 +02:00
parent c65a8de5dd
commit cccfc79860
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -208,7 +208,9 @@ transferred to (motor_record_pv_name).MRES or to
### Base classes ### Base classes
sinqMotor offers a variety of additional methods for children classes to standardize certain patterns (e.g. writing messages to the IOC shell and the motor message PV). For a detailed description, please see the respective function documentation in the .h-files. All of these functions can be overwritten manually if e.g. a completely different implementation of `poll` is required. Some functions are marked as virtual, because they are called from other functions of sinqMotor and therefore need runtime polymorphism. Functions without that marker are not called anywhere in sinqMotor. sinqMotor offers a variety of additional methods for children classes to standardize certain patterns (e.g. writing messages to the IOC shell and the motor message PV). For a detailed description, please see the respective function documentation in the .h-files. All of these functions can be overwritten manually if e.g. a completely different implementation of `poll` is required. Some functions are marked as virtual, because they are called from other functions of sinqMotor and therefore need runtime polymorphism. Functions without that marker are not called anywhere in sinqMotor (except for `forcedPoll`, which is called in `poll`).
Adding new virtual methods breaks the ABI and therefore warrants a new major version number!
#### sinqController.h #### sinqController.h
- `couldNotParseResponse`: Write a standardized message if parsing a device response failed. - `couldNotParseResponse`: Write a standardized message if parsing a device response failed.