ngscopeclient v0.2.2
Loading...
Searching...
No Matches
ExportFilter.h
Go to the documentation of this file.
1/***********************************************************************************************************************
2* *
3* libscopeprotocols *
4* *
5* Copyright (c) 2012-2026 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 ExportFilter_h
36#define ExportFilter_h
37
38#include "../scopehal/ActionProvider.h"
39
44 : public Filter
45 , public ActionProvider
46{
47public:
48 ExportFilter(const std::string& color);
49 virtual ~ExportFilter();
50
51 //not copyable or assignable
52 ExportFilter(const ExportFilter& rhs) =delete;
53 ExportFilter& operator=(const ExportFilter& rhs) =delete;
54
55 virtual void Refresh(vk::raii::CommandBuffer& cmdBuf, std::shared_ptr<QueueHandle> queue) override;
56
57 virtual std::vector<std::string> EnumActions() override;
58 virtual bool PerformAction(const std::string& id) override;
59
60protected:
61
65 virtual void Clear();
66
70 virtual void Export() =0;
71
72 enum ExportMode_t
73 {
74 MODE_CONTINUOUS_APPEND,
75 MODE_CONTINUOUS_OVERWRITE,
76 MODE_MANUAL_APPEND,
77 MODE_MANUAL_OVERWRITE,
78 MODE_CONTINUOUS_PIPE,
79 MODE_MANUAL_PIPE
80 };
81
82 std::string m_fname;
83 std::string m_mode;
84
85 FILE* m_fp;
86
87 void OnFileNameChanged();
88};
89
90#endif
Definition AcceleratorBuffer.h:204
Abstract base for objects (usually filters) which provide a series of actions a user can perform.
Definition ActionProvider.h:48
Base class for filters providing file-export functionality.
Definition ExportFilter.h:46
virtual void Clear()
Clears the output file.
Definition ExportFilter.cpp:135
void OnFileNameChanged()
Handle change of file name.
Definition ExportFilter.cpp:125
virtual bool PerformAction(const std::string &id) override
Perform a specific action.
Definition ExportFilter.cpp:110
virtual std::vector< std::string > EnumActions() override
Return a list of all actions which may be performed on the object.
Definition ExportFilter.cpp:102
virtual void Export()=0
Writes the current inputs to the output file in the appropriate format.
Abstract base class for all filter graph blocks which are not physical instrument channels.
Definition Filter.h:105