ADTF  3.18.2
sample_streaming_sink.h
Go to the documentation of this file.
1 
7 #pragma once
8 #include <adtfstreaming3/streaming_sink_intf.h>
9 #include <adtfstreaming3/streaming_source.h>
10 #include "graph_object.h"
11 
12 #include <memory>
13 
14 namespace adtf
15 {
16 namespace filter
17 {
18 namespace flash
19 {
20 
39 class cSampleStreamingSink:
40  public ucom::catwo::object<streaming::ant::INamedGraphObject,
41  streaming::ant::IDataBinding,
42  streaming::ant::IInterfaceBinding,
43  streaming::ant::IRuntimeBehaviour,
44  streaming::ant::IDynamicDataBinding,
45  streaming::ant::IDynamicInterfaceBinding,
46  streaming::ant::IStreamingService,
47  streaming::ant::IStreamingSink,
48  streaming::ant::ISampleStreamingSink,
49  base::ant::IConfiguration>,
50  public cGraphObject,
51  protected streaming::ant::streaming_level_machine
52 {
53  public:
54  // this needs to be here because unfortunately multiple base classes have this as well (altough it is not needed at all)
55  template <typename T>
56  using iobject_ptr = adtf::ucom::ant::iobject_ptr<T>;
57 
58  cSampleStreamingSink();
59  ~cSampleStreamingSink() override;
60 
71  tResult Init() override;
72 
81  tResult StartStreaming() override;
82 
91  tResult StopStreaming() override;
92 
93  tResult SetName(const char* strName) override;
94  tResult GetName(base::ant::IString&& strName) const override;
95  tResult SetParent(const ucom::ant::IObject* poParentObject) override;
96  tResult GetParent(const ucom::ant::IObject*& poParentObject) const override;
97 
98  tResult GetPins(ucom::ant::iobject_list<streaming::ant::IPin>& oPins) const override;
99  tResult FindPin(const char* strName, ucom::ant::iobject_ptr<ucom::ant::IObject>& pPin) const override;
100 
101  tResult GetBindingObjects(ucom::ant::iobject_list<streaming::ant::IBindingObject>& lstBindingObject) override;
102  tResult GetBindingObjects(ucom::ant::iobject_list<const streaming::ant::IBindingObject>& lstBindingObject) const override;
103  tResult FindBindingObject(const char* strName,
104  ucom::ant::iobject_ptr<const ucom::ant::IObject>& pIBindingObject) const override;
105  tResult FindBindingObject(const char* strName,
106  ucom::ant::iobject_ptr<ucom::ant::IObject>& pIBindingObject) override;
107 
108  tResult GetRunners(ucom::ant::iobject_list<streaming::ant::IRunner>& lstRunners) const override;
109  tResult FindRunner(const char* strName, ucom::ant::iobject_ptr<ucom::ant::IObject>& pRunner) const override;
110  tResult GetInnerPipes(ucom::ant::iobject_list<streaming::ant::ITriggerPipe>& lstInnerTriggerPipes) const override;
111 
112  tResult RequestPin(const char* strName,
113  const ucom::ant::iobject_ptr<const streaming::ant::IStreamType>& pType,
114  ucom::ant::iobject_ptr<streaming::ant::IInPin>& pInPin) override;
115  tResult RequestPin(const char* strName,
116  const ucom::ant::iobject_ptr<const streaming::ant::IStreamType>& pType,
117  ucom::ant::iobject_ptr<streaming::ant::IOutPin>& pOutPin) override;
118 
119  tResult RequestBindingObject(const char* strName,
120  const ucom::ant::iobject_ptr<const streaming::ant::IBindingType>& pType,
121  ucom::ant::iobject_ptr<streaming::ant::IBindingClient>& pBindingClient) override;
122  tResult RequestBindingObject(const char* strName,
123  const ucom::ant::iobject_ptr<const streaming::ant::IBindingType>& pType,
124  ucom::ant::iobject_ptr<streaming::ant::IBindingServer>& pBindingServer) override;
125 
126  tResult SetState(tStreamingState eFilterState) override;
127  tStreamingState GetState() override;
128 
129  tResult GetProperties(ucom::ant::iobject_ptr<const base::ant::IProperties>& pProperties) const override;
130  tResult GetProperties(ucom::ant::iobject_ptr<base::ant::IProperties>& pProperties) override;
131  tResult AttachConfiguration(const char* strName, base::ant::IConfiguration& oAttachedConfiguration) override;
132  tResult DetachConfiguration(const char* strName) override;
133 
134  private:
135  class cImplementation;
136  std::unique_ptr<cImplementation> m_pImplementation;
137 };
138 
139 }
140 
141 namespace hollow
142 {
143 
145 class cSampleStreamingSink:
146  public ucom::catwo::object<streaming::ant::INamedGraphObject,
147  streaming::ant::IDataBinding,
148  streaming::ant::IInterfaceBinding,
149  streaming::ant::IRuntimeBehaviour,
150  streaming::ant::IDynamicDataBinding,
151  streaming::ant::IDynamicInterfaceBinding,
152  streaming::ant::IStreamingService,
153  streaming::ant::IStreamingSink,
154  streaming::ant::ISampleStreamingSink,
155  base::ant::IConfiguration>,
156  public cGraphObject,
157  protected streaming::ant::streaming_level_machine
158 {
159  public:
160  // this needs to be here because unfortunately multiple base classes have this as well (altough it is not needed at all)
161  template <typename T>
162  using iobject_ptr = adtf::ucom::ant::iobject_ptr<T>;
163 
164  cSampleStreamingSink();
165  ~cSampleStreamingSink() override;
166 
168  tResult Init() override;
169 
171  tResult StartStreaming() override;
172 
174  tResult StopStreaming() override;
175 
176  tResult SetName(const char* strName) override;
177  tResult GetName(base::ant::IString&& strName) const override;
178  tResult SetParent(const ucom::ant::IObject* poParentObject) override;
179  tResult GetParent(const ucom::ant::IObject*& poParentObject) const override;
180 
181  tResult GetPins(ucom::ant::iobject_list<streaming::ant::IPin>& oPins) const override;
182  tResult FindPin(const char* strName, ucom::ant::iobject_ptr<ucom::ant::IObject>& pPin) const override;
183 
184  tResult GetBindingObjects(ucom::ant::iobject_list<streaming::ant::IBindingObject>& lstBindingObject) override;
185  tResult GetBindingObjects(ucom::ant::iobject_list<const streaming::ant::IBindingObject>& lstBindingObject) const override;
186  tResult FindBindingObject(const char* strName,
187  ucom::ant::iobject_ptr<const ucom::ant::IObject>& pIBindingObject) const override;
188  tResult FindBindingObject(const char* strName,
189  ucom::ant::iobject_ptr<ucom::ant::IObject>& pIBindingObject) override;
190 
191  tResult GetRunners(ucom::ant::iobject_list<streaming::ant::IRunner>& lstRunners) const override;
192  tResult FindRunner(const char* strName, ucom::ant::iobject_ptr<ucom::ant::IObject>& pRunner) const override;
193  tResult GetInnerPipes(ucom::ant::iobject_list<streaming::ant::ITriggerPipe>& lstInnerTriggerPipes) const override;
194 
195  tResult RequestPin(const char* strName,
196  const ucom::ant::iobject_ptr<const streaming::ant::IStreamType>& pType,
197  ucom::ant::iobject_ptr<streaming::ant::IInPin>& pInPin) override;
198  tResult RequestPin(const char* strName,
199  const ucom::ant::iobject_ptr<const streaming::ant::IStreamType>& pType,
200  ucom::ant::iobject_ptr<streaming::ant::IOutPin>& pOutPin) override;
201 
202  tResult RequestBindingObject(const char* strName,
203  const ucom::ant::iobject_ptr<const streaming::ant::IBindingType>& pType,
204  ucom::ant::iobject_ptr<streaming::ant::IBindingClient>& pBindingClient) override;
205  tResult RequestBindingObject(const char* strName,
206  const ucom::ant::iobject_ptr<const streaming::ant::IBindingType>& pType,
207  ucom::ant::iobject_ptr<streaming::ant::IBindingServer>& pBindingServer) override;
208 
209  tResult SetState(tStreamingState eFilterState) override;
210  tStreamingState GetState() override;
211 
212  tResult GetProperties(ucom::ant::iobject_ptr<const base::ant::IProperties>& pProperties) const override;
213  tResult GetProperties(ucom::ant::iobject_ptr<base::ant::IProperties>& pProperties) override;
214  tResult AttachConfiguration(const char* strName, base::ant::IConfiguration& oAttachedConfiguration) override;
215  tResult DetachConfiguration(const char* strName) override;
216 
217  private:
218  class cImplementation;
219  std::unique_ptr<cImplementation> m_pImplementation;
220 };
221 
222 }
223 
224 using hollow::cSampleStreamingSink;
225 
226 }
227 }
228 
A_UTILS_NS::cResult
A common result class usable as return value throughout.
Definition: builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/core/result.h:18
adtf::base::ant::IConfiguration
ucom Interface to a objects configuration.
Definition: configuration_intf.h:23
adtf::base::ant::IString
The IString interface provides methods for getting and setting strings through abstract interfaces.
Definition: string_intf.h:28
adtf::filter::flash::cGraphObject
Base class for adtf::filter::flash::cFilter, adtf::filter::flash::cSampleStreamingSource and adtf::fi...
Definition: graph_object.h:184
adtf::filter::flash::cSampleStreamingSink
Base class for ADTF sample streaming sinks.
Definition: sample_streaming_sink.h:52
adtf::filter::flash::cSampleStreamingSink::StopStreaming
tResult StopStreaming() override
Stop your threads and timers in this method.
adtf::filter::flash::cSampleStreamingSink::StartStreaming
tResult StartStreaming() override
Start your threads and timers in this method.
adtf::filter::flash::cSampleStreamingSink::Init
tResult Init() override
Initializes the sink.
adtf::filter::hollow::cGraphObject
Base class for adtf::filter::flash::cFilter, adtf::filter::flash::cSampleStreamingSource and adtf::fi...
Definition: graph_object.h:1173
adtf::filter::hollow::cSampleStreamingSink
Base class for ADTF sample streaming sinks.
Definition: sample_streaming_sink.h:158
adtf::filter::hollow::cSampleStreamingSink::StopStreaming
tResult StopStreaming() override
Stop your threads and timers in this method.
adtf::filter::hollow::cSampleStreamingSink::StartStreaming
tResult StartStreaming() override
Start your threads and timers in this method.
adtf::filter::hollow::cSampleStreamingSink::Init
tResult Init() override
Initializes the sink.
adtf::streaming::ant::streaming_level_machine
The Streaming Service Level Machine implementation.
Definition: streaming_source.h:31
adtf::ucom::ant::IObject
Base class for every interface type within the uCOM.
Definition: object_intf.h:31
adtf::ucom::ant::iobject_enum< T >
adtf::ucom::ant::iobject_ptr
Base object pointer to realize binary compatible reference counting in interface methods.
Definition: object_ptr_intf.h:74
adtf::ucom::catwo::object
Use this template if you want to implement an ucom::ant::IObject based Interface and/or subclass an e...
Definition: object.h:379
graph_object.h
Copyright © Audi Electronics Venture GmbH.
adtf
Namespace for entire ADTF SDK.
Definition: ddl_specification_legacy.dox:2
streaming_sink_intf.h
Copyright © Audi Electronics Venture GmbH.
streaming_source.h
Copyright © Audi Electronics Venture GmbH.