public class DataDescription
extends java.lang.Object
DataEntry
.getContentClass()
)getType()
)getSampleRate()
)getNumberOfChannels()
)getNamesOfChannels()
)getBaseLine()
)getLsbValue()
)getUnit()
)getAdcResolution()
)getAdcZero()
)Constructor and Description |
---|
DataDescription(java.lang.String contentClass,
DataType type)
Creates a new
DataDescription . |
DataDescription(java.lang.String contentClass,
DataType type,
double sampleRate,
int numberOfChannels)
Creates a new
DataDescription . |
DataDescription(java.lang.String contentClass,
java.lang.String identifier,
DataType type,
double sampleRate,
int numberOfChannels)
Creates a new
DataDescription . |
Modifier and Type | Method and Description |
---|---|
int |
getAdcResolution()
Returns the
DataEntry 's ADC-resolution. |
int |
getAdcZero()
Returns the
DataEntry 's ADC's relative zero. |
int |
getBaseLine()
Returns the
DataEntry 's base-line-value. |
java.lang.String |
getContentClass()
Returns the
DataEntry 's content-class. |
java.lang.String |
getIdentifier()
Returns the
DataEntry 's identifier. |
double |
getLsbValue()
Returns the
DataEntry 's LSB-value. |
java.lang.String[] |
getNamesOfChannels()
Returns the names of the
DataEntry 's channel-names. |
int |
getNumberOfChannels()
Returns the number of channels which the
DataEntry consists of. |
double |
getSampleRate()
Returns the
DataEntry 's sample-rate (in Hz). |
DataType |
getType()
|
java.lang.String |
getUnit()
Returns the
DataEntry 's unit in which data is sent. |
boolean |
matches(DataDescription filter)
Determines whether the
DataDescription matches the passed
DataDescription. |
void |
setAdcResolution(int adcResolution)
Sets the
DataEntry 's ADC-resolution. |
void |
setAdcZero(int adcZero)
Sets the
DataEntry 's ADC's relative zero. |
void |
setBaseLine(int baseLine)
Sets the
DataEntry 's base-line-value. |
void |
setContentClass(java.lang.String contentClass)
Sets the
DataEntry 's content-class. |
void |
setDataType(DataType type)
|
void |
setIdentifier(java.lang.String identifier)
Sets the
DataEntry 's identifier. |
void |
setLsbValue(double lsbValue)
Sets the
DataEntry 's LSB-value. |
void |
setNamesOfChannels(java.lang.String[] namesOfChannels)
Sets the names of the
DataEntry 's channel-names. |
void |
setNumberOfChannels(int numberOfChannels)
Sets the
DataEntry 's number of channels. |
void |
setSampleRate(java.lang.Double sampleRate)
Sets the
DataEntry 's sample-rate (in Hz). |
void |
setUnit(java.lang.String unit)
Sets the
DataEntry 's unit in which data is sent. |
public DataDescription(java.lang.String contentClass, java.lang.String identifier, DataType type, double sampleRate, int numberOfChannels)
DataDescription
.contentClass
- Content-classes typically represent the purpose the data was
produced or will be used for and serves the purpose of
dispatching two components that need data for the same
purpose.identifier
- String specifying the kind of data further than just the
content-class. This could be the id of a user or an other,
comparable identification.type
- DataType
representing the type of data that will be
sent or can be received.sampleRate
- Represents the frequency in which data will be sent [in Hz].numberOfChannels
- Represents the number of channels the data will consist of.public DataDescription(java.lang.String contentClass, DataType type, double sampleRate, int numberOfChannels)
DataDescription
.contentClass
- Content-classes typically represent the purpose the data was
produced or will be used for and serves the purpose of
dispatching two components that need data for the same
purpose.type
- DataType
representing the type of data that will be
sent or can be received.sampleRate
- Represents the frequency in which data will be sent [in Hz].numberOfChannels
- Represents the number of channels the data will consist of.public DataDescription(java.lang.String contentClass, DataType type)
DataDescription
.contentClass
- Content-classes typically represent the purpose the data was
produced or will be used for and serves the purpose of
dispatching two components that need data for the same
purpose.type
- DataType
representing the type of data that will be
sent or can be received.public double getSampleRate()
DataEntry
's sample-rate (in Hz).DataEntry
's sample-rate (in Hz).public void setSampleRate(java.lang.Double sampleRate)
DataEntry
's sample-rate (in Hz).sampleRate
- the sample-rate to be set.public int getBaseLine()
DataEntry
's base-line-value.DataEntry
's base-line-value.public void setBaseLine(int baseLine)
DataEntry
's base-line-value.baseLine
- value to be set.public double getLsbValue()
DataEntry
's LSB-value.DataEntry
's LSB-value.public void setLsbValue(double lsbValue)
DataEntry
's LSB-value.lsbValue
- value to be set.public int getAdcResolution()
DataEntry
's ADC-resolution.DataEntry
's ADC-resolution.public void setAdcResolution(int adcResolution)
DataEntry
's ADC-resolution.adcResolution
- value to be set.public java.lang.String getContentClass()
DataEntry
's content-class.DataEntry
's content-class.public void setContentClass(java.lang.String contentClass)
DataEntry
's content-class.contentClass
- value to be set.public int getAdcZero()
DataEntry
's ADC's relative zero.DataEntry
's ADC's relative zero.public void setAdcZero(int adcZero)
DataEntry
's ADC's relative zero.adcZero
- value to be set.public int getNumberOfChannels()
DataEntry
consists of.DataEntry
's number of channels.public void setNumberOfChannels(int numberOfChannels)
DataEntry
's number of channels.numberOfChannels
- value to be set.public java.lang.String getUnit()
DataEntry
's unit in which data is sent.DataEntry
's unit in which data is sent.public void setUnit(java.lang.String unit)
DataEntry
's unit in which data is sent.unit
- value to be set.public java.lang.String[] getNamesOfChannels()
DataEntry
's channel-names.DataEntry
's channel-names.public void setNamesOfChannels(java.lang.String[] namesOfChannels)
DataEntry
's channel-names.namesOfChannels
- String[] to be set.public java.lang.String getIdentifier()
DataEntry
's identifier.DataEntry
's identifier.public void setIdentifier(java.lang.String identifier)
DataEntry
's identifier.identifier
- String to be set.public boolean matches(DataDescription filter)
DataDescription
matches the passed
DataDescription.DataType
s to DataType.ANY
will match the two DataDescription
s. DataDescription
s have to contain
the same identifier to be matched (non-case-sensitive). An empty
identifier does not count as a wildcard.filter
- DataDescription
to match