ngscopeclient 0.1-dev+51fbda87c
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ChannelPropertiesDialog Class Reference
Inheritance diagram for ChannelPropertiesDialog:
Inheritance graph
[legend]
Collaboration diagram for ChannelPropertiesDialog:
Collaboration graph
[legend]

Public Member Functions

 ChannelPropertiesDialog (InstrumentChannel *chan, bool graphEditorMode=false)
 
virtual bool DoRender ()
 Renders the dialog and handles UI events. More...
 
- Public Member Functions inherited from BaseChannelPropertiesDialog
 BaseChannelPropertiesDialog (InstrumentChannel *chan, bool graphEditorMode=false)
 
InstrumentChannelGetChannel ()
 
virtual bool DoRender ()
 
- Public Member Functions inherited from EmbeddableDialog
 EmbeddableDialog (const std::string &name, const std::string &id, ImVec2 size, bool graphEditorMode=false)
 
- Public Member Functions inherited from Dialog
 Dialog (const std::string &title, const std::string &id, ImVec2 defaultSize=ImVec2(300, 100))
 
virtual bool Render ()
 Renders the dialog and handles UI events. More...
 
void RenderAsChild ()
 Runs the dialog's contents directly into a parent window.
 
virtual bool DoRender ()=0
 
const std::string & GetID ()
 
std::string GetTitleAndID ()
 

Protected Member Functions

void RefreshInputSettings (Oscilloscope *scope, size_t nchan)
 Update input configuration values. More...
 
- Protected Member Functions inherited from Dialog
bool FloatInputWithApplyButton (const std::string &label, float &currentValue, float &committedValue)
 Helper for displaying a floating-point input box with an "apply" button.
 
bool TextInputWithApplyButton (const std::string &label, std::string &currentValue, std::string &committedValue)
 
bool IntInputWithImplicitApply (const std::string &label, int &currentValue, int &committedValue)
 
bool UnitInputWithExplicitApply (const std::string &label, std::string &currentValue, float &committedValue, Unit unit)
 Input box for a floating point value with an associated unit and an "apply" button. More...
 
void RenderErrorPopup ()
 Popup message when we fail to connect.
 
void ShowErrorPopup (const std::string &title, const std::string &msg)
 Opens the error popup.
 

Protected Attributes

std::string m_displayName
 
std::string m_committedDisplayName
 
std::vector< std::string > m_offset
 
std::vector< float > m_committedOffset
 
std::vector< std::string > m_range
 
std::vector< float > m_committedRange
 
std::string m_threshold
 
float m_committedThreshold
 
std::string m_hysteresis
 
float m_committedHysteresis
 
std::string m_attenuation
 
float m_committedAttenuation
 
std::vector< std::string > m_couplingNames
 
std::vector< OscilloscopeChannel::CouplingType > m_couplings
 
int m_coupling
 
std::vector< std::string > m_bwlNames
 
std::vector< unsigned int > m_bwlValues
 
int m_bwl
 
std::vector< std::string > m_imuxNames
 
int m_imux
 
std::vector< std::string > m_modeNames
 
int m_mode
 
int m_navg
 
float m_color [3]
 
bool m_inverted
 
std::string m_probe
 
bool m_canAutoZero
 
bool m_canDegauss
 
bool m_shouldDegauss
 
bool m_canAverage
 
- Protected Attributes inherited from BaseChannelPropertiesDialog
InstrumentChannelm_channel
 
- Protected Attributes inherited from EmbeddableDialog
bool m_graphEditorMode
 If true, we're a sub-window of a filter graph editor node. More...
 
- Protected Attributes inherited from Dialog
bool m_open
 
std::string m_id
 
std::string m_title
 
ImVec2 m_defaultSize
 
std::string m_errorPopupTitle
 
std::string m_errorPopupMessage
 

Additional Inherited Members

- Static Public Member Functions inherited from Dialog
static bool Combo (const std::string &label, const std::vector< std::string > &items, int &selection)
 Displays a combo box from a vector<string>
 
static bool UnitInputWithImplicitApply (const std::string &label, std::string &currentValue, float &committedValue, Unit unit)
 Input box for a floating point value with an associated unit. More...
 
static bool UnitInputWithImplicitApply (const std::string &label, std::string &currentValue, double &committedValue, Unit unit)
 Input box for a double precision floating point value with an associated unit. More...
 
static bool UnitInputWithImplicitApply (const std::string &label, std::string &currentValue, int64_t &committedValue, Unit unit)
 Input box for an integer value with an associated unit. More...
 
static bool TextInputWithImplicitApply (const std::string &label, std::string &currentValue, std::string &committedValue)
 
static void Tooltip (const std::string &str, bool allowDisabled=false)
 Helper based on imgui demo for displaying tooltip text over the previously rendered widget.
 
static void HelpMarker (const std::string &str)
 
static void HelpMarker (const std::string &header, const std::vector< std::string > &bullets)
 

Member Function Documentation

◆ DoRender()

bool ChannelPropertiesDialog::DoRender ( )
virtual

Renders the dialog and handles UI events.

Returns
True if we should continue showing the dialog False if it's been closed

Reimplemented from BaseChannelPropertiesDialog.

Reimplemented in FilterPropertiesDialog.

◆ RefreshInputSettings()

void ChannelPropertiesDialog::RefreshInputSettings ( Oscilloscope scope,
size_t  nchan 
)
protected

Update input configuration values.

This is typically used with instruments that have a hardware input mux, since the set of available couplings and bandwidth limiters etc may change for one input vs another.


The documentation for this class was generated from the following files: