public interface ISingleDomainRecordGenerator extends IRecordGenerator
Modifier and Type | Method and Description |
---|---|
Signal |
addSignal(ICell container,
String name,
String description,
ISamples.ProcessType processType,
ISamples.SignalType signalType,
ISamples.SignalDescriptor signalDescriptor)
Adds a new signals (and creates a writer).
|
void |
close(long units)
Close all writers at position 'units'.
|
void |
initRecord(String name,
IDomainBase domainBase) |
void |
open(long units)
Open all writers at position 'units' (discrete process mode)).
|
void |
open(long units,
long rate)
Open all writers at position 'units' and rate (continuous process mode)).
|
void |
open(long units,
long rate,
int samples256PerFragment,
int maxFragments)
Internal use only !
|
addFolderConfiguration, addFolderConfiguration, addPlotConfiguration, addPlotConfiguration, addScope, addScope, addSignal, addSignal, addSignalProxy, addViewConfiguration, addViewConfiguration, addViewConfigurations, apply, createConvergingWriter, createDivergingWriter, createReader, createWriter, createWriter, getAllSignals, getBase, getScope, getSignal, getWriter, initRecord
void initRecord(String name, IDomainBase domainBase)
name
- to be used as record name.domainBase
- Domain base in case of multi domain record (e.g. TimeBase.ms).Signal addSignal(ICell container, String name, String description, ISamples.ProcessType processType, ISamples.SignalType signalType, ISamples.SignalDescriptor signalDescriptor)
Example (JavaScript) generator.initRecord("Example Record",TimeBase.ns); var signals = generator.addScope(null, "External Signals"); var clk = generator.addSignal(signals, "Clk", "", ProcessType.Discrete, SignalType.Logic, SignalDescriptor.DEFAULT); var writer= generator.getWriter(clk);
container
- Parent of new signal, or null (for root).name
- Name of the new signal.description
- Signal description (just comments).processType
- Discrete or Continuous process type (ProcessType. ...).signalType
- One of the defined signal types (SignalType. ...).signalDescriptor
- Extended definition of the signal type, usually set to SignalDescriptor.DEFAULT.void open(long units)
units
- Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).void open(long units, long rate)
units
- Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).rate
- Domain distance as a multiple of its domain base (see rate).void open(long units, long rate, int samples256PerFragment, int maxFragments)
units
- Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).rate
- Domain distance as a multiple of its domain base (see rate).samples256PerFragment
- Samples per fragment as multiple of 256. Default value 0 will interpreted as 16 (16*256==4096 samples per fragment).a maximum of 65536 samples per fragment is allowed (0<=samples256PerFragment<=256).maxFragments
- Maximum number of fragments. If the actual number of fragments exceeds this value, the first allready written fragment will be removed (ring-buffer). If value is set to 0, all fragments will be written.void close(long units)
units
- Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).