new RecordSet(raw, stream)
Contains a record of a stream
Parameters:
| Name | Type | Description |
|---|---|---|
raw |
Object | raw data object |
stream |
Stream | stream reference |
- Source:
Extends
Members
getObject
- Overrides:
- Source:
stream
Get a stream reference
- Source:
stream
Get a stream reference
- Source:
Methods
exportProperties()
Exposes setter and getter for a class from the `data` field
- Overrides:
- Source:
fromJSON()
- Source:
fromJSON()
- Source:
getChannel(value)
Get channel value
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Mixed | channel value |
- Source:
getChannel(value)
Get channel value
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Mixed | channel value |
- Source:
getChannelList(channels)
Get the list of known channels
Parameters:
| Name | Type | Description |
|---|---|---|
channels |
Array | labels of channels |
- Source:
getChannelList(channels)
Get the list of known channels
Parameters:
| Name | Type | Description |
|---|---|---|
channels |
Array | labels of channels |
- Source:
getClient() → {Client}
Return the client reference
- Overrides:
- Source:
Returns:
client
- Type
- Client
getContainer() → {Raptor}
Return the Raptor instance wrapper
- Overrides:
- Source:
Returns:
container Raptor instance reference
- Type
- Raptor
getTimestamp(timestamp)
Get the timestamp reference of this record
Parameters:
| Name | Type | Description |
|---|---|---|
timestamp |
Date | the Date reference related to this record |
- Source:
getTimestamp(timestamp)
Get the timestamp reference of this record
Parameters:
| Name | Type | Description |
|---|---|---|
timestamp |
Date | the Date reference related to this record |
- Source:
parseJSON(raw)
Parse a plain object and populate the corresponding fields in the current instance
Parameters:
| Name | Type | Description |
|---|---|---|
raw |
Object | the json object |
- Overrides:
- Source:
setChannels(channels)
Set channels and values
Parameters:
| Name | Type | Description |
|---|---|---|
channels |
Mixed | key/value map of channels & values |
- Source:
setChannels(channels)
Set channels and values
Parameters:
| Name | Type | Description |
|---|---|---|
channels |
Mixed | key/value map of channels & values |
- Source:
setContainer(container)
Parameters:
| Name | Type | Description |
|---|---|---|
container |
Raptor | reference to Raptor instance wrapper |
- Overrides:
- Source:
setServiceObject(object)
Set a reference to the parent object
Parameters:
| Name | Type | Description |
|---|---|---|
object |
ServiceObject | reference to the parent object |
- Overrides:
- Source:
setStream(stream)
Set a stream reference
Parameters:
| Name | Type | Description |
|---|---|---|
stream |
Stream | a stream object reference |
- Source:
setStream(stream)
Set a stream reference
Parameters:
| Name | Type | Description |
|---|---|---|
stream |
Stream | a stream object reference |
- Source:
setTimestamp(timestamp)
Set the timestamp reference of this record
Parameters:
| Name | Type | Description |
|---|---|---|
timestamp |
Mixed | a parsable time reference. Can be a timestamp of millis/seconds or Date |
- Source:
setTimestamp(timestamp)
Set the timestamp reference of this record
Parameters:
| Name | Type | Description |
|---|---|---|
timestamp |
Mixed | a parsable time reference. Can be a timestamp of millis/seconds or Date |
- Source:
toJSON() → {Object}
Convert the instance to a js object
- Overrides:
- Source:
Returns:
Plain js object
- Type
- Object
toString() → {String}
Return a JSON string of this object
- Overrides:
- Source:
Returns:
json stringified JSON
- Type
- String
validate() → {void}
Validate the object and throw an exception if fails
- Overrides:
- Source:
Returns:
- Type
- void