DataChannelCollection |

A collection of data channels.

Hierarchy

Collection<DataChannel, DataChannelCollection>
- DataChannelCollection

Index

Constructors

constructor

Constructors

constructor

new DataChannelCollection(): DataChannelCollection

Overrides Collection.constructor
- Defined in fm.icelink/DataChannelCollection.ts:12
Returns DataChannelCollection

Methods

add

add(value: DataChannel): boolean

Inherited from Collection.add
- Defined in fm.icelink/Collection.ts:43
Adds a value.

Parameters
- value: DataChannel
  
  The value.
Returns boolean

addMany

addMany(values: DataChannel[]): boolean

Inherited from Collection.addMany
- Defined in fm.icelink/Collection.ts:66
Adds some values.

Parameters
- values: DataChannel[]
  
  The values.
Returns boolean

Protected addSuccess

addSuccess(value: DataChannel): void

Inherited from Collection.addSuccess
- Defined in fm.icelink/Collection.ts:89
Invoked when an element is added to the collection.

Parameters
- value: DataChannel
  
  The value.
Returns void

any

any(predicate: IFunction1<DataChannel, boolean>): boolean
any(): boolean

Inherited from Collection.any
- Defined in fm.icelink/Collection.ts:105
Determined whether the collection contains at least one value that matches the specified predicate.

Parameters
- predicate: IFunction1<DataChannel, boolean>
  
  The predicate.
Returns boolean
Inherited from Collection.any
- Defined in fm.icelink/Collection.ts:115
Determined whether the collection contains at least one value.

Returns boolean

Protected arrayFromList

arrayFromList(list: Array<DataChannel>): DataChannel[]

Overrides Collection.arrayFromList
- Defined in fm.icelink/DataChannelCollection.ts:33
Creates an array from a list.

Parameters
- list: Array<DataChannel>
  
  The list.
Returns DataChannel[]

contains

contains(value: DataChannel): boolean

Inherited from Collection.contains
- Defined in fm.icelink/Collection.ts:150
Determines whether the collection contains a value.

Parameters
- value: DataChannel
  
  The value.
Returns boolean

Protected createCollection

createCollection(): DataChannelCollection

Overrides Collection.createCollection
- Defined in fm.icelink/DataChannelCollection.ts:49
Creates a collection.

Returns DataChannelCollection

first

first(predicate: IFunction1<DataChannel, boolean>): DataChannel
first(): DataChannel

Inherited from Collection.first
- Defined in fm.icelink/Collection.ts:182
Gets the first value that matches the specified predicate. Throws an exception if there are no such values in the collection.

Parameters
- predicate: IFunction1<DataChannel, boolean>
  
  The predicate.
Returns DataChannel
Inherited from Collection.first
- Defined in fm.icelink/Collection.ts:194
Gets the first value. Throws an exception if there are no values in the collection.

Returns DataChannel

firstOrDefault

firstOrDefault(): DataChannel
firstOrDefault(predicate: IFunction1<DataChannel, boolean>): DataChannel

Inherited from Collection.firstOrDefault
- Defined in fm.icelink/Collection.ts:224
Gets the first value. Returns a default value if there are no values in the collection.

Returns DataChannel
Inherited from Collection.firstOrDefault
- Defined in fm.icelink/Collection.ts:237
Gets the first value that matches the specified predicate. Returns a default value if there are no such values in the collection.

Parameters
- predicate: IFunction1<DataChannel, boolean>
  
  The predicate.
Returns DataChannel

forEach

forEach(callback: IAction2<DataChannel, number>): void

Inherited from Collection.forEach
- Defined in fm.icelink/Collection.ts:263
Executes a callback function once per value.

Parameters
- callback: IAction2<DataChannel, number>
  
  The callback to execute.
Returns void

getCount

getCount(): number

Inherited from Collection.getCount
- Defined in fm.icelink/Collection.ts:282
Gets the count.

Returns number

getTypeString

getTypeString(): string

Overrides Collection.getTypeString
- Defined in fm.icelink/DataChannelCollection.ts:10
Returns string

getValue

getValue(): DataChannel

Inherited from Collection.getValue
- Defined in fm.icelink/Collection.ts:298
Gets the value.

Returns DataChannel

getValues

getValues(): DataChannel[]

Inherited from Collection.getValues
- Defined in fm.icelink/Collection.ts:317
Gets the values.

Returns DataChannel[]

last

last(predicate: IFunction1<DataChannel, boolean>): DataChannel
last(): DataChannel

Inherited from Collection.last
- Defined in fm.icelink/Collection.ts:336
Gets the last value that matches the specified predicate. Throws an exception if there are no such values in the collection.

Parameters
- predicate: IFunction1<DataChannel, boolean>
  
  The predicate.
Returns DataChannel
Inherited from Collection.last
- Defined in fm.icelink/Collection.ts:348
Gets the last value. Throws an exception if there are no values in the collection.

Returns DataChannel

lastOrDefault

lastOrDefault(predicate: IFunction1<DataChannel, boolean>): DataChannel
lastOrDefault(): DataChannel

Inherited from Collection.lastOrDefault
- Defined in fm.icelink/Collection.ts:379
Gets the last value that matches the specified predicate. Returns a default value if there are no such values in the collection.

Parameters
- predicate: IFunction1<DataChannel, boolean>
  
  The predicate.
Returns DataChannel
Inherited from Collection.lastOrDefault
- Defined in fm.icelink/Collection.ts:391
Gets the last value. Returns a default value if there are no values in the collection.

Returns DataChannel

remove

remove(value: DataChannel): boolean

Inherited from Collection.remove
- Defined in fm.icelink/Collection.ts:417
Removes a value.

Parameters
- value: DataChannel
  
  The value.
Returns boolean

removeAll

removeAll(): void

Inherited from Collection.removeAll
- Defined in fm.icelink/Collection.ts:439
Removes all values.

Returns void

removeFirst

removeFirst(condition: IFunction1<DataChannel, boolean>): DataChannel
removeFirst(): DataChannel

Inherited from Collection.removeFirst
- Defined in fm.icelink/Collection.ts:460
Removes the first value that matches a given condition.

Parameters
- condition: IFunction1<DataChannel, boolean>
Returns DataChannel
Inherited from Collection.removeFirst
- Defined in fm.icelink/Collection.ts:470
Removes the first value.

Returns DataChannel

removeLast

removeLast(): DataChannel
removeLast(condition: IFunction1<DataChannel, boolean>): DataChannel

Inherited from Collection.removeLast
- Defined in fm.icelink/Collection.ts:501
Removes the last value.

Returns DataChannel
Inherited from Collection.removeLast
- Defined in fm.icelink/Collection.ts:512
Removes the last value that matches a given condition.

Parameters
- condition: IFunction1<DataChannel, boolean>
Returns DataChannel

removeMany

removeMany(values: DataChannel[]): boolean

Inherited from Collection.removeMany
- Defined in fm.icelink/Collection.ts:543
Removes some values.

Parameters
- values: DataChannel[]
  
  The values.
Returns boolean

Protected removeSuccess

removeSuccess(value: DataChannel): void

Inherited from Collection.removeSuccess
- Defined in fm.icelink/Collection.ts:569
Invoked when an element is removed from the collection.

Parameters
- value: DataChannel
  
  The value.
Returns void

replace

replace(values: DataChannel[]): void

Inherited from Collection.replace
- Defined in fm.icelink/Collection.ts:584
Replaces the collection with a new set of values.

Parameters
- values: DataChannel[]
  
  The values.
Returns void

setValue

setValue(value: DataChannel): void

Inherited from Collection.setValue
- Defined in fm.icelink/Collection.ts:604
Sets the value.

Parameters
- value: DataChannel
Returns void

setValues

setValues(value: DataChannel[]): void

Inherited from Collection.setValues
- Defined in fm.icelink/Collection.ts:624
Sets the values.

Parameters
- value: DataChannel[]
Returns void

single

single(predicate: IFunction1<DataChannel, boolean>): DataChannel
single(): DataChannel

Inherited from Collection.single
- Defined in fm.icelink/Collection.ts:648
Gets the only value that matches the specified predicate. Throws an exception if there are no values or more than one value in the collection.

Parameters
- predicate: IFunction1<DataChannel, boolean>
Returns DataChannel
Inherited from Collection.single
- Defined in fm.icelink/Collection.ts:661
Gets the only value. Throws an exception if there are no values or more than one value in the collection.

Returns DataChannel

singleOrDefault

singleOrDefault(): DataChannel
singleOrDefault(predicate: IFunction1<DataChannel, boolean>): DataChannel

Inherited from Collection.singleOrDefault
- Defined in fm.icelink/Collection.ts:692
Gets the only value. Returns a default value if there are no values or more than one value in the collection.

Returns DataChannel
Inherited from Collection.singleOrDefault
- Defined in fm.icelink/Collection.ts:707
Gets the only value that matches the specified predicate. Returns a default value if there are no values or more than one value in the collection.

Parameters
- predicate: IFunction1<DataChannel, boolean>
Returns DataChannel

valueAt

valueAt(index: number): DataChannel

Inherited from Collection.valueAt
- Defined in fm.icelink/Collection.ts:735
Gets the value at the specified index. Throws an exception if a value does not exist at that index.

Parameters
- index: number
  
  The index.
Returns DataChannel

valueAtOrDefault

valueAtOrDefault(index: number): DataChannel

Inherited from Collection.valueAtOrDefault
- Defined in fm.icelink/Collection.ts:757
Gets the value at the specified index. Returns a default value if a value does not exist at that index.

Parameters
- index: number
  
  The index.
Returns DataChannel

where

where(predicate: IFunction2<DataChannel, number, boolean>): DataChannelCollection

Inherited from Collection.where
- Defined in fm.icelink/Collection.ts:781
Creates a new collection with values that match the specified predicate.

Parameters
- predicate: IFunction2<DataChannel, number, boolean>
  
  The predicate.
Returns DataChannelCollection

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns DataChannelCollection

Methods

add

Parameters

value: DataChannel

Returns boolean

addMany

Parameters

values: DataChannel[]

Returns boolean

Protected addSuccess

Parameters

value: DataChannel

Returns void

any

Parameters

predicate: IFunction1<DataChannel, boolean>

Returns boolean

Returns boolean

Protected arrayFromList

Parameters

list: Array<DataChannel>

Returns DataChannel[]

contains

Parameters

value: DataChannel

Returns boolean

Protected createCollection

Returns DataChannelCollection

first

Parameters

predicate: IFunction1<DataChannel, boolean>

Returns DataChannel

Returns DataChannel

firstOrDefault

Returns DataChannel

Parameters

predicate: IFunction1<DataChannel, boolean>

Returns DataChannel

forEach

Parameters

callback: IAction2<DataChannel, number>

Returns void

getCount

Returns number

getTypeString

Returns string

getValue

Returns DataChannel

getValues

Returns DataChannel[]

last

Parameters

predicate: IFunction1<DataChannel, boolean>

Returns DataChannel

Returns DataChannel

lastOrDefault

Parameters

predicate: IFunction1<DataChannel, boolean>

Returns DataChannel

Returns DataChannel

remove

Parameters

value: DataChannel

Returns boolean

removeAll

Returns void

removeFirst

Parameters

condition: IFunction1<DataChannel, boolean>

Returns DataChannel

Returns DataChannel

removeLast

Returns DataChannel