public interface IStructSamplesWriter extends ISamplesWriter
ISamples.ProcessType, ISamples.SignalDescriptor, ISamples.SignalType, ISamples.TagDomain
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_4
ACCURACY_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 |
---|---|
StructMember |
createMember(StructMember[] members,
int idx,
String name,
int type,
String content,
int format)
Creates a member of a member array.
|
StructMember[] |
createMembers(int size)
Creates the member array.
|
boolean |
write(long units,
boolean tag,
int id,
int order,
int layer,
StructMember[] value)
Write grouped struct sample (e.g a transaction).
|
boolean |
write(long units,
boolean tag,
StructMember[] value)
Write non-grouped struct sample (e.g a log with multiple entries).
|
addMarker, addMember, apply, attachLabel, attachLabel, attachLabel, attachLabel, attachRelation, attachRelation, attachRelation, attachRelation, attachRelation, attachRelation, close, close, flush, flush, getCount, getGroups, getMaxUnits, isEmpty, isOpen, open, open, open, open, open, setDomainBase, setEnum, setId, setLegend, setMember, setMember, setName, setTagDomain, write, writeNone, writeSample, writeSample, writeSample, writeSample, writeSample, writeSample, writeSample, writeSample
getData, getData, getError, getId, getLegend, getMarkers, getMessage, getName, getPackVersion, getSamples, getSamplesDomainBase, getService, setData, setData
getAccuracy, getContent, getDomainBase, getEnd, getEndUnits, getFlags, getFormat, getProcessType, getRate, getRateUnits, getRelease, getScale, getSignalDescriptor, getSignalType, getStart, getStartUnits, getTagDomain, hasConflict, hasTag, isMonotonous, isReleased, isVolatile
boolean write(long units, boolean tag, StructMember[] value)
Example (Java) StructMember value[] = new StructMember[2]; value[0] = new StructMember("Message", StructMember.STRUCT_TYPE_TEXT, null, ISamples.FORMAT_DEFAULT); value[1] = new StructMember("Data", StructMember.STRUCT_TYPE_INTEGER, null, ISamples.FORMAT_HEXADECIMAL); .... value[0].setValue("Start"); value[1].setValue(100); writer.write(1000L, false, value); Example (JavaScript) var value <:[StructMember:> = out.createMembers(6); out.createMember(value, 0, "RW", ISample.STRUCT_TYPE_ENUM, null, ISample.FORMAT_DEFAULT); out.createMember(value, 1, "Address", ISample.STRUCT_TYPE_INTEGER, null, ISample.FORMAT_HEXADECIMAL); value[0].setValue("Write"); value[1].setValue(new java.lang.Integer(100)); out.write(1000, false, value);
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.value
- Value to be inserted.boolean write(long units, boolean tag, int id, int order, int layer, StructMember[] value)
Example (Java) StructMember value[] = new StructMember[2]; value[0] = new StructMember("Message", StructMember.STRUCT_TYPE_TEXT, null, ISamples.FORMAT_DEFAULT); value[1] = new StructMember("Data", StructMember.STRUCT_TYPE_INTEGER, null, ISamples.FORMAT_HEXADECIMAL); .... int id = 0; // must iterate from 0 to N for each transaction per signal value[0].setValue("Start"); value[1].setValue(100); writer.write(1000L, false,id,ISample.GO_FIRST,0, value); value[0].setValue("Started"); value[1].setValue(0); writer.write(1000L, false,id,ISample.GO_FIRST,0, value); Example (JavaScript) var value <:[StructMember:> = out.createMembers(2); out.createMember(value, 0, "RW", ISample.STRUCT_TYPE_ENUM, null, ISample.FORMAT_DEFAULT); out.createMember(value, 1, "Address", ISample.STRUCT_TYPE_INTEGER, null, ISample.FORMAT_HEXADECIMAL); ... var id = 0; // must iterate from 0 to N for each transaction per signal value[0].setValue("Write"); value[1].setValue(new java.lang.Integer(100)); out.write( 1000, false,id,ISample.GO_FIRST,0,value); value[0].setValue("Written"); value[1].setValue(new java.lang.Integer(0)); out.write( 2000, false,id,ISample.GO_LAST,0,value);
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.id
- The group id (0..N)order
- layer
- (0..255)value
- Value to be inserted.StructMember[] createMembers(int size)
Example (JavaScript) var value <:[StructMember:> = out.createMembers(2); out.createMember(value, 0, "RW", ISample.STRUCT_TYPE_ENUM, null, ISample.FORMAT_DEFAULT); out.createMember(value, 1, "Address", ISample.STRUCT_TYPE_INTEGER, null, ISample.FORMAT_HEXADECIMAL);
size
- No of membersStructMember createMember(StructMember[] members, int idx, String name, int type, String content, int format)
Example (JavaScript) var value <:[StructMember:> = out.createMembers(2); out.createMember(value, 0, "RW", ISample.STRUCT_TYPE_ENUM, null, ISample.FORMAT_DEFAULT); out.createMember(value, 1, "Address", ISample.STRUCT_TYPE_INTEGER, null, ISample.FORMAT_HEXADECIMAL);
members
- The member array.idx
- Index of the member to be created.name
- Name of the member.type
- Type of the member (ISample.STRUCT_TYPE_... )content
- Content desciption.format
- Format to be used to present the value ( ISample.FORMAT_...)