Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
br_stimpy 0.0.6 documentation
Logo
br_stimpy 0.0.6 documentation
  • Home page
  • Source Code
  • API Reference
    • br_stimpy.stimpy.get_api_version
    • br_stimpy.stimpy.get_enum_docstr
    • br_stimpy.stimpy.ElectrodeChannelMap
    • br_stimpy.stimpy.GroupStimulusStruct
    • br_stimpy.stimpy.ModuleStatus
    • br_stimpy.stimpy.OCVolt
    • br_stimpy.stimpy.PartNumbers
    • br_stimpy.stimpy.ResultType
    • br_stimpy.stimpy.SeqType
    • br_stimpy.stimpy.Stimulator
    • br_stimpy.stimpy.TriggerType
    • br_stimpy.stimpy.WFType
Back to top
View this page

br_stimpy.stimpy.get_enum_docstr

get_enum_docstr(enum_val)[source]

Lookup docstr for a pybind11 enum value and output as string

Parameters:

enum_val (Union[OCVolt, WFType, TriggerType, PartNumbers, ModuleStatus, SeqType, ResultType]) – an enumeration value from the enums module

Return type:

str

Returns:

docstr for the enum_val

Next
br_stimpy.stimpy.ElectrodeChannelMap
Previous
br_stimpy.stimpy.get_api_version
Copyright © University of Pittsburgh Rehab Neural Engineering Labs, 2025
Made with Sphinx and @pradyunsg's Furo
On this page
  • br_stimpy.stimpy.get_enum_docstr
    • get_enum_docstr()