ngscopeclient v0.1-rc1
PausableFilter.h
Go to the documentation of this file.
1/***********************************************************************************************************************
2* *
3* libscopehal *
4* *
5* Copyright (c) 2012-2025 Andrew D. Zonenberg and contributors *
6* All rights reserved. *
7* *
8* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the *
9* following conditions are met: *
10* *
11* * Redistributions of source code must retain the above copyright notice, this list of conditions, and the *
12* following disclaimer. *
13* *
14* * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the *
15* following disclaimer in the documentation and/or other materials provided with the distribution. *
16* *
17* * Neither the name of the author nor the names of any contributors may be used to endorse or promote products *
18* derived from this software without specific prior written permission. *
19* *
20* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
21* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
22* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES *
23* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR *
24* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
25* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE *
26* POSSIBILITY OF SUCH DAMAGE. *
27* *
28***********************************************************************************************************************/
29
35#ifndef PausableFilter_h
36#define PausableFilter_h
37
38#include "ActionProvider.h"
39
44 : public Filter
45 , public ActionProvider
46{
47public:
49 const std::string& color,
50 Category cat,
51 Unit xunit = Unit::UNIT_FS);
52 virtual ~PausableFilter();
53
54 virtual std::vector<std::string> EnumActions() override;
55 virtual bool PerformAction(const std::string& id) override;
56
57 virtual void LoadParameters(const YAML::Node& node, IDTable& table) override;
58
59 bool ShouldRefresh();
60
61 void Run();
62 void Single();
63 void Stop();
64
65protected:
66 bool m_running;
67 bool m_oneShot;
68};
69
70#endif
Declaration of ActionProvider.
Abstract base for objects (usually filters) which provide a series of actions a user can perform.
Definition: ActionProvider.h:48
Abstract base class for all filter graph blocks which are not physical instrument channels.
Definition: Filter.h:95
Category
Category the filter should be displayed under in the GUI.
Definition: Filter.h:108
Bidirectional table mapping integer IDs in scopesession files to object pointers.
Definition: IDTable.h:51
A filter which may be started and stopped.
Definition: PausableFilter.h:46
virtual bool PerformAction(const std::string &id) override
Perform a specific action.
Definition: PausableFilter.cpp:86
virtual std::vector< std::string > EnumActions() override
Return a list of all actions which may be performed on the object.
Definition: PausableFilter.cpp:59
virtual void LoadParameters(const YAML::Node &node, IDTable &table) override
Load configuration from a save file.
Definition: PausableFilter.cpp:117
A unit of measurement, plus conversion to pretty-printed output.
Definition: Unit.h:57