DynExp
Highly flexible laboratory automation for dynamically changing experiments.
DynExpInstr::NetworkDataStreamInstrument Class Reference

Explicit instantiation of derivable class NetworkDataStreamInstrumentT to create the network data stream instrument. More...

+ Inheritance diagram for DynExpInstr::NetworkDataStreamInstrument:

Public Types

using StubType = DynExpProto::NetworkDataStreamInstrument::NetworkDataStreamInstrument
 
- Public Types inherited from DynExpInstr::NetworkDataStreamInstrumentT< DataStreamInstrument, 0, DynExpProto::NetworkDataStreamInstrument::NetworkDataStreamInstrument >
using ParamsType = NetworkDataStreamInstrumentParams< DataStreamInstrument, 0, gRPCStubs... >
 
using ConfigType = NetworkDataStreamInstrumentConfigurator< DataStreamInstrument, 0, gRPCStubs... >
 
using InstrumentDataType = NetworkDataStreamInstrumentData< DataStreamInstrument, 0, gRPCStubs... >
 
- Public Types inherited from DynExpInstr::gRPCInstrument< BaseInstr,, gRPCStubs >
using ParamsType = gRPCInstrumentParams< BaseInstr, 0, gRPCStubs... >
 Type of the parameter class belonging to this Object type. Declare this alias in every derived class with the respective parameter class accompanying the derived Object. More...
 
using ConfigType = gRPCInstrumentConfigurator< BaseInstr, 0, gRPCStubs... >
 Type of the configurator class belonging to this Object type. Declare this alias in every derived class with the respective configurator class accompanying the derived Object. More...
 
using InstrumentDataType = gRPCInstrumentData< BaseInstr, 0, gRPCStubs... >
 Type of the data class belonging to this InstrumentBase type. Declare this alias in every derived class with the respective data class accompanying the derived InstrumentBase. More...
 

Public Member Functions

 NetworkDataStreamInstrument (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
 
virtual ~NetworkDataStreamInstrument ()
 
virtual DataStreamInstrumentData::UnitType GetValueUnit () const override
 
- Public Member Functions inherited from DynExpInstr::NetworkDataStreamInstrumentT< DataStreamInstrument, 0, DynExpProto::NetworkDataStreamInstrument::NetworkDataStreamInstrument >
 NetworkDataStreamInstrumentT (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
 
virtual ~NetworkDataStreamInstrumentT ()
 
virtual std::string GetName () const override
 Returns the name of this Object type. More...
 
virtual std::chrono::milliseconds GetTaskQueueDelay () const
 Read remote instrument's state periodically. More...
 
virtual Util::OptionalBool HasFinished () const override
 
virtual Util::OptionalBool IsRunning () const override
 
virtual void ReadData (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const override
 
virtual void WriteData (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const override
 
virtual void ClearData (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const override
 
virtual void Start (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const override
 
virtual void Stop (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const override
 
virtual void Restart (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const override
 
virtual void SetStreamSize (size_t BufferSizeInSamples, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const override
 
virtual void ResetStreamSize (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const override
 
- Public Member Functions inherited from DynExpInstr::gRPCInstrument< BaseInstr,, gRPCStubs >
virtual ~gRPCInstrument ()
 
virtual std::string GetCategory () const override
 Returns the category of this Object type. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DynExpInstr::NetworkDataStreamInstrumentT< DataStreamInstrument, 0, DynExpProto::NetworkDataStreamInstrument::NetworkDataStreamInstrument >
constexpr static auto Name () noexcept
 
- Static Public Member Functions inherited from DynExpInstr::gRPCInstrument< BaseInstr,, gRPCStubs >
constexpr static auto Name () noexcept
 Every derived class has to redefine this function. More...
 
constexpr static auto Category () noexcept
 Every derived class has to redefine this function. More...
 
- Protected Member Functions inherited from DynExpInstr::gRPCInstrument< BaseInstr,, gRPCStubs >
 gRPCInstrument (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
 Constructs an instrument instance. More...
 

Detailed Description

Explicit instantiation of derivable class NetworkDataStreamInstrumentT to create the network data stream instrument.

Definition at line 509 of file NetworkDataStreamInstrument.h.

Member Typedef Documentation

◆ StubType

using DynExpInstr::NetworkDataStreamInstrument::StubType = DynExpProto::NetworkDataStreamInstrument::NetworkDataStreamInstrument

Definition at line 512 of file NetworkDataStreamInstrument.h.

Constructor & Destructor Documentation

◆ NetworkDataStreamInstrument()

DynExpInstr::NetworkDataStreamInstrument::NetworkDataStreamInstrument ( const std::thread::id  OwnerThreadID,
DynExp::ParamsBasePtrType &&  Params 
)
inline

Definition at line 514 of file NetworkDataStreamInstrument.h.

◆ ~NetworkDataStreamInstrument()

virtual DynExpInstr::NetworkDataStreamInstrument::~NetworkDataStreamInstrument ( )
inlinevirtual

Definition at line 516 of file NetworkDataStreamInstrument.h.

Member Function Documentation

◆ GetValueUnit()

virtual DataStreamInstrumentData::UnitType DynExpInstr::NetworkDataStreamInstrument::GetValueUnit ( ) const
inlineoverridevirtual

Definition at line 519 of file NetworkDataStreamInstrument.h.


The documentation for this class was generated from the following file: