The cInputPin class implements basic functionality specified by the IInPin interface. More...
Inheritance diagram for cInPin:
Public Member Functions | |
| cInPin () | |
| private dPointer More... | |
| cInPin (const char *strName) | |
| CTOR with name. More... | |
| virtual | ~cInPin () |
| DTOR. | |
| tResult | GetType (ucom::ant::iobject_ptr< const IStreamType > &pStreamType) const override |
| bool | IsConnected () const override |
| tResult | SetActive () override |
| tResult | SetInactive () override |
| tResult | Disconnect () override |
| tResult | GetSampleStream (ucom::ant::iobject_ptr< ISampleStream > &pSampleStream) const override |
| tResult | Connect (const ucom::ant::iobject_ptr< ISampleStream > &pSampleStream) override |
| tResult | RegisterStreamer (ISampleReader &pStreamReader) |
| Registers a Streamer to the Pin. More... | |
| tResult | UnregisterStreamer (ISampleStreamer &pStreamReader) |
| Unregisters a registered Streamer from the Pin. More... | |
 Public Member Functions inherited from object< IPin, named_graph_object< trigger_pipe_item< IInPin > > > | |
| tResult | GetInterface (const char *i_strIID, void *&o_pInterface) override |
| Query interfaces on an object. More... | |
| tResult | GetInterface (const char *i_strIID, const void *&o_pInterface) const override |
| Provides const correct interface querying. More... | |
| void | Destroy () const override |
Destruct and deallocate instantiations of type IObject. More... | |
| Public Member Functions inherited from IObject | |
| ADTF_IID (IObject, "object.ant.ucom.adtf.iid") | |
Marks the IObject to be castable with the ucom_cast() More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from IObject | |
| ~IObject ()=default | |
| Protected destructor --> Use implemented Destroy() instead of delete! | |
Detailed Description
The cInputPin class implements basic functionality specified by the IInPin interface.
Constructor & Destructor Documentation
◆ cInPin() [1/2]
| cInPin | ( | ) |
private dPointer
CTOR
◆ cInPin() [2/2]
| cInPin | ( | const char * | strName | ) |
CTOR with name.
- Parameters
-
[in] strName Name of the pin
Member Function Documentation
◆ RegisterStreamer()
| tResult RegisterStreamer | ( | ISampleReader & | pStreamReader | ) |
Registers a Streamer to the Pin.
Every registered ISampleStreamer will retrieve a ISampleStreamer::BeginStreaming call, while the Pin is connected via connect call. If pin is already connected a ISampleStreamer::BeginStreaming is immediatelly made.
- Remarks
- Make sure the instance of pStreamReader will live as long as the Pin or unregister it on destroy.
- Parameters
-
[in] pStreamReader The Streamer to register.
- Returns
- Standard Result Code
◆ UnregisterStreamer()
| tResult UnregisterStreamer | ( | ISampleStreamer & | pStreamReader | ) |
Unregisters a registered Streamer from the Pin.
Every registered ISampleStreamer will retrieve a ISampleStreamer::BeginStreaming call, while the Pin is connected via Connect call. While unregistering from a connected pin a ISampleStreamer::EndStreaming call is made.
- Remarks
- Make sure the instance of pStreamReader will live as long as the Pin or unregister it on destroy.
- Parameters
-
[in] pStreamReader The Streamer to unregister.
- Returns
- Standard Result Code
- Return values
-
ERR_NOT_FOUND The Streamer is not registered.