C++ API Reference

Class Hierarchy

• • Struct DataPacket
  • Struct pin_map_t
  • Class DeviceProperty
  • Class ExternalProperty
  • Class FunctionProperty
  • Class InternalProperty
  • Class Pin
  • Enum CamLevelTriggerMode
  • Enum PropertyAccess
  • Enum SysProps

File Hierarchy

• • File events.h
  • File ext_pTIRF.h
  • File globals.h
  • File interlock.h
  • File pins.h
  • File props.h
  • File uart_comm.h

Full API

Classes and Structs

• Struct DataPacket
  • Struct Documentation
    • DataPacket
      • cmd
      • arg1
      • arg2
      • ts_us
      • N
      • interv_us

• Struct pin_map_t
  • Struct Documentation
    • pin_map_t
      • pin_name
      • pin_idx

• Class DeviceProperty
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • DeviceProperty
      • DeviceProperty()
      • ~DeviceProperty()
      • get_value()
      • set_value()
      • access

• Class ExternalProperty
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • ExternalProperty
      • ExternalProperty()
      • get_value()
      • set_value()

• Class FunctionProperty
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • FunctionProperty
      • FunctionProperty()
      • get_value()
      • set_value()

• Class InternalProperty
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • InternalProperty
      • InternalProperty()
      • get_value()
      • set_value()

• Class Pin
  • Class Documentation
    • Pin
      • Pin()
      • set_level()
      • update()
      • toggle()
      • enable()
      • disable()
      • is_active()
      • pin_idx

Enums

• Enum CamLevelTriggerMode
  • Enum Documentation
    • CamLevelTriggerMode
      • LVL_TRG_NORMAL
      • LVL_TRG_OVERLAP
      • LVL_TRG_GLOBAL_RESET

• Enum PropertyAccess
  • Enum Documentation
    • PropertyAccess
      • ReadOnly
      • ReadWrite
      • WriteOnly

• Enum SysProps
  • Enum Documentation
    • SysProps
      • ro_VERSION
      • ro_SYS_TIMER_STATUS
      • ro_SYS_TIMER_VALUE
      • ro_SYS_TIMER_OVF_COUNT
      • ro_SYS_TIME_ms
      • ro_SYS_TIMER_PRESCALER
      • rw_DFLT_PULSE_DURATION_us
      • ro_WATCHDOG_TIMEOUT_ms
      • ro_N_EVENTS
      • rw_INTLCK_ENABLED
      • rw_SELECTED_LASERS
      • wo_OPEN_SHUTTERS
      • wo_CLOSE_SHUTTERS
      • rw_SHUTTER_DELAY_us
      • rw_CAM_READOUT_us
      • rw_CAM_LEVEL_TRIGGER_MODE

Functions

• Function __attribute__
  • Function Documentation

• Function close_shutters
  • Function Documentation
    • close_shutters()

• Function close_shutters_func
  • Function Documentation
    • close_shutters_func()

• Function cts2us
  • Function Documentation
    • cts2us()

• Function current_time_cts
  • Function Documentation
    • current_time_cts()

• Function current_time_s
  • Function Documentation
    • current_time_s()

• Function current_time_us
  • Function Documentation
    • current_time_us()

• Function dbg_pin_dn
  • Function Documentation
    • dbg_pin_dn()

• Function dbg_pin_up
  • Function Documentation
    • dbg_pin_up()

• Function disable_pin_func
  • Function Documentation
    • disable_pin_func()

• Function enable_pin_func
  • Function Documentation
    • enable_pin_func()

• Function err_led_off
  • Function Documentation
    • err_led_off()

• Function err_led_on
  • Function Documentation
    • err_led_on()

• Function event_from_datapacket
  • Function Documentation
    • event_from_datapacket()

• Function get_property
  • Function Documentation
    • get_property()

• Function init_burst_timer
  • Function Documentation
    • init_burst_timer()

• Function init_interlock
  • Function Documentation
    • init_interlock()

• Function init_pins
  • Function Documentation
    • init_pins()

• Function init_props
  • Function Documentation
    • init_props()

• Function init_sys_timer
  • Function Documentation
    • init_sys_timer()

• Function init_uart_comm
  • Function Documentation
    • init_uart_comm()

• Function is_event_missed
  • Function Documentation
    • is_event_missed()

• Function open_shutters
  • Function Documentation
    • open_shutters()

• Function open_shutters_func
  • Function Documentation
    • open_shutters_func()

• Function pause_sys_timer
  • Function Documentation
    • pause_sys_timer()

• Function pin_name_to_ioport_id(const char *)
  • Function Documentation
    • pin_name_to_ioport_id()

• Function pin_name_to_ioport_id(const uint32_t)
  • Function Documentation
    • pin_name_to_ioport_id()

• Function poll_uart
  • Function Documentation
    • poll_uart()

• Function process_events
  • Function Documentation
    • process_events()

• Function schedule_burst
  • Function Documentation
    • schedule_burst()

• Function schedule_disable_pin
  • Function Documentation
    • schedule_disable_pin()

• Function schedule_enable_pin
  • Function Documentation
    • schedule_enable_pin()

• Function schedule_event
  • Function Documentation
    • schedule_event()

• Function schedule_pin
  • Function Documentation
    • schedule_pin()

• Function schedule_pulse(const DataPacket *, bool)
  • Function Documentation
    • schedule_pulse()

• Function schedule_pulse(uint32_t, uint32_t, uint64_t, uint32_t, uint32_t, bool)
  • Function Documentation
    • schedule_pulse()

• Function schedule_shutter_pulse
  • Function Documentation
    • schedule_shutter_pulse()

• Function schedule_toggle
  • Function Documentation
    • schedule_toggle()

• Function select_lasers
  • Function Documentation
    • select_lasers()

• Function selected_lasers
  • Function Documentation
    • selected_lasers()

• Function set_pin_event_func
  • Function Documentation
    • set_pin_event_func()

• Function set_property
  • Function Documentation
    • set_property()

• Function start_ALEX_acq
  • Function Documentation
    • start_ALEX_acq()

• Function start_burst_func
  • Function Documentation
    • start_burst_func()

• Function start_continuous_acq
  • Function Documentation
    • start_continuous_acq()

• Function start_stroboscopic_acq
  • Function Documentation
    • start_stroboscopic_acq()

• Function start_sys_timer
  • Function Documentation
    • start_sys_timer()

• Function stop_burst_func
  • Function Documentation
    • stop_burst_func()

• Function stop_sys_timer
  • Function Documentation
    • stop_sys_timer()

• Function tgl_pin_event_func
  • Function Documentation
    • tgl_pin_event_func()

• Function uart_tx(const char *)
  • Function Documentation
    • uart_tx()

• Function uart_tx(const char *, uint32_t)
  • Function Documentation
    • uart_tx()

• Function us2cts
  • Function Documentation
    • us2cts()

Variables

• Variable default_pulse_duration_us
  • Variable Documentation
    • default_pulse_duration_us

• Variable Event
  • Variable Documentation

• Variable event_queue
  • Variable Documentation
    • event_queue

• Variable interlock_enabled
  • Variable Documentation
    • interlock_enabled

• Variable lasers_enabled
  • Variable Documentation
    • lasers_enabled

• Variable pin_map
  • Variable Documentation
    • pin_map

• Variable pins
  • Variable Documentation
    • pins

• Variable shutter_pins
  • Variable Documentation
    • shutter_pins

• Variable sys_tc_ovf_count
  • Variable Documentation
    • sys_tc_ovf_count

• Variable sys_timer_running
  • Variable Documentation
    • sys_timer_running

Defines

• Define BURST_PIN
  • Define Documentation
    • BURST_PIN

• Define CAMERA_PIN
  • Define Documentation
    • CAMERA_PIN

• Define CY2_PIN
  • Define Documentation
    • CY2_PIN

• Define CY3_PIN
  • Define Documentation
    • CY3_PIN

• Define CY5_PIN
  • Define Documentation
    • CY5_PIN

• Define CY7_PIN
  • Define Documentation
    • CY7_PIN

• Define DBG_PIN
  • Define Documentation
    • DBG_PIN

• Define ERR_PIN
  • Define Documentation
    • ERR_PIN

• Define ID_INTLCK_TC
  • Define Documentation
    • ID_INTLCK_TC

• Define ID_SYS_TC
  • Define Documentation
    • ID_SYS_TC

• Define ID_UART_TC
  • Define Documentation
    • ID_UART_TC

• Define INTLCK_IN
  • Define Documentation
    • INTLCK_IN

• Define INTLCK_OUT
  • Define Documentation
    • INTLCK_OUT

• Define INTLCK_OUT_PERIPH
  • Define Documentation
    • INTLCK_OUT_PERIPH

• Define INTLCK_TC
  • Define Documentation
    • INTLCK_TC

• Define INTLCK_TC_CH
  • Define Documentation
    • INTLCK_TC_CH

• Define INTLCK_TC_Handler
  • Define Documentation
    • INTLCK_TC_Handler

• Define INTLCK_TC_IRQn
  • Define Documentation
    • INTLCK_TC_IRQn

• Define INTLCK_TC_PERIOD_US
  • Define Documentation
    • INTLCK_TC_PERIOD_US

• Define INVALID_PIN_IDX
  • Define Documentation
    • INVALID_PIN_IDX

• Define MAX_N_EVENTS
  • Define Documentation
    • MAX_N_EVENTS

• Define MIN_EVENT_INTERVAL
  • Define Documentation
    • MIN_EVENT_INTERVAL

• Define PRESC32
  • Define Documentation
    • PRESC32

• Define SYS_TC
  • Define Documentation
    • SYS_TC

• Define SYS_TC_CH
  • Define Documentation
    • SYS_TC_CH

• Define SYS_TC_CMR_TCCLKS_TIMER_CLOCK
  • Define Documentation
    • SYS_TC_CMR_TCCLKS_TIMER_CLOCK

• Define SYS_TC_CONVERSION_MULTIPLIER
  • Define Documentation
    • SYS_TC_CONVERSION_MULTIPLIER

• Define SYS_TC_Handler
  • Define Documentation
    • SYS_TC_Handler

• Define SYS_TC_IRQn
  • Define Documentation
    • SYS_TC_IRQn

• Define SYS_TC_PRESCALER
  • Define Documentation
    • SYS_TC_PRESCALER

• Define TS_MISSED_TOLERANCE
  • Define Documentation
    • TS_MISSED_TOLERANCE

• Define TS_MISSED_TOLERANCE_CTS
  • Define Documentation
    • TS_MISSED_TOLERANCE_CTS

• Define TS_TOLERANCE
  • Define Documentation
    • TS_TOLERANCE

• Define TS_TOLERANCE_CTS
  • Define Documentation
    • TS_TOLERANCE_CTS

• Define UART_BAUDRATE
  • Define Documentation
    • UART_BAUDRATE

• Define UART_BUFFER_SIZE
  • Define Documentation
    • UART_BUFFER_SIZE

• Define UART_TC
  • Define Documentation
    • UART_TC

• Define UART_TC_CH
  • Define Documentation
    • UART_TC_CH

• Define UART_TC_IRQn
  • Define Documentation
    • UART_TC_IRQn

• Define UART_TIMEOUT
  • Define Documentation
    • UART_TIMEOUT

• Define UART_TIMEOUT_Handler
  • Define Documentation
    • UART_TIMEOUT_Handler

• Define UNIFORM_TIME_DELAY
  • Define Documentation
    • UNIFORM_TIME_DELAY

• Define UNIFORM_TIME_DELAY_CTS
  • Define Documentation
    • UNIFORM_TIME_DELAY_CTS

• Define VERSION
  • Define Documentation
    • VERSION

• Define WATCHDOG_TIMEOUT
  • Define Documentation
    • WATCHDOG_TIMEOUT

Typedefs

• Typedef EventFunc
  • Typedef Documentation
    • EventFunc

• Typedef PropGetter
  • Typedef Documentation
    • PropGetter

• Typedef PropSetter
  • Typedef Documentation
    • PropSetter