org.unisens

Class Event

java.lang.Object

org.unisens.Event

All Implemented Interfaces:

java.lang.Cloneable

public class Event
extends java.lang.Object
implements java.lang.Cloneable

An Event happens at a cetain point in time and be of a certain type. It can have a comment. Events have no signal or value data.

Constructor Summary

Constructors

Constructor and Description
Event(long samplestamp, java.lang.String type, java.lang.String comment) Event Contructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getComment() Gets the comment of this Event
long	getSamplestamp() Deprecated. use getSampleStamp
long	getSampleStamp() Gets the sample stamp of this Event.
java.lang.String	getType() Gets the the type of this Event.
void	setComment(java.lang.String comment) Sets the comment for this Event.
void	setSamplestamp(long samplestamp) Deprecated. use setSampleStamp
void	setSampleStamp(long sampleStamp) Sets the sample stamp of this Event.
void	setType(java.lang.String type) Sets the the type of this Event.
void	trim(int typeLength, int commentLength) Truncate comments and types when necessary

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Event

public Event(long samplestamp,
             java.lang.String type,
             java.lang.String comment)

Event Contructor

Parameters:

samplestamp - the samplestamp of this Event in sample counts

type - the type of this Event

comment - the comment of this Event

Method Detail

getComment

public java.lang.String getComment()

Gets the comment of this Event

Returns:

the comment

setComment

public void setComment(java.lang.String comment)

Sets the comment for this Event. The maximum comment length is defined in the EventEntry. If the comment is too long it will be truncated.

Parameters:

comment -

getSampleStamp

public long getSampleStamp()

Gets the sample stamp of this Event. The sample stamp is given in sample counts. The real time offset can be calculated using the sampleRate of the EventEntry.

Returns:

the sample stamp in sample counts

setSampleStamp

public void setSampleStamp(long sampleStamp)

Sets the sample stamp of this Event. The sample stamp is given in sample counts. The real time offset can be calculated using the sampleRate of the EventEntry

Parameters:

sampleStamp - the sample stamp in sample counts

getSamplestamp

@Deprecated
public long getSamplestamp()

Deprecated. use getSampleStamp

Gets the samplestamp of this Event. The samplestamp is given in sample counts. The real time offset can be calculated using the sampleRate of the EventEntry.

Returns:

the samplestamp in sample counts

See Also:

getSampleStamp()

setSamplestamp

@Deprecated
public void setSamplestamp(long samplestamp)

Deprecated. use setSampleStamp

Sets the samplestamp of this Event. The samplestamp is given in sample counts. The real time offset can be calculated using the sampleRate of the EventEntry

Parameters:

samplestamp - the samplestamp in sample counts

See Also:

setSampleStamp(long)

getType

public java.lang.String getType()

Gets the the type of this Event. The type can be one ore more characters. The length of the type is defined in the EventEntry.

Returns:

the type of this Event

setType

public void setType(java.lang.String type)

Sets the the type of this Event. The type can be one ore more characters. The length of the type is defined in the EventEntry.

Parameters:

type - the type of this Event

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

trim

public void trim(int typeLength,
                 int commentLength)

Truncate comments and types when necessary

Parameters:

typeLength - specified typeLength

commentLength - specified commentLength