de.toem.impulse.samples

Interface IPointer

All Superinterfaces:

IPackedSamples, IReadableSamples, ISample, ISampleConverter, ISamples, ISamplesReference

All Known Subinterfaces:

IGroupPointer, ISamplePointer

public interface IPointer
extends IReadableSamples

Interface for sample pointers

Nested Class Summary

Nested classes/interfaces inherited from interface de.toem.impulse.samples.ISamples

ISamples.ProcessType, ISamples.SignalDescriptor, ISamples.SignalType, ISamples.TagDomain

Field Summary

Fields inherited from interface de.toem.impulse.samples.IPackedSamples

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

Fields inherited from interface de.toem.impulse.samples.ISample

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

Method Summary

Modifier and Type	Method and Description
java.util.List<IAttachment>	attachments(int type) Returns all attachments of current group/sample.
int	defaultFormat() Returns the default format ( ISample.FORMAT_...).
String	format(int format) Formats the current group/sample using format 'format'.
long	getDelta() Returns the delta between position and the position of the indexed event (getUnits() - unitsAt(getIndex())
int	getIndex() Returns the current index.
int	getMaxIndex() Returns the maximal index.
int	getMinIndex() Returns the minimal index.
DomainValue	getPosition() Returns the position of the pointer.
DomainValue	getPosition(boolean atSample) Returns the position of the pointer. if atSample==true, the position is identical with the position of the indexed event (getPosition() == positionAt(getIndex()).
IPackedSamples	getReference() Returns the referenced samples object.
long	getUnits() Returns the position of the pointer (to be multiplied with the domain base).
long	getUnits(boolean atSample) Returns the position of the pointer (to be multiplied with the domain base). if atSample==true, the position is identical with the position of the indexed event (getUnits() == unitsAt(getIndex()).
boolean	goEnd() Goto last sample.
boolean	goNext() Got to next sample.
boolean	goPos1() Goto first sample.
boolean	goPrev() Go to previous sample.
boolean	hasNext() Returns true if a next sample is exists.
boolean	hasPrev() Returns true if a previous sample is exists.
IPointer	relative(DomainValue delta) Returns a new pointer with relative position.
IPointer	relative(long delta) Returns a new pointer with relative position.
IPointer	relative(String delta) Returns a new pointer with relative position.
void	setDelta(long delta) Internal use only!
void	setIndex(int index) Sets the samples index (0
void	setPosition(DomainValue position) Sets the position of the pointer.
void	setUnits(long units) Sets the position of the pointer.
Object	val() Returns the current value.

Methods inherited from interface de.toem.impulse.samples.IReadableSamples

attachmentsAt, attachmentsAtGroup, bigDecimalValueAt, bigIntValueAt, bytesValueAt, compoundAt, compoundAt, defaultFormatAt, doubleValueAt, ensureSettled, enumValueAt, fasciiAt, fbinAt, fdecAt, fhexAt, floatValueAt, foctAt, formatAt, getCount, getEnums, getGroups, getMemberDescriptor, getMemberDescriptors, getMemberEnums, getProducer, getReader, getStat, groupAt, indexAt, indexAt, indexAtGroup, intValueAt, isConflictAt, isEdgeAt, isEdgeAt, isEmpty, isHighAt, isHighAt, isLowAt, isLowAt, isNoneAt, isSettled, isSettling, isTaggedAt, logicStateAt, logicValueAt, longValueAt, membersWithContent, numberValueAt, orderAt, packedAt, positionAt, stringValueAt, structValueAt, unitsAt, valueAt, valuesAtGroup, valuesAtGroup

Methods inherited from interface de.toem.impulse.samples.IPackedSamples

getData, getData, getError, getId, getLegend, getMarkers, getMessage, getName, getPackVersion, getSamples, getSamplesDomainBase, getService, setData, setData

Methods inherited from interface de.toem.impulse.samples.ISamples

getAccuracy, getContent, getDomainBase, getEnd, getEndUnits, getFlags, getFormat, getProcessType, getRate, getRateUnits, getRelease, getScale, getSignalDescriptor, getSignalType, getStart, getStartUnits, getTagDomain, hasConflict, hasTag, isMonotonous, isReleased, isVolatile

Methods inherited from interface de.toem.impulse.samples.ISampleConverter

bigDecimalValue, bigIntValue, booleanValue, bytesValue, charValue, doubleValue, enumValue, floatValue, format, format, getConverterConfiguration, intValue, isHigh, isLow, logicState, logicValue, longValue, numberValue, stringValue, stringValue, structValue

Method Detail

getReference

IPackedSamples getReference()

Returns the referenced samples object.

goPrev

boolean goPrev()

Go to previous sample.

 Example (JavaScript)
 
  console.println(in0.getPosition());
  if (in0.goPrev())
     console.println(in0.getPosition());
 

goNext

boolean goNext()

Got to next sample.

 Example (JavaScript)
 
  console.println(in0.getPosition());
  if (in0.goNext())
     console.println(in0.getPosition());
 

hasPrev

boolean hasPrev()

Returns true if a previous sample is exists.

hasNext

boolean hasNext()

Returns true if a next sample is exists.

goPos1

boolean goPos1()

Goto first sample. Returns true if index was changed.

goEnd

boolean goEnd()

Goto last sample. Returns true if index was changed.

setIndex

void setIndex(int index)

Sets the samples index (0 Example (JavaScript) console.println(in0.getPosition()); in0.setIndex(in0.getCount()-1); console.println(in0.getPosition());

getIndex

int getIndex()

Returns the current index.

 Example (JavaScript)
 
  console.println(in0.getIndex());
  in0.goNext();
  console.println(in0.getIndex());
 

getMaxIndex

int getMaxIndex()

Returns the maximal index.

getMinIndex

int getMinIndex()

Returns the minimal index.

getUnits

long getUnits()

Returns the position of the pointer (to be multiplied with the domain base). The position may not be identical with the position of the indexed event (getUnits() != unitsAt(getIndex()). Same as getUnits(false)

 Example (JavaScript)
 
  console.println(in0.getUnits());
  in0.goNext();
  console.println(in0.getUnits());
 

getUnits

long getUnits(boolean atSample)

Returns the position of the pointer (to be multiplied with the domain base). if atSample==true, the position is identical with the position of the indexed event (getUnits() == unitsAt(getIndex()).

Parameters:

atSample - If true, the method returns the position of the indexed event.

 Example (JavaScript)
 
  console.println(in0.getUnits());
  in0.goNext();
  console.println(in0.getUnits());
 

getPosition

DomainValue getPosition()

Returns the position of the pointer. The position may not be identical with the position of the indexed event (getPosition() != positionAt(getIndex()). Same as getPosition(false)

 Example (JavaScript)
 
  console.println(in0.getPosition());
  in0.goNext();
  console.println(in0.getPosition());
 

getPosition

DomainValue getPosition(boolean atSample)

Returns the position of the pointer. if atSample==true, the position is identical with the position of the indexed event (getPosition() == positionAt(getIndex()).

Parameters:

atSample - If true, the method returns the position of the indexed event.

 Example (JavaScript)
 
  console.println(in0.getPosition());
  in0.goNext();
  console.println(in0.getPosition());
 

setDelta

void setDelta(long delta)

Internal use only! Sets the delta between position and the position of the indexed event (getUnits() - unitsAt(getIndex())

Parameters:

delta - Domain distance as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).

getDelta

long getDelta()

Returns the delta between position and the position of the indexed event (getUnits() - unitsAt(getIndex())

setUnits

void setUnits(long units)

Sets the position of the pointer.

Parameters:

units - Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).

setPosition

void setPosition(DomainValue position)

Sets the position of the pointer.

Parameters:

position - Domain position as a DomainValue object (combination of domain base and factor).

relative

IPointer relative(String delta)

Returns a new pointer with relative position.

Parameters:

delta - Domain distance as a text describing the domain value (e.g. 10ms).

relative

IPointer relative(DomainValue delta)

Returns a new pointer with relative position.

Parameters:

delta - Domain distance as a DomainValue object (combination of domain base and factor).

relative

IPointer relative(long delta)

Returns a new pointer with relative position.

Parameters:

delta - Domain distance as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).

val

Object val()

Returns the current value.

 Example (JavaScript)
 
  console.println(in0.val());
  in0.goNext();
  console.println(in0.val());
 

attachments

java.util.List<IAttachment> attachments(int type)

Returns all attachments of current group/sample.

Parameters:

type -

format

String format(int format)

Formats the current group/sample using format 'format'.

Parameters:

format - Format specifier as defined in ISample.FORMAT_.. (e.g. ISample.FORMAT_HEXADECIMAL)

defaultFormat

int defaultFormat()

Returns the default format ( ISample.FORMAT_...).

Returns:

format specifier as defined in ISample.FORMAT_.. (e.g. ISample.FORMAT_HEXADECIMAL)