Detailed Description

Interface for the communicator.

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

Inheritance diagram for ICommunicator:

[legend]

Public Member Functions
virtual	~ICommunicator ()
	Destroy the communicator interface. More...

virtual bool	isInitialized ()=0
	Check if the communicator is initialized. More...

virtual void	initialize (const StreamId streamId, system_clock::time_point start, std::map< StreamId, std::shared_ptr< ICommunicator >> localInstanceCommunicators, const std::string &sensorName="")=0
	Initialize the communicator and start its processing loop. More...

virtual MessageType	available ()=0
	Return the type of the next buffered message, or NONE when the buffer is empty. More...

virtual void	requestToSend (Payload payload)=0
	Request to send a message. More...

virtual void	requestToSend (const std::vector< Payload > &payload)=0
	Request to send a message. More...

virtual void	get (Payload &payload)=0
	Get the message from buffer. More...

virtual void	processMessage (Payload payload)=0
	Process an incoming message. More...

virtual void	broadcast (Payload payload)=0
	Broadcast message. More...

virtual COMMUNICATOR_TYPES	getCommunicatorType ()=0
	Return the communicator implementation type. 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	~ICommunicator ()
	Destroy the communicator interface. More...

virtual bool	isInitialized ()=0
	Check if the communicator is initialized. More...

virtual void	initialize (const StreamId streamId, system_clock::time_point start, std::map< StreamId, std::shared_ptr< ICommunicator >> localInstanceCommunicators, const std::string &sensorName="")=0
	Initialize the communicator and start its processing loop. More...

virtual MessageType	available ()=0
	Return the type of the next buffered message, or NONE when the buffer is empty. More...

virtual void	requestToSend (Payload payload)=0
	Request to send a message. More...

virtual void	requestToSend (const std::vector< Payload > &payload)=0
	Request to send a message. More...

virtual void	get (Payload &payload)=0
	Get the message from buffer. More...

virtual void	processMessage (Payload payload)=0
	Process an incoming message. More...

virtual void	broadcast (Payload payload)=0
	Broadcast message. More...

virtual COMMUNICATOR_TYPES	getCommunicatorType ()=0
	Return the communicator implementation type. 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...

Constructor & Destructor Documentation

◆ ~ICommunicator() [1/2]

virtual ICommunicator::~ICommunicator ( )

inlinevirtual

Destroy the communicator interface.

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

◆ ~ICommunicator() [2/2]

virtual ICommunicator::~ICommunicator ( )

inlinevirtual

Destroy the communicator interface.

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

Member Function Documentation

◆ available() [1/2]

virtual MessageType ICommunicator::available ( )

pure virtual

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

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ available() [2/2]

virtual MessageType ICommunicator::available ( )

pure virtual

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

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ broadcast() [1/2]

virtual void ICommunicator::broadcast ( Payload payload )

pure virtual

Broadcast message.

Parameters

[in] payload Message to broadcast.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ broadcast() [2/2]

virtual void ICommunicator::broadcast ( Payload payload )

pure virtual

Broadcast message.

Parameters

[in] payload Message to broadcast.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ get() [1/2]

virtual void ICommunicator::get ( Payload & payload )

pure virtual

Get the message from buffer.

Parameters

[out] payload Message removed from the input buffer.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ get() [2/2]

virtual void ICommunicator::get ( Payload & payload )

pure virtual

Get the message from buffer.

Parameters

[out] payload Message removed from the input buffer.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ getCommunicatorType() [1/2]

virtual COMMUNICATOR_TYPES ICommunicator::getCommunicatorType ( )

pure virtual

Return the communicator implementation type.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ getCommunicatorType() [2/2]

virtual COMMUNICATOR_TYPES ICommunicator::getCommunicatorType ( )

pure virtual

Return the communicator implementation type.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ getEgoCamId() [1/2]

virtual CamId ICommunicator::getEgoCamId ( )

inlinevirtual

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 ( )

inlinevirtual

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 ( )

inlinevirtual

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.

◆ getPeerCamIds() [2/2]

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

inlinevirtual

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.

◆ initialize() [1/2]

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

pure virtual

Initialize the communicator and start its processing loop.

Parameters

[in]	streamId	Stream identifier for this communicator.
[in]	start	Reference start time for timestamp conversion.
[in]	localInstanceCommunicators	Communicators for local streams.
[in]	sensorName	Sensor name used by external transports.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ initialize() [2/2]

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

pure virtual

Initialize the communicator and start its processing loop.

Parameters

[in]	streamId	Stream identifier for this communicator.
[in]	start	Reference start time for timestamp conversion.
[in]	localInstanceCommunicators	Communicators for local streams.
[in]	sensorName	Sensor name used by external transports.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ isInitialized() [1/2]

virtual bool ICommunicator::isInitialized ( )

pure virtual

Check if the communicator is initialized.

Returns: True if the communicator is initialized.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ isInitialized() [2/2]

virtual bool ICommunicator::isInitialized ( )

pure virtual

Check if the communicator is initialized.

Returns: True if the communicator is initialized.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ processMessage() [1/2]

virtual void ICommunicator::processMessage ( Payload payload )

pure virtual

Process an incoming message.

Parameters

[in] payload Incoming message to place in the input buffers.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ processMessage() [2/2]

virtual void ICommunicator::processMessage ( Payload payload )

pure virtual

Process an incoming message.

Parameters

[in] payload Incoming message to place in the input buffers.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ requestToSend() [1/4]

virtual void ICommunicator::requestToSend ( const std::vector< Payload > & payload )

pure virtual

Request to send a message.

Parameters

[in] payload Messages to send.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ requestToSend() [2/4]

virtual void ICommunicator::requestToSend ( const std::vector< Payload > & payload )

pure virtual

Request to send a message.

Parameters

[in] payload Messages to send.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ requestToSend() [3/4]

virtual void ICommunicator::requestToSend ( Payload payload )

pure virtual

Request to send a message.

Parameters

[in] payload Message to send.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

◆ requestToSend() [4/4]

virtual void ICommunicator::requestToSend ( Payload payload )

pure virtual

Request to send a message.

Parameters

[in] payload Message to send.

Implemented in MqttCommunicator, MqttCommunicator, MemoryAccessCommunicator, MemoryAccessCommunicator, DummyCommunicator, and DummyCommunicator.

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

sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/ICommunicator.hpp

NVIDIA DeepStream SDK API Reference

9.2 Release

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ ~ICommunicator() [1/2]

◆ ~ICommunicator() [2/2]

Member Function Documentation

◆ available() [1/2]

◆ available() [2/2]

◆ broadcast() [1/2]

◆ broadcast() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ getCommunicatorType() [1/2]

◆ getCommunicatorType() [2/2]

◆ getEgoCamId() [1/2]

◆ getEgoCamId() [2/2]

◆ getPeerCamIds() [1/2]

◆ getPeerCamIds() [2/2]

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ isInitialized() [1/2]

◆ isInitialized() [2/2]

◆ processMessage() [1/2]

◆ processMessage() [2/2]

◆ requestToSend() [1/4]

◆ requestToSend() [2/4]

◆ requestToSend() [3/4]

◆ requestToSend() [4/4]