public interface ISamplesWriter extends IPackedSamples
ISamples.ProcessType, ISamples.SignalDescriptor, ISamples.SignalType, ISamples.TagDomain| Modifier and Type | Field and Description |
|---|---|
static long |
NEXT_UNITS |
HEAD_BLOCKSIZE, HEAD_FLAGS_LENGTH, HEAD_FLAGS_POS, HEAD_FRAGSIZE_LENGTH, HEAD_ID_LENGTH, HEAD_ID_POS, HEAD_LENGTH, HEAD_SAMPLES_PER_FRAGMENT_POS, HEAD_VERSION_LENGTH, HEAD_VERSION_POS, HEADV2_LENGTH, ID, VERSION, VERSION_3, VERSION_4ACCURACY_DEFAULT, AT_ANY, AT_ASSOC, AT_ASSOC_DELTA, AT_ASSOC_DELTA_REV, AT_ASSOC_POS, AT_ASSOC_POS_REV, AT_LABEL, AT_MULT, AT_RELATION, CONTENT_CHART, CONTENT_DEFAULT, CONTENT_EVENT, CONTENT_EVENTPARM, CONTENT_GANTT, CONTENT_IMAGE, CONTENT_LABEL, CONTENT_LOG, CONTENT_STATE, CONTENT_TRANSACTION, COUNT_FORMATS, DEFAULT_PLUS_LENGTH, DF_BINARY, DF_ENUM_EVENT, DF_EVENT, DF_FLOAT, DF_INTEGER, DF_LOGIC_16, DF_LOGIC_2, DF_LOGIC_4, DF_NONE, DF_STRUCT, DF_TEXT, ENUM_ASSOC_DOMAINBASE, ENUM_ASSOC_STYLE, ENUM_ASSOC_TARGET, ENUM_GLOBAL, ENUM_LABEL_STYLE, ENUM_MAX, ENUM_MEMBER_0, ENUM_MIN, FLOAT_ACCURACY_32, FLOAT_ACCURACY_64, FLOAT_ACCURACY_BIG, FLOAT_ACCURACY_DEFAULT, FORMAT_ASCII, FORMAT_BINARY, FORMAT_BOOLEAN, FORMAT_COLLECTION_DEFAULT, FORMAT_COLLECTION_KEY_VALUES, FORMAT_COLLECTION_MASK, FORMAT_COLLECTION_MEMBER_0, FORMAT_COLLECTION_MEMBER_1, FORMAT_COLLECTION_MEMBER_2, FORMAT_COLLECTION_MEMBER_3, FORMAT_COLLECTION_VALUES_ONLY, FORMAT_DECIMAL, FORMAT_DECIMAL_F_MAX, FORMAT_DECIMAL_F_MIN, FORMAT_DECIMAL_F0, FORMAT_DECIMAL_F1, FORMAT_DECIMAL_F2, FORMAT_DECIMAL_F3, FORMAT_DECIMAL_F4, FORMAT_DECIMAL_F5, FORMAT_DECIMAL_F6, FORMAT_DECIMAL_F7, FORMAT_DEFAULT, FORMAT_DELTA_DOMAIN, FORMAT_DELTA_VALUE, FORMAT_EVENT, FORMAT_GROUP_INDEX, FORMAT_GROUP_ORDER, FORMAT_HEXADECIMAL, FORMAT_INDEX, FORMAT_MEMBER_0, FORMAT_MEMBER_1, FORMAT_NONE, FORMAT_OCTAL, FORMAT_R4, FORMAT_R5, FORMAT_R6, FORMAT_R7, FORMAT_R8, FORMAT_RELATION_MAX, FORMAT_RELATION_MIN, FORMAT_SIMPLE_MAX, FORMAT_SIMPLE_MIN, FORMAT_SL_TEXT, FORMAT_TEXT, FORMAT_VALUE_DEFAULT, FORMAT_VALUE_MASK, formatCollectionLabels, formatCollectionOptions, formatValueLabels, formatValueOptions, GO_FIRST, GO_INTER, GO_LAST, GO_NONE, GROUP_ORDER_LABELS, INTEGER_ACCURACY_32, INTEGER_ACCURACY_64, INTEGER_ACCURACY_BIG, INTEGER_ACCURACY_DEFAULT, LOGIC_L16_BYTE_FILL, LOGIC_L2_BYTE_FILL, LOGIC_L4_BYTE_FILL, LOGIC_PACK_0, LOGIC_PACK_1, LOGIC_PACK_RIGHT_ALLIGNED, MASK_FORMAT_0_A, MASK_FORMAT_0_AT, MASK_FORMAT_0_DF, MASK_FORMAT_0_GO, MASK_FORMAT_0_N, MASK_FORMAT_0_T, MASK_FORMAT_0_XDF, MASK_FORMAT_1_S0, MASK_FORMAT_1_S0_PLUS, MASK_FORMAT_1_TF, MASK_PLUS, MASK_PLUS_DATA, MAX_DATA, MAX_LAYERS, MAX_SAMPLE_SIZE, MAX_SCALE, SHIFT_FORMAT_0_D, SHIFT_FORMAT_0_DF, SHIFT_FORMAT_0_GO, SHIFT_FORMAT_0_XDF, SHIFT_FORMAT_1_TF, STATE_0_BITS, STATE_1_BITS, STATE_D_BITS, STATE_H_BITS, STATE_J_BITS, STATE_K_BITS, STATE_L_BITS, STATE_LC_DIGITS, STATE_LEVEL_16, STATE_LEVEL_2, STATE_LEVEL_4, STATE_LEVEL_NONE, STATE_M_BITS, STATE_N_BITS, STATE_O_BITS, STATE_P_BITS, STATE_U_BITS, STATE_UC_DIGITS, STATE_UNKNOWN_BITS, STATE_W_BITS, STATE_X_BITS, STATE_Z_BITS, STRUCT_MASK_TYPE, STRUCT_MOD_HIDDEN, STRUCT_MOD_VALID_UNTIL_CHANGE, STRUCT_TYPE_BINARY, STRUCT_TYPE_BOOLEAN, STRUCT_TYPE_ENUM, STRUCT_TYPE_FLOAT, STRUCT_TYPE_INTEGER, STRUCT_TYPE_LOCAL_ENUM, STRUCT_TYPE_MAX, STRUCT_TYPE_MERGE_ENUM, STRUCT_TYPE_STRUCT, STRUCT_TYPE_TEXT, STRUCT_TYPE_UNKNOWN, UF_ABSOLUTE_8, UF_DELTA_0, UF_DELTA_1, UF_DELTA_2, UF_DELTA_4, UF_DELTA_8, UF_DELTA_PREVIOUS, XDF_FLOAT_32, XDF_FLOAT_64, XDF_FLOAT_BIG, XDF_FLOAT_DEFAULT, XDF_INTEGER_32, XDF_INTEGER_64, XDF_INTEGER_BIG, XDF_INTEGER_DEFAULT, XDF_LOGIC_PACK_0, XDF_LOGIC_PACK_1, XDF_LOGIC_PACK_RIGHT_ALLIGNED, XDF_NONE| Modifier and Type | Method and Description |
|---|---|
boolean |
addMarker(de.toem.pattern.element.exploits.Marker marker)
Adds a marker.
|
int |
addMember(String name,
String content,
int format)
Deprecated.
|
boolean |
apply(Signal signal)
Apply writer data to the given signal.
|
boolean |
attachLabel(int styleId)
Adds a label to the previous sample.
|
boolean |
attachLabel(int style,
int x,
int y)
Deprecated.
|
boolean |
attachLabel(String style)
Adds a label to the previous sample.
|
boolean |
attachLabel(String style,
int x,
int y)
Deprecated.
|
boolean |
attachRelation(int type,
int targetId,
int styleId,
long deltaOrPosition) |
boolean |
attachRelation(int type,
int targetId,
int styleId,
long deltaOrPosition,
int targetBaseId) |
boolean |
attachRelation(int targetId,
int styleId,
long delta)
Adds an relation to the previous sample.
|
boolean |
attachRelation(int type,
String target,
String style,
long deltaOrPosition) |
boolean |
attachRelation(int type,
String target,
String style,
long deltaOrPosition,
IDomainBase targetBase) |
boolean |
attachRelation(String target,
String style,
long delta)
Adds an relation to the previous sample.
|
void |
close()
Close the writer latest write position.
|
void |
close(long units)
Close the writer at position 'units'.
|
void |
flush()
Flush current writer data into its packed samples.
|
void |
flush(long units)
Flush current writer data into its packed samples.
|
int |
getCount()
Returns the no of available samples.
|
int |
getGroups()
Samples may be organized in groups (e.g transactions).
|
long |
getMaxUnits()
Returns the domain max position for this open session as a multiple of
its domain base (e.g. domain base=1ms; units = 100; -> domain value =
100ms).
|
boolean |
isEmpty()
Returns true if no sample available.
|
boolean |
isOpen()
Returns true if writer has been opened.
|
boolean |
open(long units)
Open the writer, starting at position 'units'.
|
boolean |
open(long units,
int samples256PerFragment,
int maxFragments,
de.toem.pattern.pageable.Pageable<byte[]> samples)
Open the writer, starting at position 'units' with mode (mode/limitation)
using 'samples' to store the data.
|
boolean |
open(long units,
long rate,
int samples256PerFragment,
int maxFragments,
de.toem.pattern.pageable.Pageable<byte[]> samples)
Open the writer, starting at position 'units' and rate 'rate' (continuous
process) and mode (mode/limitation) using 'samples' to store the data.
|
boolean |
open(long units,
long maxUnits,
long rate,
int samples256PerFragment,
int maxFragments,
de.toem.pattern.pageable.Pageable<byte[]> samples)
Open the writer, starting at position 'units' and rate 'rate' (continuous
process) and mode (mode/limitation) using 'samples' to store the data.
|
boolean |
open(long units,
de.toem.pattern.pageable.Pageable<byte[]> samples)
Open the writer, starting at position 'units' , using 'samples' to store
the data.
|
void |
setDomainBase(IDomainBase domainBase)
Sets the domain base.
|
boolean |
setEnum(int enumerationGroup,
String label,
int value)
Adds an enumeration to to the writers legend.
|
void |
setId(String id)
Sets the identifier.
|
void |
setLegend(ISamplesLegend legend)
Sets the legend.
|
boolean |
setMember(int id,
String name,
int type,
String content,
int format)
Adds a named elements of an array/struct to the writers legend.
|
boolean |
setMember(int id,
String name,
String content,
int format)
Adds a named elements of an array/struct to the writers legend.
|
void |
setName(String name)
Sets the name.
|
void |
setTagDomain(ISamples.TagDomain tagDomain)
Sets the tag domain.
|
boolean |
write(long units,
boolean tag)
Writes a none sample.
|
boolean |
writeNone(long units,
boolean tag)
Same as write(long units, boolean tag).
|
boolean |
writeSample(CompoundPack packed)
Sample write primitive method.
|
boolean |
writeSample(CompoundValue value) |
boolean |
writeSample(long units,
boolean tag,
int group,
int order,
int layer,
Object value) |
boolean |
writeSample(long units,
boolean tag,
Object value) |
boolean |
writeSample(long units,
byte format0)
Sample write primitive method.
|
boolean |
writeSample(long units,
byte format0,
byte data0)
Sample write primitive method.
|
boolean |
writeSample(long units,
byte format0,
byte[] data,
int start,
int dlength)
Sample write primitive method.
|
boolean |
writeSample(long units,
byte format0,
int group,
int layer,
byte[] data,
int start,
int dlength)
Sample write primitive method.
|
getData, getData, getError, getId, getLegend, getMarkers, getMessage, getName, getPackVersion, getSamples, getSamplesDomainBase, getService, setData, setDatagetAccuracy, getContent, getDomainBase, getEnd, getEndUnits, getFlags, getFormat, getProcessType, getRate, getRateUnits, getRelease, getScale, getSignalDescriptor, getSignalType, getStart, getStartUnits, getTagDomain, hasConflict, hasTag, isMonotonous, isReleased, isVolatilestatic final long NEXT_UNITS
void setId(String id)
id - void setName(String name)
name - void setDomainBase(IDomainBase domainBase)
domainBase - void setTagDomain(ISamples.TagDomain tagDomain)
tagDomain - boolean isEmpty()
int getCount()
int getGroups()
boolean isOpen()
boolean open(long units)
units - Domain position as a multiple of its domain base (e.g. domain
base=1ms; units = 100; -> domain value = 100ms).boolean open(long units,
de.toem.pattern.pageable.Pageable<byte[]> samples)
units - Domain start position as a multiple of its domain base (e.g.
domain base=1ms; units = 100; -> domain value = 100ms).samples - Samples container.boolean open(long units,
int samples256PerFragment,
int maxFragments,
de.toem.pattern.pageable.Pageable<byte[]> samples)
units - Domain start position as a multiple of its domain base (e.g.
domain base=1ms; units = 100; -> domain value = 100ms).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.samples - Samples container.boolean open(long units,
long rate,
int samples256PerFragment,
int maxFragments,
de.toem.pattern.pageable.Pageable<byte[]> samples)
units - Domain start position as a multiple of its domain base (e.g.
domain base=1ms; units = 100; -> domain value = 100ms).rate - Domain rate distance as a multiple of its domain base.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.samples - Samples container.boolean open(long units,
long maxUnits,
long rate,
int samples256PerFragment,
int maxFragments,
de.toem.pattern.pageable.Pageable<byte[]> samples)
units - Domain start position as a multiple of its domain base (e.g.
domain base=1ms; units = 100; -> domain value = 100ms).maxUnits - Domain max position for this open session as a multiple of its
domain base.rate - Domain rate distance as a multiple of its domain base.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.samples - Samples container.long getMaxUnits()
void close()
units - Domain position as a multiple of its domain base (e.g. domain
base=1ms; units = 100; -> domain value = 100ms). Consecutive
calls need to pass a value greater or equal.void close(long units)
units - Domain end position as a multiple of its domain base (e.g.
domain base=1ms; units = 100; -> domain value = 100ms).
Consecutive calls need to pass a value greater or equal.void flush(long units)
units - Domain position as a multiple of its domain base (e.g. domain
base=1ms; units = 100; -> domain value = 100ms). Consecutive
calls need to pass a value greater or equal.void flush()
boolean apply(Signal signal)
signal - Target signal.void setLegend(ISamplesLegend legend)
legend - @Deprecated int addMember(String name, String content, int format)
name - Name of the member.content - Content description of the member, or null.format - Format specifier defining how to render the value (e.g.
ISample.FORMAT_DECIMAL).boolean setMember(int id,
String name,
String content,
int format)
id - Index/Id of the member.name - Name of the member.content - Content description of the member, or null.format - Format specifier defining how to render the value (e.g.
ISample.FORMAT_DECIMAL).boolean setMember(int id,
String name,
int type,
String content,
int format)
id - Index/Id of the member.name - Name of the member.type - Data type (struct only) of the member.content - Content description of the member, or null.format - Format specifier defining how to render the value (e.g.
ISample.FORMAT_DECIMAL).boolean setEnum(int enumerationGroup,
String label,
int value)
enumerationGroup - Enumeration group, 0 for global enumeration.label - String representation of the enumeration.value - int value of the enumeration..boolean addMarker(de.toem.pattern.element.exploits.Marker marker)
marker - Marker to be added.boolean attachRelation(String target, String style, long delta)
Example (Java)
generator.getWriter(databus).write(t+25,false,Logic.valueOf(d));
generator.getWriter(databus).attachRelation(databus.getPath(),"Full=${delta}/fa752e", 200);
target - Path to associated signal (e.g. "\\signal\\reset").style - Style definition in the form 'text/color{e.g. fa752e
}/lineStyle{cubic,line,none}/arrowStyle{normal,none}'.deltaOrPosition - Distance as a multiple of its domain base (e.g.
domain base=1ms; units = 100; -> domain value = 100ms).boolean attachRelation(int type,
String target,
String style,
long deltaOrPosition,
IDomainBase targetBase)
boolean attachRelation(int targetId,
int styleId,
long delta)
Example (Java) generator.getWriter(databus).write(t+25,false,Logic.valueOf(d)); generator.getWriter(databus).attachRelation(targetId,styledId, 200);
targetId - Path to associated signal (e.g. "\\signal\\reset").styleId - Style definition in the form 'text/color{e.g. fa752e
}/lineStyle{cubic,line,none}/arrowStyle{normal,none}'.position - Distance as a multiple of its domain base (e.g.
domain base=1ms; units = 100; -> domain value = 100ms).boolean attachRelation(int type,
int targetId,
int styleId,
long deltaOrPosition)
boolean attachRelation(int type,
int targetId,
int styleId,
long deltaOrPosition,
int targetBaseId)
boolean attachLabel(String style)
Example (Java)
generator.getWriter(databus).write(t+25,false,Logic.valueOf(d));
generator.getWriter(databus).attachLabel("text/ff0000/add");
style - Style definition in the form 'text/color{e.g. fa752e }/image'.@Deprecated boolean attachLabel(String style, int x, int y)
@Deprecated boolean attachLabel(int style, int x, int y)
boolean attachLabel(int styleId)
Example (Java) generator.getWriter(databus).write(t+25,false,Logic.valueOf(d)); generator.getWriter(databus).attachLabel(styleId);
styleId - Style definition in the form 'text/color{e.g. fa752e }/image'.boolean write(long units,
boolean tag)
units - Domain position as a multiple of its domain base (e.g. domain
base=1ms; units = 100; -> domain value = 100ms).tag - If set to true, impulse will use tag color (usually red)
to paint the sample. Meaning of "tag is use-case
depended.boolean writeNone(long units,
boolean tag)
units - Domain position as a multiple of its domain base (e.g. domain
base=1ms; units = 100; -> domain value = 100ms). Consecutive
calls need to pass a value greater or equal.tag - If set to true, impulse will use tag color (usually red)
to paint the sample. Meaning of "tag is use-case
depended.boolean writeSample(long units,
byte format0)
units - format0 - boolean writeSample(long units,
byte format0,
byte data0)
units - format0 - data0 - boolean writeSample(long units,
byte format0,
byte[] data,
int start,
int dlength)
units - format0 - data - start - dlength - boolean writeSample(long units,
byte format0,
int group,
int layer,
byte[] data,
int start,
int dlength)
units - format0 - group - layer - data - start - dlength - boolean writeSample(CompoundPack packed)
packed - boolean writeSample(CompoundValue value)
boolean writeSample(long units,
boolean tag,
Object value)
boolean writeSample(long units,
boolean tag,
int group,
int order,
int layer,
Object value)