Selector< T > Class Template Reference
Allows composing read and take operations. Selectors are returned by DataReader<T>.Select More...
Inheritance diagram for Selector< T >:
Public Member Functions | |
| Selector< T > | WithState (DataState state) |
| Select a specific DataState More... | |
| Selector< T > | WithMaxSamples (int maxSamples) |
| Choose to only read/take up to a maximum number of samples More... | |
| Selector< T > | WithInstance (in InstanceHandle instanceHandle) |
| Select a specific instance More... | |
| Selector< T > | WithNextInstance (in InstanceHandle instanceHandle) |
| Select the instance after a specific instance More... | |
| Selector< T > | WithCondition (ReadCondition condition) |
| Select based on the state or content filter of a ReadCondition or a QueryCondition More... | |
| LoanedSamples< T > | Take () |
| Access (and remove) the samples selected by this selector More... | |
| LoanedSamples< T > | Read () |
| Access (without removing) the samples selected by this selector More... | |
Properties | |
| DataReader< T > | RelatedReader [get] |
| The reader that created this selector More... | |
 Properties inherited from SelectorBase | |
| DataState | State [get, set] |
| Get or set the data state More... | |
| int | MaxSamples [get, set] |
| Get or set the maximum samples More... | |
| InstanceHandle? | Instance [get, set] |
| Get or set the instance handle More... | |
| InstanceHandle? | NextInstance [get, set] |
| Get or set the next instance More... | |
| ReadCondition | Condition [get, set] |
| Get or set the condition More... | |
Detailed Description
Allows composing read and take operations. Selectors are returned by DataReader<T>.Select
- Template Parameters
-
T The topic-type of the associated reader
Member Function Documentation
◆ Read()
| LoanedSamples<T> Read | ( | ) |
Access (without removing) the samples selected by this selector
◆ Take()
| LoanedSamples<T> Take | ( | ) |
Access (and remove) the samples selected by this selector
◆ WithCondition()
| Selector<T> WithCondition | ( | ReadCondition | condition | ) |
Select based on the state or content filter of a ReadCondition or a QueryCondition
- Returns
- This Selector
◆ WithInstance()
| Selector<T> WithInstance | ( | in InstanceHandle | instanceHandle | ) |
Select a specific instance
- Returns
- This Selector
◆ WithMaxSamples()
| Selector<T> WithMaxSamples | ( | int | maxSamples | ) |
Choose to only read/take up to a maximum number of samples
- Returns
- This Selector
◆ WithNextInstance()
| Selector<T> WithNextInstance | ( | in InstanceHandle | instanceHandle | ) |
Select the instance after a specific instance
- Returns
- This Selector
◆ WithState()
Property Documentation
◆ RelatedReader
|
get |
The reader that created this selector