ngscopeclient 0.1-dev+51fbda87c
MemoryFilter.h
Go to the documentation of this file.
1/***********************************************************************************************************************
2* *
3* libscopeprotocols *
4* *
5* Copyright (c) 2012-2023 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 MemoryFilter_h
36#define MemoryFilter_h
37
38#include "../scopehal/ActionProvider.h"
39
41 : public Filter
42 , public ActionProvider
43{
44public:
45 MemoryFilter(const std::string& color);
46
47 virtual void Refresh() override;
48
49 static std::string GetProtocolName();
50
51 virtual bool ValidateChannel(size_t i, StreamDescriptor stream) override;
52
53 virtual std::vector<std::string> EnumActions() override;
54 virtual bool PerformAction(const std::string& id) override;
55
56 virtual bool ShouldPersistWaveform() override;
57
58 PROTOCOL_DECODER_INITPROC(MemoryFilter)
59
60protected:
61 void Update();
62};
63
64#endif
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
Definition: MemoryFilter.h:43
virtual void Refresh() override
Evaluates a filter graph node.
Definition: MemoryFilter.cpp:77
virtual bool PerformAction(const std::string &id) override
Perform a specific action.
Definition: MemoryFilter.cpp:95
virtual std::vector< std::string > EnumActions() override
Return a list of all actions which may be performed on the object.
Definition: MemoryFilter.cpp:88
virtual bool ShouldPersistWaveform() override
Determine whether the channel's waveform(s) should be persisted to a session file.
Definition: MemoryFilter.cpp:68
Descriptor for a single stream coming off a channel.
Definition: StreamDescriptor.h:46