ADTF
Loading...
Searching...
No Matches
Public Member Functions | List of all members
adtf::streaming::cSampleStreamOutPort Class Reference

#include <samplestreamoutport.h>

Inherits adtf::streaming::sample_stream< IStreamingPort, IStreamingOutPort, ISampleStreamOutPort >.

Public Member Functions

 ADTF_CLASS_ID_NAME (cSampleStreamOutPort, "default_sample_stream_out_port.streaming.adtf.cid", "Sample Stream Outport")
 Implements adtf::ucom::IClassInfo.
 
 cSampleStreamOutPort (const char *strName, const char *strPortId)
 
tResult GetPortID (base::ant::IString &&strID) override
 
- Public Member Functions inherited from adtf::streaming::sample_stream< IStreamingPort, IStreamingOutPort, ISampleStreamOutPort >
 sample_stream ()
 Creates a sample stream without a name.
 
 sample_stream (const char *strName)
 
tResult GetType (ucom::ant::iobject_ptr< const IStreamType > &pStreamType) const noexcept override
 
tTimeStamp GetTime () const noexcept override
 
tResult SetStreamError (const tResult &oError) noexcept override
 
tResult AttachRouting (const ucom::ant::iobject_ptr< ISampleStream > &pSampleStreamTo) noexcept override
 
tResult DetachRouting (const ucom::ant::iobject_ptr< ISampleStream > &pSampleStreamTo) noexcept override
 
tResult Open (const char *strName, ucom::ant::iobject_ptr< ISampleInStream > &pInStream, const ucom::ant::iobject_ptr< const IStreamType > &pInitialAcceptedStreamType, ISampleStream::IPushReadEventSink *&pPushEventSink, ISampleStreamAccess::tMode ui32Mode, size_t szQueueSize) noexcept override
 
tResult Open (const char *strName, ucom::ant::iobject_ptr< ISampleOutStream > &pOutStream, ISampleStreamAccess::tMode ui32Mode, size_t szQueueSize) noexcept override
 
tResult RegisterSubItem (const ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, ITriggerPipeItem::tPriority ui32Prio) noexcept override
 
tResult UnregisterSubItem (const ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun) noexcept override
 
tResult ChangePriority (const ucom::ant::iobject_ptr< ITriggerPipeItem > &, ITriggerPipeItem::tPriority) noexcept override
 
tResult GetInternalBindingProxy (ucom::ant::iobject_ptr< IBindingProxy > &pBindingProxy) noexcept override
 
void BlockSampleStreaming (bool bBlock) noexcept override
 
bool IsSampleStreamingBlocked () const noexcept override
 
wolverine::ISampleStreamStatistics::tSampleStreamStatistic GetStatistics () noexcept override
 
void EnableSampleSizeStatistics (bool bEnable) noexcept override
 
void ResetStatistics () noexcept override
 
- Public Member Functions inherited from adtf::streaming::ant::ISampleStream
 ADTF_IID (ISampleStream, "samplestream.ant.streaming.adtf.iid")
 definition of interface identifier
 
virtual tResult Open (const char *strName, adtf::ucom::ant::iobject_ptr< ISampleInStream > &pInStream, const adtf::ucom::ant::iobject_ptr< const IStreamType > &pInitialAcceptedStreamType, IPushReadEventSink *&pPushEventSink, ISampleStreamAccess::tMode ui32Mode, size_t szQueueSize)=0
 
virtual tResult Open (const char *strName, adtf::ucom::ant::iobject_ptr< ISampleOutStream > &pOutStream, ISampleStreamAccess::tMode ui32Mode, size_t szQueueSize)=0
 
- Public Member Functions inherited from adtf::streaming::ant::ITriggerPipeItem
 ADTF_IID (ITriggerPipeItem, "trigger_pipe_item.ant.streaming.adtf.iid")
 Definition of interface ID.
 
- Public Member Functions inherited from adtf::base::ant::IRunnable
 ADTF_IID (IRunnable, "runnable.ant.base.adtf.iid")
 defintion of interface id
 
 ADTF3_DEPRECATED ("Use adtf::base::flash::IRunnable::Run(tNanoSeconds tmTimeofActivation, ant::IRunnable::tActivationType " "ui32ActivationType, const void* pvUserData, size_t nUserDataSize) instead.") virtual tResult Run(tTimeStamp tmTimeofActivation
 
virtual tActivationType GetActivationType () const
 
- Public Member Functions inherited from adtf::streaming::ant::ITriggerPipeSource
 ADTF_IID (ITriggerPipeSource, "trigger_pipe_source.ant.streaming.adtf.iid")
 definiton of interface id
 
virtual tResult GetSubItems (adtf::ucom::ant::iobject_enum< const ITriggerPipeItem > &lstSubItems) const =0
 
- Public Member Functions inherited from adtf::ucom::ant::IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 
- Public Member Functions inherited from adtf::streaming::ant::INamedGraphObject
 ADTF_IID (INamedGraphObject, "namedgraphobject.ant.streaming.adtf.iid")
 defintion of interface id
 
virtual tResult GetName (base::ant::IString &&strName) const =0
 
virtual tResult SetName (const char *strName)=0
 
virtual tResult SetParent (const ucom::ant::IObject *oParentObject)=0
 
virtual tResult GetParent (const ucom::ant::IObject *&poParentObject) const =0
 
- Public Member Functions inherited from adtf::streaming::hollow::IInternalBindingProxy
 ADTF_IID (IInternalBindingProxy, "internal_binding_proxy.hollow.streaming.adtf.iid")
 definition of interface id
 
- Public Member Functions inherited from adtf::streaming::vision::IBlockableSampleStream
 ADTF_IID (IBlockableSampleStream, "blockable_samplestream.vision.streaming.adtf.iid")
 definition of interface identifier
 
- Public Member Functions inherited from adtf::streaming::wolverine::ISampleStreamStatistics
 ADTF_IID (ISampleStreamStatistics, "samplestream_statistics.wolverine.streaming.adtf.iid")
 definition of interface identifier
 
- Public Member Functions inherited from adtf::ucom::catwo::object< Bases >
tResult GetInterface (const char *i_strIID, void *&o_pInterface) override
 Query interfaces on an object.
 
tResult GetInterface (const char *i_strIID, const void *&o_pInterface) const override
 Provides const correct interface querying.
 
void Destroy () const override
 Switch from non-virtual destructor to virtual destructor.
 
- Public Member Functions inherited from adtf::streaming::detail::cSampleStreamBase
 cSampleStreamBase (cTriggerPipeItemBase &oPipeItem, ISampleStream &oSelf) noexcept
 
 cSampleStreamBase (const cSampleStreamBase &)=delete
 
cSampleStreamBase & operator= (const cSampleStreamBase &)=delete
 
tResult GetType (ucom::ant::iobject_ptr< const IStreamType > &pStreamType) const noexcept
 
tResult SetStreamError (const tResult &oError) noexcept
 
tResult AttachRouting (const ucom::ant::iobject_ptr< ISampleStream > &pSampleStreamTo) noexcept
 
tResult DetachRouting (const ucom::ant::iobject_ptr< ISampleStream > &pSampleStreamTo) noexcept
 
tResult Open (ucom::ant::iobject_ptr< ISampleInStream > &pInStream, ISampleStream::IPushReadEventSink *&pPushEventSink, ISampleStreamAccess::tMode ui32Mode, size_t szQueueSize) noexcept
 
tResult Open (ucom::ant::iobject_ptr< ISampleOutStream > &pOutStream, ISampleStreamAccess::tMode ui32Mode, size_t szQueueSize) noexcept
 
tResult RegisterSubItem (const ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, ITriggerPipeItem::tPriority ui32Prio) noexcept
 
tResult UnregisterSubItem (const ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun) noexcept
 
tResult GetInternalBindingProxy (ucom::ant::iobject_ptr< IBindingProxy > &pBindingProxy) noexcept
 
void BlockSampleStreaming (bool bBlock) noexcept
 
bool IsSampleStreamingBlocked () const noexcept
 
wolverine::ISampleStreamStatistics::tSampleStreamStatistic GetStatistics () noexcept
 
void EnableSampleSizeStatistics (bool bEnable) noexcept
 
void ResetStatistics () noexcept
 
void SetForwardAllTriggers (bool bForwardAll) noexcept
 
void SetSubStreamFilter (const char *strSubStream) noexcept
 
- Public Member Functions inherited from adtf::ucom::ant::enable_object_ptr_from_this< ISampleStream >
object_ptr< ISampleStream > object_ptr_from_this ()
 Retrieve an object_ptr with *this being the shared resource.
 
object_ptr< const ISampleStream > object_ptr_from_this () const
 Retrieve an object_ptr with *this being the shared resource - const correct.
 

Additional Inherited Members

- Public Types inherited from adtf::base::ant::IRunnable
enum  tActivationType : uint32_t {
  RUN_UNSPECIFIED = 0 , RUN_TIMER = 1 , RUN_SIGNAL = 2 , RUN_EXCEPTION = 3 ,
  RUN_MESSAGE = 5 , RUN_THREAD = 6 , RUN_JOB = 7 , RUN_TRIGGER = 8 ,
  RUN_PUSH = 9 , RUN_USER = 0x1000
}
 
typedef std::function< tResult(tTimeStamp)> tRunFunction
 Type definition of the function used to implement Run.
 
- Public Types inherited from adtf::streaming::ant::ITriggerPipeSource
enum  tPriority : uint32_t {
  Invalid = 0 , Lowest = 1 , Lower = 30 , BelowNormal = 40 ,
  Normal = 50 , AboveNormal = 60 , Higher = 70 , Highest = 100
}
 
- Public Types inherited from adtf::streaming::wolverine::ISampleStreamStatistics
using tSampleStreamStatistic = adtf::services::wolverine::ISampleStreamTracer::tTraceData
 structure containing the current samplestream statistics for samplestream input and output
 
- Public Attributes inherited from adtf::base::ant::IRunnable
tActivationType ui32ActivationType
 
tActivationType const void * pvUserData
 
tActivationType const void size_t nUserDataSize = 0
 
- Protected Member Functions inherited from adtf::streaming::ant::ISampleStream
 ~ISampleStream ()=default
 not destructable
 
- Protected Member Functions inherited from adtf::streaming::ant::ITriggerPipeItem
 ~ITriggerPipeItem ()=default
 not destructable
 
- Protected Member Functions inherited from adtf::base::ant::IRunnable
 ~IRunnable ()=default
 not destructable
 
- Protected Member Functions inherited from adtf::streaming::ant::ITriggerPipeSource
 ~ITriggerPipeSource ()=default
 not destructable
 
- Protected Member Functions inherited from adtf::ucom::ant::IObject
 ~IObject ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 
- Protected Member Functions inherited from adtf::streaming::ant::INamedGraphObject
 ~INamedGraphObject ()=default
 not destructable
 
- Protected Member Functions inherited from adtf::streaming::hollow::IInternalBindingProxy
 ~IInternalBindingProxy ()=default
 not destructable
 
- Protected Member Functions inherited from adtf::streaming::vision::IBlockableSampleStream
virtual ~IBlockableSampleStream ()=default
 
- Protected Member Functions inherited from adtf::streaming::wolverine::ISampleStreamStatistics
 ~ISampleStreamStatistics ()=default
 not destructable
 
- Protected Member Functions inherited from adtf::ucom::ant::enable_object_ptr_from_this< ISampleStream >
 enable_object_ptr_from_this ()=default
 Default constructor.
 
 enable_object_ptr_from_this (const enable_object_ptr_from_this &)=default
 Default copy construction.
 
 ~enable_object_ptr_from_this ()=default
 Default destructor.
 
enable_object_ptr_from_this & operator= (const enable_object_ptr_from_this &)=default
 Default copy assignment.
 

Detailed Description

The Default implementation of the ant::ISampleStreamOutPort interface. It is a sample stream, so it folds together with the sample streams it is connected to.

Constructor & Destructor Documentation

◆ cSampleStreamOutPort()

adtf::streaming::cSampleStreamOutPort::cSampleStreamOutPort ( const char * strName,
const char * strPortId )
inline
Parameters
[in]strNameName of the port within the graph.
[in]strPortIdId of the port to connect to.

Member Function Documentation

◆ GetPortID()

tResult adtf::streaming::cSampleStreamOutPort::GetPortID ( base::ant::IString && strID)
inlineoverride

Retrieves the ID / Name of the Streaming Port within the streaming graph which named stream is expected here. For Sample Streaming Data a Port is defined by a sample stream

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