NVIDIA DeepStream SDK API Reference

9.2 Release
DummyCommunicator Class Reference

Detailed Description

Inheritance diagram for DummyCommunicator:
Collaboration diagram for DummyCommunicator:

Public Member Functions

 DummyCommunicator ()
 Construct an uninitialized dummy communicator. More...
 
 DummyCommunicator (const std::string &configFilePath)
 Construct an uninitialized dummy communicator from configuration. More...
 
 ~DummyCommunicator ()
 Stop and destroy the dummy communicator. More...
 
bool isInitialized () override
 Check if the communicator is initialized. More...
 
void initialize (const StreamId streamId, system_clock::time_point start, std::map< StreamId, std::shared_ptr< ICommunicator >> localInstanceCommunicators, const std::string &sensorName="") override
 Initialize the communicator and start its processing loop. More...
 
MessageType available () override
 Return the type of the next buffered message, or NONE when the buffer is empty. More...
 
void requestToSend (Payload payload) override
 Request to send a message. More...
 
void requestToSend (const std::vector< Payload > &payloads) override
 Request to send a message. More...
 
void get (Payload &payload) override
 Get the message from buffer. More...
 
void processMessage (Payload payload) override
 Process an incoming message. More...
 
void broadcast (Payload payload) override
 Broadcast message. More...
 
COMMUNICATOR_TYPES getCommunicatorType () override
 Return the communicator implementation type. More...
 
 DummyCommunicator ()
 Construct an uninitialized dummy communicator. More...
 
 DummyCommunicator (const std::string &configFilePath)
 Construct an uninitialized dummy communicator from configuration. More...
 
 ~DummyCommunicator ()
 Stop and destroy the dummy communicator. More...
 
bool isInitialized () override
 Check if the communicator is initialized. More...
 
void initialize (const StreamId streamId, system_clock::time_point start, std::map< StreamId, std::shared_ptr< ICommunicator >> localInstanceCommunicators, const std::string &sensorName="") override
 Initialize the communicator and start its processing loop. More...
 
MessageType available () override
 Return the type of the next buffered message, or NONE when the buffer is empty. More...
 
void requestToSend (Payload payload) override
 Request to send a message. More...
 
void requestToSend (const std::vector< Payload > &payloads) override
 Request to send a message. More...
 
void get (Payload &payload) override
 Get the message from buffer. More...
 
void processMessage (Payload payload) override
 Process an incoming message. More...
 
void broadcast (Payload payload) override
 Broadcast message. More...
 
COMMUNICATOR_TYPES getCommunicatorType () override
 Return the communicator implementation type. More...
 
virtual std::vector< CamId > getPeerCamIds ()
 Return peer camera IDs from broker topics or camera configuration. More...
 
virtual std::vector< CamId > getPeerCamIds ()
 Return peer camera IDs from broker topics or camera configuration. More...
 
virtual CamId getEgoCamId ()
 Return the ego camera ID from the broker topic or camera configuration. More...
 
virtual CamId getEgoCamId ()
 Return the ego camera ID from the broker topic or camera configuration. More...
 

Constructor & Destructor Documentation

◆ DummyCommunicator() [1/4]

DummyCommunicator::DummyCommunicator ( )
inline

Construct an uninitialized dummy communicator.

Definition at line 28 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ DummyCommunicator() [2/4]

DummyCommunicator::DummyCommunicator ( const std::string &  configFilePath)
inline

Construct an uninitialized dummy communicator from configuration.

Parameters
[in]configFilePathPath to the configuration file.

Definition at line 34 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ ~DummyCommunicator() [1/2]

DummyCommunicator::~DummyCommunicator ( )
inline

Stop and destroy the dummy communicator.

Definition at line 37 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ DummyCommunicator() [3/4]

DummyCommunicator::DummyCommunicator ( )
inline

Construct an uninitialized dummy communicator.

Definition at line 28 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ DummyCommunicator() [4/4]

DummyCommunicator::DummyCommunicator ( const std::string &  configFilePath)
inline

Construct an uninitialized dummy communicator from configuration.

Parameters
[in]configFilePathPath to the configuration file.

Definition at line 34 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ ~DummyCommunicator() [2/2]

DummyCommunicator::~DummyCommunicator ( )
inline

Stop and destroy the dummy communicator.

Definition at line 37 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

Member Function Documentation

◆ available() [1/2]

MessageType DummyCommunicator::available ( )
inlineoverridevirtual

Return the type of the next buffered message, or NONE when the buffer is empty.

Implements ICommunicator.

Definition at line 66 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

References NONE.

◆ available() [2/2]

MessageType DummyCommunicator::available ( )
inlineoverridevirtual

Return the type of the next buffered message, or NONE when the buffer is empty.

Implements ICommunicator.

Definition at line 66 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

References NONE.

◆ broadcast() [1/2]

void DummyCommunicator::broadcast ( Payload  payload)
inlineoverridevirtual

Broadcast message.

Parameters
[in]payloadMessage to broadcast.

Implements ICommunicator.

Definition at line 105 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ broadcast() [2/2]

void DummyCommunicator::broadcast ( Payload  payload)
inlineoverridevirtual

Broadcast message.

Parameters
[in]payloadMessage to broadcast.

Implements ICommunicator.

Definition at line 105 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ get() [1/2]

void DummyCommunicator::get ( Payload &  payload)
inlineoverridevirtual

Get the message from buffer.

Parameters
[out]payloadMessage removed from the input buffer.

Implements ICommunicator.

Definition at line 93 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ get() [2/2]

void DummyCommunicator::get ( Payload &  payload)
inlineoverridevirtual

Get the message from buffer.

Parameters
[out]payloadMessage removed from the input buffer.

Implements ICommunicator.

Definition at line 93 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ getCommunicatorType() [1/2]

COMMUNICATOR_TYPES DummyCommunicator::getCommunicatorType ( )
inlineoverridevirtual

Return the communicator implementation type.

Implements ICommunicator.

Definition at line 108 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

References DUMMY_COMMUNICATOR.

◆ getCommunicatorType() [2/2]

COMMUNICATOR_TYPES DummyCommunicator::getCommunicatorType ( )
inlineoverridevirtual

Return the communicator implementation type.

Implements ICommunicator.

Definition at line 108 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

References DUMMY_COMMUNICATOR.

◆ getEgoCamId() [1/2]

virtual CamId ICommunicator::getEgoCamId ( )
inlinevirtualinherited

Return the ego camera ID from the broker topic or camera configuration.

Reimplemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, and MemoryAccessCommunicator.

Definition at line 258 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/ICommunicator.hpp.

◆ getEgoCamId() [2/2]

virtual CamId ICommunicator::getEgoCamId ( )
inlinevirtualinherited

Return the ego camera ID from the broker topic or camera configuration.

Reimplemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, and MemoryAccessCommunicator.

Definition at line 258 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/ICommunicator.hpp.

◆ getPeerCamIds() [1/2]

virtual std::vector<CamId> ICommunicator::getPeerCamIds ( )
inlinevirtualinherited

Return peer camera IDs from broker topics or camera configuration.

Reimplemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, and MemoryAccessCommunicator.

Definition at line 252 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/ICommunicator.hpp.

◆ getPeerCamIds() [2/2]

virtual std::vector<CamId> ICommunicator::getPeerCamIds ( )
inlinevirtualinherited

Return peer camera IDs from broker topics or camera configuration.

Reimplemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, and MemoryAccessCommunicator.

Definition at line 252 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/ICommunicator.hpp.

◆ initialize() [1/2]

void DummyCommunicator::initialize ( const StreamId  streamId,
system_clock::time_point  start,
std::map< StreamId, std::shared_ptr< ICommunicator >>  localInstanceCommunicators,
const std::string &  sensorName = "" 
)
inlineoverridevirtual

Initialize the communicator and start its processing loop.

Parameters
[in]streamIdStream identifier for this communicator.
[in]startReference start time for timestamp conversion.
[in]localInstanceCommunicatorsCommunicators for local streams.
[in]sensorNameSensor name used by external transports.

Implements ICommunicator.

Definition at line 52 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ initialize() [2/2]

void DummyCommunicator::initialize ( const StreamId  streamId,
system_clock::time_point  start,
std::map< StreamId, std::shared_ptr< ICommunicator >>  localInstanceCommunicators,
const std::string &  sensorName = "" 
)
inlineoverridevirtual

Initialize the communicator and start its processing loop.

Parameters
[in]streamIdStream identifier for this communicator.
[in]startReference start time for timestamp conversion.
[in]localInstanceCommunicatorsCommunicators for local streams.
[in]sensorNameSensor name used by external transports.

Implements ICommunicator.

Definition at line 52 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ isInitialized() [1/2]

bool DummyCommunicator::isInitialized ( )
inlineoverridevirtual

Check if the communicator is initialized.

Returns
True if the communicator is initialized.

Implements ICommunicator.

Definition at line 43 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ isInitialized() [2/2]

bool DummyCommunicator::isInitialized ( )
inlineoverridevirtual

Check if the communicator is initialized.

Returns
True if the communicator is initialized.

Implements ICommunicator.

Definition at line 43 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ processMessage() [1/2]

void DummyCommunicator::processMessage ( Payload  payload)
inlineoverridevirtual

Process an incoming message.

Parameters
[in]payloadIncoming message to place in the input buffers.

Implements ICommunicator.

Definition at line 99 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ processMessage() [2/2]

void DummyCommunicator::processMessage ( Payload  payload)
inlineoverridevirtual

Process an incoming message.

Parameters
[in]payloadIncoming message to place in the input buffers.

Implements ICommunicator.

Definition at line 99 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ requestToSend() [1/4]

void DummyCommunicator::requestToSend ( const std::vector< Payload > &  payloads)
inlineoverridevirtual

Request to send a message.

Parameters
[in]payloadsMessages to send.

Implements ICommunicator.

Definition at line 84 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ requestToSend() [2/4]

void DummyCommunicator::requestToSend ( const std::vector< Payload > &  payloads)
inlineoverridevirtual

Request to send a message.

Parameters
[in]payloadsMessages to send.

Implements ICommunicator.

Definition at line 84 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ requestToSend() [3/4]

void DummyCommunicator::requestToSend ( Payload  payload)
inlineoverridevirtual

Request to send a message.

Parameters
[in]payloadMessage to send.

Implements ICommunicator.

Definition at line 78 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.

◆ requestToSend() [4/4]

void DummyCommunicator::requestToSend ( Payload  payload)
inlineoverridevirtual

Request to send a message.

Parameters
[in]payloadMessage to send.

Implements ICommunicator.

Definition at line 78 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/DummyCommunicator.hpp.


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