Skip to content

Latest commit

 

History

History
6807 lines (4623 loc) · 305 KB

class.rst

File metadata and controls

6807 lines (4623 loc) · 305 KB

nifgen.Session

Properties

absolute_delay

all_marker_events_latched_status

all_marker_events_live_status

analog_data_mask

analog_filter_enabled

analog_path

analog_static_value

arb_gain

arb_marker_position

arb_offset

arb_repeat_count

arb_sample_rate

arb_sequence_handle

arb_waveform_handle

aux_power_enabled

bus_type

channel_delay

clock_mode

common_mode_offset

data_marker_events_count

data_marker_event_data_bit_number

data_marker_event_level_polarity

data_marker_event_output_terminal

data_transfer_block_size

data_transfer_maximum_bandwidth

data_transfer_maximum_in_flight_reads

data_transfer_preferred_packet_size

digital_data_mask

digital_edge_script_trigger_edge

digital_edge_script_trigger_source

digital_edge_start_trigger_edge

digital_edge_start_trigger_source

digital_filter_enabled

digital_filter_interpolation_factor

digital_gain

digital_pattern_enabled

digital_static_value

done_event_output_terminal

driver_setup

exported_onboard_reference_clock_output_terminal

exported_reference_clock_output_terminal

exported_sample_clock_divisor

exported_sample_clock_output_terminal

exported_sample_clock_timebase_divisor

exported_sample_clock_timebase_output_terminal

exported_script_trigger_output_terminal

exported_start_trigger_output_terminal

external_clock_delay_binary_value

external_sample_clock_multiplier

file_transfer_block_size

filter_correction_frequency

flatness_correction_enabled

fpga_bitfile_path

freq_list_duration_quantum

freq_list_handle

func_amplitude

func_buffer_size

func_dc_offset

func_duty_cycle_high

func_frequency

func_max_buffer_size

func_start_phase

func_waveform

idle_behavior

idle_value

instrument_firmware_revision

instrument_manufacturer

instrument_model

io_resource_descriptor

load_impedance

logical_name

marker_events_count

marker_event_output_terminal

max_freq_list_duration

max_freq_list_length

max_loop_count

max_num_freq_lists

max_num_sequences

max_num_waveforms

max_sequence_length

max_waveform_size

memory_size

min_freq_list_duration

min_freq_list_length

min_sequence_length

min_waveform_size

module_revision

channel_count

output_enabled

output_impedance

output_mode

ready_for_start_event_output_terminal

reference_clock_source

ref_clock_frequency

sample_clock_source

sample_clock_timebase_rate

sample_clock_timebase_source

script_to_generate

script_triggers_count

script_trigger_type

serial_number

simulate

specific_driver_description

major_version

minor_version

specific_driver_revision

specific_driver_vendor

started_event_output_terminal

start_trigger_type

streaming_space_available_in_waveform

streaming_waveform_handle

streaming_waveform_name

streaming_write_timeout

supported_instrument_models

terminal_configuration

trigger_mode

wait_behavior

wait_value

waveform_quantum

Methods

abort

allocate_named_waveform

allocate_waveform

clear_arb_memory

clear_arb_sequence

clear_freq_list

clear_user_standard_waveform

close

commit

configure_arb_sequence

configure_arb_waveform

configure_freq_list

configure_standard_waveform

create_advanced_arb_sequence

create_arb_sequence

create_freq_list

create_waveform_from_file_f64

create_waveform_from_file_i16

create_waveform_numpy

define_user_standard_waveform

delete_script

delete_waveform

disable

get_ext_cal_last_date_and_time

get_ext_cal_last_temp

get_hardware_state

get_self_cal_last_date_and_time

get_self_cal_last_temp

get_self_cal_supported

initiate

is_done

lock

query_arb_seq_capabilities

query_arb_wfm_capabilities

query_freq_list_capabilities

read_current_temperature

reset

reset_device

reset_with_defaults

self_cal

self_test

send_software_edge_trigger

set_next_write_position

unlock

wait_until_done

write_script

write_waveform

Properties

Property Datatype
:pynifgen.Session.absolute_delay float
:pynifgen.Session.all_marker_events_latched_status int
:pynifgen.Session.all_marker_events_live_status int
:pynifgen.Session.analog_data_mask int
:pynifgen.Session.analog_filter_enabled bool
:pynifgen.Session.analog_path :pyAnalogPath
:pynifgen.Session.analog_static_value int
:pynifgen.Session.arb_gain float
:pynifgen.Session.arb_marker_position int
:pynifgen.Session.arb_offset float
:pynifgen.Session.arb_repeat_count int
:pynifgen.Session.arb_sample_rate float
:pynifgen.Session.arb_sequence_handle int
:pynifgen.Session.arb_waveform_handle int
:pynifgen.Session.aux_power_enabled bool
:pynifgen.Session.bus_type :pyBusType
:pynifgen.Session.channel_delay float
:pynifgen.Session.clock_mode :pyClockMode
:pynifgen.Session.common_mode_offset float
:pynifgen.Session.data_marker_events_count int
:pynifgen.Session.data_marker_event_data_bit_number int
:pynifgen.Session.data_marker_event_level_polarity :pyDataMarkerEventLevelPolarity
:pynifgen.Session.data_marker_event_output_terminal str
:pynifgen.Session.data_transfer_block_size int
:pynifgen.Session.data_transfer_maximum_bandwidth float
:pynifgen.Session.data_transfer_maximum_in_flight_reads int
:pynifgen.Session.data_transfer_preferred_packet_size int
:pynifgen.Session.digital_data_mask int
:pynifgen.Session.digital_edge_script_trigger_edge :pyScriptTriggerDigitalEdgeEdge
:pynifgen.Session.digital_edge_script_trigger_source str
:pynifgen.Session.digital_edge_start_trigger_edge :pyStartTriggerDigitalEdgeEdge
:pynifgen.Session.digital_edge_start_trigger_source str
:pynifgen.Session.digital_filter_enabled bool
:pynifgen.Session.digital_filter_interpolation_factor float
:pynifgen.Session.digital_gain float
:pynifgen.Session.digital_pattern_enabled bool
:pynifgen.Session.digital_static_value int
:pynifgen.Session.done_event_output_terminal str
:pynifgen.Session.driver_setup str
:pynifgen.Session.exported_onboard_reference_clock_output_terminal str
:pynifgen.Session.exported_reference_clock_output_terminal str
:pynifgen.Session.exported_sample_clock_divisor int
:pynifgen.Session.exported_sample_clock_output_terminal str
:pynifgen.Session.exported_sample_clock_timebase_divisor int
:pynifgen.Session.exported_sample_clock_timebase_output_terminal str
:pynifgen.Session.exported_script_trigger_output_terminal str
:pynifgen.Session.exported_start_trigger_output_terminal str
:pynifgen.Session.external_clock_delay_binary_value int
:pynifgen.Session.external_sample_clock_multiplier float
:pynifgen.Session.file_transfer_block_size int
:pynifgen.Session.filter_correction_frequency float
:pynifgen.Session.flatness_correction_enabled bool
:pynifgen.Session.fpga_bitfile_path str
:pynifgen.Session.freq_list_duration_quantum float
:pynifgen.Session.freq_list_handle int
:pynifgen.Session.func_amplitude float
:pynifgen.Session.func_buffer_size int
:pynifgen.Session.func_dc_offset float
:pynifgen.Session.func_duty_cycle_high float
:pynifgen.Session.func_frequency float
:pynifgen.Session.func_max_buffer_size int
:pynifgen.Session.func_start_phase float
:pynifgen.Session.func_waveform :pyWaveform
:pynifgen.Session.idle_behavior :pyIdleBehavior
:pynifgen.Session.idle_value int
:pynifgen.Session.instrument_firmware_revision str
:pynifgen.Session.instrument_manufacturer str
:pynifgen.Session.instrument_model str
:pynifgen.Session.io_resource_descriptor str
:pynifgen.Session.load_impedance float
:pynifgen.Session.logical_name str
:pynifgen.Session.marker_events_count int
:pynifgen.Session.marker_event_output_terminal str
:pynifgen.Session.max_freq_list_duration float
:pynifgen.Session.max_freq_list_length int
:pynifgen.Session.max_loop_count int
:pynifgen.Session.max_num_freq_lists int
:pynifgen.Session.max_num_sequences int
:pynifgen.Session.max_num_waveforms int
:pynifgen.Session.max_sequence_length int
:pynifgen.Session.max_waveform_size int
:pynifgen.Session.memory_size int
:pynifgen.Session.min_freq_list_duration float
:pynifgen.Session.min_freq_list_length int
:pynifgen.Session.min_sequence_length int
:pynifgen.Session.min_waveform_size int
:pynifgen.Session.module_revision str
:pynifgen.Session.channel_count int
:pynifgen.Session.output_enabled bool
:pynifgen.Session.output_impedance float
:pynifgen.Session.output_mode :pyOutputMode
:pynifgen.Session.ready_for_start_event_output_terminal str
:pynifgen.Session.reference_clock_source :pyReferenceClockSource
:pynifgen.Session.ref_clock_frequency float
:pynifgen.Session.sample_clock_source :pySampleClockSource
:pynifgen.Session.sample_clock_timebase_rate float
:pynifgen.Session.sample_clock_timebase_source :pySampleClockTimebaseSource
:pynifgen.Session.script_to_generate str
:pynifgen.Session.script_triggers_count int
:pynifgen.Session.script_trigger_type :pyScriptTriggerType
:pynifgen.Session.serial_number str
:pynifgen.Session.simulate bool
:pynifgen.Session.specific_driver_description str
:pynifgen.Session.major_version int
:pynifgen.Session.minor_version int
:pynifgen.Session.specific_driver_revision str
:pynifgen.Session.specific_driver_vendor str
:pynifgen.Session.started_event_output_terminal str
:pynifgen.Session.start_trigger_type :pyStartTriggerType
:pynifgen.Session.streaming_space_available_in_waveform int
:pynifgen.Session.streaming_waveform_handle int
:pynifgen.Session.streaming_waveform_name str
:pynifgen.Session.streaming_write_timeout float in seconds or datetime.timedelta
:pynifgen.Session.supported_instrument_models str
:pynifgen.Session.terminal_configuration :pyTerminalConfiguration
:pynifgen.Session.trigger_mode :pyTriggerMode
:pynifgen.Session.wait_behavior :pyWaitBehavior
:pynifgen.Session.wait_value int
:pynifgen.Session.waveform_quantum int

Methods

Method name
:pynifgen.Session.abort
:pynifgen.Session.allocate_named_waveform
:pynifgen.Session.allocate_waveform
:pynifgen.Session.clear_arb_memory
:pynifgen.Session.clear_arb_sequence
:pynifgen.Session.clear_freq_list
:pynifgen.Session.clear_user_standard_waveform
:pynifgen.Session.close
:pynifgen.Session.commit
:pynifgen.Session.configure_arb_sequence
:pynifgen.Session.configure_arb_waveform
:pynifgen.Session.configure_freq_list
:pynifgen.Session.configure_standard_waveform
:pynifgen.Session.create_advanced_arb_sequence
:pynifgen.Session.create_arb_sequence
:pynifgen.Session.create_freq_list
:pynifgen.Session.create_waveform_from_file_f64
:pynifgen.Session.create_waveform_from_file_i16
:pynifgen.Session.create_waveform_numpy
:pynifgen.Session.define_user_standard_waveform
:pynifgen.Session.delete_script
:pynifgen.Session.delete_waveform
:pynifgen.Session.disable
:pynifgen.Session.get_ext_cal_last_date_and_time
:pynifgen.Session.get_ext_cal_last_temp
:pynifgen.Session.get_ext_cal_recommended_interval
:pynifgen.Session.get_hardware_state
:pynifgen.Session.get_self_cal_last_date_and_time
:pynifgen.Session.get_self_cal_last_temp
:pynifgen.Session.get_self_cal_supported
:pynifgen.Session.initiate
:pynifgen.Session.is_done
:pynifgen.Session.lock
:pynifgen.Session.query_arb_seq_capabilities
:pynifgen.Session.query_arb_wfm_capabilities
:pynifgen.Session.query_freq_list_capabilities
:pynifgen.Session.read_current_temperature
:pynifgen.Session.reset
:pynifgen.Session.reset_device
:pynifgen.Session.reset_with_defaults
:pynifgen.Session.self_cal
:pynifgen.Session.self_test
:pynifgen.Session.send_software_edge_trigger
:pynifgen.Session.set_next_write_position
:pynifgen.Session.unlock
:pynifgen.Session.wait_until_done
:pynifgen.Session.write_script
:pynifgen.Session.write_waveform