ngscopeclient v0.2
Loading...
Searching...
No Matches
Public Member Functions | List of all members
UniformDigitalBusWaveform64 Class Reference

A multi-bit (up to 64 bits) digital waveform sampled at uniform rate. More...

#include <Waveform.h>

Inheritance diagram for UniformDigitalBusWaveform64:
Inheritance graph
[legend]
Collaboration diagram for UniformDigitalBusWaveform64:
Collaboration graph
[legend]

Public Member Functions

 UniformDigitalBusWaveform64 (const std::string &name="")
 
- Public Member Functions inherited from UniformWaveform< uint64_t >
 UniformWaveform (const std::string &name="")
 Creates a new uniform waveform.
 
 UniformWaveform (const SparseWaveform< uint64_t > &rhs)
 Creates a uniform waveform as a copy of a sparse one which happens to be sampled at uniform rate.
 
virtual void Rename (const std::string &name="") override
 Assigns a human readable name to the waveform for debug purposes.
 
virtual void FreeGpuMemory () override
 Free GPU-side memory if we are short on VRAM or do not anticipate using this waveform for a while.
 
virtual bool HasGpuBuffer () override
 Returns true if we have at least one buffer resident on the GPU.
 
virtual void Resize (size_t size) override
 Reallocates buffers so the waveform contains the specified number of samples.
 
virtual void Reserve (size_t size) override
 Preallocates buffers without changing the usable size of the waveform.
 
virtual size_t GetMemoryBytes () const override
 Gets the amount of memory consumed by the waveform (may be CPU, GPU, or mirrored)
 
virtual size_t size () const override
 Returns the number of samples in this waveform.
 
virtual size_t capacity () const override
 Returns the number of samples allocated in this waveform.
 
virtual void clear () override
 Remove all samples from this waveform.
 
virtual void PrepareForCpuAccess () override
 Indicates that this waveform is going to be used by the CPU in the near future.
 
virtual void PrepareForGpuAccess () override
 Indicates that this waveform is going to be used by the GPU in the near future.
 
virtual void PrepareForCpuAccessNonblocking (vk::raii::CommandBuffer &cmdBuf) override
 Indicates that this waveform is going to be used by the CPU in the near future.
 
virtual void PrepareForGpuAccessNonblocking (vk::raii::CommandBuffer &cmdBuf) override
 Indicates that this waveform is going to be used by the GPU in the near future.
 
virtual void MarkSamplesModifiedFromCpu () override
 Indicates that this waveform's sample data has been modified on the CPU and the GPU-side copy is no longer coherent.
 
virtual void MarkSamplesModifiedFromGpu () override
 Indicates that this waveform's sample data has been modified on the GPU and the CPU-side copy is no longer coherent.
 
virtual void MarkModifiedFromCpu () override
 Indicates that this waveform's sample data and timestamps have been modified on the CPU and the GPU-side copy is no longer coherent.
 
virtual void MarkModifiedFromGpu () override
 Indicates that this waveform's sample data and timestamps have been modified on the GPU and the CPU-side copy is no longer coherent.
 
void SetGpuAccessHint (enum AcceleratorBuffer< uint64_t >::UsageHint hint)
 Passes a hint to the memory allocator about where our sample data is expected to be used.
 
- Public Member Functions inherited from UniformWaveformBase
 UniformWaveformBase (const SparseWaveformBase &rhs)
 Creates a uniform waveform as a copy of a sparse one.
 
- Public Member Functions inherited from WaveformBase
 WaveformBase ()
 Creates an empty waveform.
 
 WaveformBase (const WaveformBase &rhs)
 Creates a waveform, copying metadata from another.
 
virtual bool empty ()
 Returns true if this waveform contains no samples, false otherwise.
 
virtual std::string GetText (size_t i)
 Returns the text representation of a given protocol sample.
 
virtual std::string GetColor (size_t)
 Returns the displayed color (in HTML #rrggbb or #rrggbbaa notation) of a given protocol sample.
 
virtual uint32_t GetColorCached (size_t i)
 Returns the packed RGBA32 color of a given protocol sample calculated by CacheColors()
 
virtual void CacheColors ()
 Updates the cache of packed colors to avoid string parsing every frame.
 

Additional Inherited Members

- Public Types inherited from WaveformBase
enum  WaveformFlags_t { WAVEFORM_CLIPPING = 1 }
 Flags which may apply to m_flags. More...
 
- Public Attributes inherited from UniformWaveform< uint64_t >
AcceleratorBuffer< uint64_tm_samples
 Sample data.
 
- Public Attributes inherited from WaveformBase
int64_t m_timescale
 The time scale, in X axis units (usually femtoseconds) per timestep, used by this channel.
 
time_t m_startTimestamp
 Start time of the acquisition, integer part.
 
int64_t m_startFemtoseconds
 Start time of the acquisition, fractional part (femtoseconds since since the UTC second)
 
int64_t m_triggerPhase
 Offset, in X axis units (usually femtoseconds), from the trigger to the sampling clock.
 
uint8_t m_flags
 Flags that apply to this waveform. Bitfield containing zero or more WaveformFlags_t values.
 
uint64_t m_revision
 Revision number.
 
- Protected Attributes inherited from WaveformBase
AcceleratorBuffer< uint32_tm_protocolColors
 Cache of packed RGBA32 data with colors for each protocol decode event. Empty for non-protocol waveforms.
 
uint64_t m_cachedColorRevision
 Revision we last cached colors of.
 

Detailed Description

A multi-bit (up to 64 bits) digital waveform sampled at uniform rate.


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