openDAQ
Open data acquisition platform
MultiReaderBuilderPtr Class Reference

Builder component of Multi reader objects. Contains setter methods to configure the Multi reader parameters and a build method that builds the Unit object. More...

Inherits ObjectPtr< IMultiReaderBuilder >.

Detailed Description

Builder component of Multi reader objects. Contains setter methods to configure the Multi reader parameters and a build method that builds the Unit object.

Public Member Functions

daq::MultiReaderPtr build () const
 Builds and returns a Multi reader object using the currently set values of the Builder. More...
 
MultiReaderBuilderPtr addSignal (const daq::SignalPtr &signal) const
 Adds a signal that will be read by the multi reader. More...
 
MultiReaderBuilderPtr addSignals (const daq::ListPtr< daq::ISignal > &signals) const
 Adds signals that will be read by the multi reader. More...
 
MultiReaderBuilderPtr addInputPort (const daq::InputPortPtr &port) const
 Adds a port that will be read from by the multi reader. More...
 
MultiReaderBuilderPtr addInputPorts (const daq::ListPtr< daq::IInputPort > &ports) const
 Adds ports that will be read from by the multi reader. More...
 
daq::ListPtr< daq::IComponent > getSourceComponents () const
 Gets the list of read components (signals or ports) More...
 
MultiReaderBuilderPtr setValueReadType (daq::SampleType type) const
 Sets the value signal read type. More...
 
daq::SampleType getValueReadType () const
 Gets the value signal read type. More...
 
MultiReaderBuilderPtr setDomainReadType (daq::SampleType type) const
 Sets the domain signal read type. More...
 
daq::SampleType getDomainReadType () const
 Gets the domain signal read type. More...
 
MultiReaderBuilderPtr setReadMode (daq::ReadMode mode) const
 Sets the read mode (Unscaled, Scaled, RawValue) More...
 
daq::ReadMode getReadMode () const
 Gets the read mode (Unscaled, Scaled, RawValue) More...
 
MultiReaderBuilderPtr setReadTimeoutType (daq::ReadTimeoutType type) const
 Sets the read timeout mode. More...
 
daq::ReadTimeoutType getReadTimeoutType () const
 Gets the read timeout mode. More...
 
MultiReaderBuilderPtr setRequiredCommonSampleRate (daq::Int sampleRate) const
 Sets the required common sample rate. More...
 
daq::Int getRequiredCommonSampleRate () const
 Gets the required common sample rate. More...
 
MultiReaderBuilderPtr setStartOnFullUnitOfDomain (daq::Bool enabled) const
 Sets the start on full unit of domain. More...
 
daq::Bool getStartOnFullUnitOfDomain () const
 Gets the start on full unit of domain. More...
 
MultiReaderBuilderPtr setMinReadCount (daq::SizeT minReadCount) const
 Sets the minimal number of samples to read. More...
 
daq::SizeT getMinReadCount () const
 Gets the minimal number of samples to read. More...
 
MultiReaderBuilderPtr setTickOffsetTolerance (const daq::RatioPtr &offsetTolerance) const
 Set maximum distance between signals in fractions of domain unit. More...
 
daq::RatioPtr getTickOffsetTolerance () const
 Get maximum distance between signals in fractions of domain unit. More...
 
MultiReaderBuilderPtr setAllowDifferentSamplingRates (daq::Bool allowDifferentRates) const
 Sets the "AllowDifferentSamplingRates" multi reader parameter. More...
 
daq::Bool getAllowDifferentSamplingRates () const
 Gets the "AllowDifferentSamplingRates" multi reader parameter. More...
 
MultiReaderBuilderPtr setInputPortNotificationMethod (daq::PacketReadyNotification notificationMethod) const
 Sets the notification method of ports created/owned by the multi reader. The default notification method is Unspecified. More...
 
daq::PacketReadyNotification getInputPortNotificationMethod () const
 Gets the notification method of ports created/owned by the multi reader. The default notification method is SameThread. More...
 
MultiReaderBuilderPtr setInputPortNotificationMethods (const daq::ListPtr< daq::PacketReadyNotification > &notificationMethods) const
 Sets the notification methods of ports created/owned by the multi reader. The default notification method is Unspecified. More...
 
daq::ListPtr< daq::PacketReadyNotification > getInputPortNotificationMethods () const
 Gets the notification methods of ports created/owned by the multi reader. The default notification method is Unspecified. More...