de.toem.impulse.samples

Interface IRecordGenerator

All Known Subinterfaces:

ISingleDomainRecordGenerator

public interface IRecordGenerator

Method Summary

Modifier and Type	Method and Description
FolderConfiguration	addFolderConfiguration(ICell container, Scope scope) Add a new folder configuration.
FolderConfiguration	addFolderConfiguration(ICell container, String name, String description) Adds a new folder to the configuration.
PlotConfiguration	addPlotConfiguration(ICell container, AbstractSignal source) Add a new samples configuration (plot) for a given source (signal).
PlotConfiguration	addPlotConfiguration(ICell container, String name, String description) Add a new samples configuration (plot).
Scope	addScope(ICell container, String name) Adds a new scope.
Scope	addScope(ICell container, String name, String description) Adds a new scope.
Signal	addSignal(ICell container, String name, String description, ISamples.ProcessType processType, ISamples.SignalType signalType, ISamples.SignalDescriptor signalDescriptor, IDomainBase domainBase) Adds a new signals (and creates a writer).
Signal	addSignal(ICell container, String name, String description, ISamples.ProcessType processType, ISamples.SignalType signalType, ISamples.SignalDescriptor signalDescriptor, IDomainBase domainBase, boolean createWriter) Adds a new signals.
SignalProxy	addSignalProxy(ICell container, String name, String description, Signal signal) Creates a proxy for en existing signal.
ViewConfiguration	addViewConfiguration(String name, String description) Adds a new viewer configuration (views).
ViewConfiguration	addViewConfiguration(ViewConfiguration config) Adds a new viewer configuration (views).
ViewConfiguration	addViewConfigurations(byte[] wallet) Adds new configurations (views) from a wallet binary.
void	apply() Applies the writer results to their signals.
de.toem.impulse.samples.writer.IConvergingSamplesWriter	createConvergingWriter(Signal signal, ISamples.ProcessType processType, ISamples.SignalType signalType, ISamples.SignalDescriptor signalDescriptor, IDomainBase domainBase) Creates a converging writer for the signal.
de.toem.impulse.samples.writer.IDivergingSamplesWriter	createDivergingWriter(ISamplesWriter initialTarget) Creates a converging writer for the signal.
ISamplesReader	createReader(Signal signal) Creates a reader for the signal.
ISamplesWriter	createWriter(Signal signal) Creates a writer for the signal.
ISamplesWriter	createWriter(Signal signal, ISamples.ProcessType processType, ISamples.SignalType signalType, ISamples.SignalDescriptor signalDescriptor, IDomainBase domainBase) Creates a writer for the signal.
java.util.List<ICell>	getAllSignals() Returns a list of all signals.
ICell	getBase() Answers the base cell of the generator, typically the record.
Scope	getScope(String path) Returns the scope at given path.
Signal	getSignal(String path) Returns the signal at given path.
ISamplesWriter	getWriter(Signal signal) Returns the writer creates with addSignal(..).
void	initRecord(String name) Inits the record.

Method Detail

initRecord

void initRecord(String name)

Inits the record.

 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);
 

Parameters:

name - to be used as record name.

getBase

ICell getBase()

Answers the base cell of the generator, typically the record.

getSignal

Signal getSignal(String path)

Returns the signal at given path.

 Example (JavaScript)
 
  generator.initRecord("Example Record",TimeBase.ns);
  generator.addScope(null, "External Signals");
  generator.addSignal(signals, "Clk", "", ProcessType.Discrete, SignalType.Logic, SignalDescriptor.DEFAULT);
  console.println(generator.getScope("\\External Signals"));
  console.println(generator.getSignal("\\External Signals\\Clk"));
 

Parameters:

path - Pointing to the signal.

getAllSignals

java.util.List<ICell> getAllSignals()

Returns a list of all signals.

getScope

Scope getScope(String path)

Returns the scope at given path.

Parameters:

path - Pointing to the scope.

addScope

Scope addScope(ICell container,
               String name)

Adds a new scope.

 Example (JavaScript)
 
  generator.initRecord("Example Record",TimeBase.ns);
  generator.addScope(null, "External Signals");
  generator.addSignal(signals, "Clk", "", ProcessType.Discrete, SignalType.Logic, SignalDescriptor.DEFAULT);
  console.println(generator.getScope("\\External Signals"));
  console.println(generator.getSignal("\\External Signals\\Clk"));
 

Parameters:

container - Parent of new scope, or null (for root).

name - Name of the new scope.

addScope

Scope addScope(ICell container,
               String name,
               String description)

Adds a new scope.

 Example (JavaScript)
 
  generator.initRecord("Example Record",TimeBase.ns);
  generator.addScope(null, "External Signals","Just for this");
  generator.addSignal(signals, "Clk", "", ProcessType.Discrete, SignalType.Logic, SignalDescriptor.DEFAULT);
  console.println(generator.getScope("\\External Signals"));
  console.println(generator.getSignal("\\External Signals\\Clk"));
 

Parameters:

container - Parent of new scope, or null (for root).

name - Name of the new scope.

description - Scope description (just comments).

addSignal

Signal addSignal(ICell container,
                 String name,
                 String description,
                 ISamples.ProcessType processType,
                 ISamples.SignalType signalType,
                 ISamples.SignalDescriptor signalDescriptor,
                 IDomainBase domainBase)

Adds a new signals (and creates a writer).

 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,TimeDomain.ms);
  var writer = generator.getWriter(clk);
 

Parameters:

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.

domainBase - Domain base in case of multi domain record.

addSignal

Signal addSignal(ICell container,
                 String name,
                 String description,
                 ISamples.ProcessType processType,
                 ISamples.SignalType signalType,
                 ISamples.SignalDescriptor signalDescriptor,
                 IDomainBase domainBase,
                 boolean createWriter)

Adds a new signals.

 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, null, true);
  var writer = generator.getWriter(clk);
 

Parameters:

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.

domainBase - Domain base in case of multi domain record, or null.

createWriter - Set to true to automatically create a writer

addSignalProxy

SignalProxy addSignalProxy(ICell container,
                           String name,
                           String description,
                           Signal signal)

Creates a proxy for en existing signal.

Parameters:

container - Parent of new signal, or null (for root).

name - Name of the new signal.

description - Signal description (just comments).

signal - Referenced signal

createWriter

ISamplesWriter createWriter(Signal signal)

Creates a writer for the signal.

Parameters:

signal - A Signal object.

createWriter

ISamplesWriter createWriter(Signal signal,
                            ISamples.ProcessType processType,
                            ISamples.SignalType signalType,
                            ISamples.SignalDescriptor signalDescriptor,
                            IDomainBase domainBase)

Creates a writer for the signal.

Parameters:

signal - A Signal object.

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.

domainBase - Domain base in case of multi domain record, or null.

createConvergingWriter

de.toem.impulse.samples.writer.IConvergingSamplesWriter createConvergingWriter(Signal signal,
                                                                               ISamples.ProcessType processType,
                                                                               ISamples.SignalType signalType,
                                                                               ISamples.SignalDescriptor signalDescriptor,
                                                                               IDomainBase domainBase)

Creates a converging writer for the signal.

Parameters:

signal - A Signal object.

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.

domainBase - Domain base in case of multi domain record, or null.

createDivergingWriter

de.toem.impulse.samples.writer.IDivergingSamplesWriter createDivergingWriter(ISamplesWriter initialTarget)

Creates a converging writer for the signal.

Parameters:

initialTarget - The initial target of the diverging writer.

getWriter

ISamplesWriter getWriter(Signal signal)

Returns the writer creates with addSignal(..).

 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,null);
  var writer = generator.getWriter(clk);
 

Parameters:

signal -

apply

void apply()

Applies the writer results to their signals.

addViewConfiguration

ViewConfiguration addViewConfiguration(String name,
                                       String description)

Adds a new viewer configuration (views).

 Example (JavaScript)
  var clk = generator.addSignal(signals, "Clk", "", ProcessType.Discrete, SignalType.Logic, SignalDescriptor.DEFAULT,null);
  ...
  var view = generator.addConfiguration( "Demo", "");
  var folder= generator.addFolderConfiguration( config, "My Folder", null);
  var plot= generator.addSamplesConfiguration( folder, clk);
 

Parameters:

name - Name of the new configuration.

description - Configuration description (just comments).

addViewConfiguration

ViewConfiguration addViewConfiguration(ViewConfiguration config)

Adds a new viewer configuration (views).

Parameters:

config - A RecordConfiguration object.

addViewConfigurations

ViewConfiguration addViewConfigurations(byte[] wallet)

Adds new configurations (views) from a wallet binary.

Parameters:

wallet - Byte representation of a wallet file.

addFolderConfiguration

FolderConfiguration addFolderConfiguration(ICell container,
                                           String name,
                                           String description)

Adds a new folder to the configuration.

 Example (JavaScript)
  var clk = generator.addSignal(signals, "Clk", "", ProcessType.Discrete, SignalType.Logic, SignalDescriptor.DEFAULT,null);
  ...
  var view = generator.addConfiguration( "Demo", "");
  var folder= generator.addFolderConfiguration( config, "My Folder", null);
  var plot= generator.addSamplesConfiguration( folder, clk);
 

Parameters:

container - Parent of new element.

name - Name of the new element.

description - Element description (just comments).

addFolderConfiguration

FolderConfiguration addFolderConfiguration(ICell container,
                                           Scope scope)

Add a new folder configuration.

Parameters:

container - Parent of new element.

scope - Scope object.

addPlotConfiguration

PlotConfiguration addPlotConfiguration(ICell container,
                                       String name,
                                       String description)

Add a new samples configuration (plot).

Parameters:

container - Parent of new element.

name - Name of the new element.

description - Element description (just comments).

addPlotConfiguration

PlotConfiguration addPlotConfiguration(ICell container,
                                       AbstractSignal source)

Add a new samples configuration (plot) for a given source (signal).

 Example (JavaScript)
  var clk = generator.addSignal(signals, "Clk", "", ProcessType.Discrete, SignalType.Logic, SignalDescriptor.DEFAULT,null);
  ...
  var view = generator.addConfiguration( "Demo", "");
  var folder= generator.addFolderConfiguration( config, "My Folder", null);
  var plot= generator.addSamplesConfiguration( folder, clk);
 

Parameters:

container - Parent of new element.

source - A Signal object.

createReader

ISamplesReader createReader(Signal signal)

Creates a reader for the signal.

Parameters:

signal - A Signal object.