NVIDIA DeepStream SDK API Reference

9.2 Release
MemoryAccessCommunicator Class Reference

Detailed Description

MemoryAccessCommunicator class is responsible for handling the communication between the MultiViewAssociator and the TargetManager (NvTrackedObjectManager).

Definition at line 104 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MemoryAccessCommunicator.hpp.

Inheritance diagram for MemoryAccessCommunicator:
Collaboration diagram for MemoryAccessCommunicator:

Public Member Functions

 MemoryAccessCommunicator ()
 Construct an uninitialized memory-access communicator. More...
 
 MemoryAccessCommunicator (const std::string &configFilePath)
 Construct a memory-access communicator from configuration. More...
 
 ~MemoryAccessCommunicator () override
 Stop and destroy the memory-access communicator. More...
 
bool isInitialized () override
 Return whether 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...
 
std::vector< CamId > getPeerCamIds () override
 Return peer camera IDs from camera configuration. More...
 
CamId getEgoCamId () override
 Return the ego camera ID from camera configuration. More...
 
 MemoryAccessCommunicator ()
 Construct an uninitialized memory-access communicator. More...
 
 MemoryAccessCommunicator (const std::string &configFilePath)
 Construct a memory-access communicator from configuration. More...
 
 ~MemoryAccessCommunicator () override
 Stop and destroy the memory-access communicator. More...
 
bool isInitialized () override
 Return whether 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...
 
std::vector< CamId > getPeerCamIds () override
 Return peer camera IDs from camera configuration. More...
 
CamId getEgoCamId () override
 Return the ego camera ID from camera configuration. More...
 

Constructor & Destructor Documentation

◆ MemoryAccessCommunicator() [1/4]

MemoryAccessCommunicator::MemoryAccessCommunicator ( )

Construct an uninitialized memory-access communicator.

◆ MemoryAccessCommunicator() [2/4]

MemoryAccessCommunicator::MemoryAccessCommunicator ( const std::string &  configFilePath)

Construct a memory-access communicator from configuration.

Parameters
[in]configFilePathPath to the configuration file.

◆ ~MemoryAccessCommunicator() [1/2]

MemoryAccessCommunicator::~MemoryAccessCommunicator ( )
override

Stop and destroy the memory-access communicator.

◆ MemoryAccessCommunicator() [3/4]

MemoryAccessCommunicator::MemoryAccessCommunicator ( )

Construct an uninitialized memory-access communicator.

◆ MemoryAccessCommunicator() [4/4]

MemoryAccessCommunicator::MemoryAccessCommunicator ( const std::string &  configFilePath)

Construct a memory-access communicator from configuration.

Parameters
[in]configFilePathPath to the configuration file.

◆ ~MemoryAccessCommunicator() [2/2]

MemoryAccessCommunicator::~MemoryAccessCommunicator ( )
override

Stop and destroy the memory-access communicator.

Member Function Documentation

◆ available() [1/2]

MessageType MemoryAccessCommunicator::available ( )
overridevirtual

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

Implements ICommunicator.

◆ available() [2/2]

MessageType MemoryAccessCommunicator::available ( )
overridevirtual

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

Implements ICommunicator.

◆ broadcast() [1/2]

void MemoryAccessCommunicator::broadcast ( Payload  payload)
overridevirtual

Broadcast message.

Parameters
[in]payloadMessage to broadcast.

Implements ICommunicator.

◆ broadcast() [2/2]

void MemoryAccessCommunicator::broadcast ( Payload  payload)
overridevirtual

Broadcast message.

Parameters
[in]payloadMessage to broadcast.

Implements ICommunicator.

◆ get() [1/2]

void MemoryAccessCommunicator::get ( Payload &  payload)
overridevirtual

Get the message from buffer.

Parameters
[out]payloadMessage removed from the input buffer.

Implements ICommunicator.

◆ get() [2/2]

void MemoryAccessCommunicator::get ( Payload &  payload)
overridevirtual

Get the message from buffer.

Parameters
[out]payloadMessage removed from the input buffer.

Implements ICommunicator.

◆ getCommunicatorType() [1/2]

COMMUNICATOR_TYPES MemoryAccessCommunicator::getCommunicatorType ( )
inlineoverridevirtual

Return the communicator implementation type.

Implements ICommunicator.

Definition at line 169 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MemoryAccessCommunicator.hpp.

References MEMORY_ACCESS_COMMUNICATOR.

◆ getCommunicatorType() [2/2]

COMMUNICATOR_TYPES MemoryAccessCommunicator::getCommunicatorType ( )
inlineoverridevirtual

Return the communicator implementation type.

Implements ICommunicator.

Definition at line 169 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MemoryAccessCommunicator.hpp.

References MEMORY_ACCESS_COMMUNICATOR.

◆ getEgoCamId() [1/2]

CamId MemoryAccessCommunicator::getEgoCamId ( )
overridevirtual

Return the ego camera ID from camera configuration.

Reimplemented from ICommunicator.

◆ getEgoCamId() [2/2]

CamId MemoryAccessCommunicator::getEgoCamId ( )
overridevirtual

Return the ego camera ID from camera configuration.

Reimplemented from ICommunicator.

◆ getPeerCamIds() [1/2]

std::vector<CamId> MemoryAccessCommunicator::getPeerCamIds ( )
overridevirtual

Return peer camera IDs from camera configuration.

Reimplemented from ICommunicator.

◆ getPeerCamIds() [2/2]

std::vector<CamId> MemoryAccessCommunicator::getPeerCamIds ( )
overridevirtual

Return peer camera IDs from camera configuration.

Reimplemented from ICommunicator.

◆ initialize() [1/2]

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

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.

◆ initialize() [2/2]

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

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.

◆ isInitialized() [1/2]

bool MemoryAccessCommunicator::isInitialized ( )
overridevirtual

Return whether the communicator is initialized.

Implements ICommunicator.

◆ isInitialized() [2/2]

bool MemoryAccessCommunicator::isInitialized ( )
overridevirtual

Return whether the communicator is initialized.

Implements ICommunicator.

◆ processMessage() [1/2]

void MemoryAccessCommunicator::processMessage ( Payload  payload)
overridevirtual

Process an incoming message.

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

Implements ICommunicator.

◆ processMessage() [2/2]

void MemoryAccessCommunicator::processMessage ( Payload  payload)
overridevirtual

Process an incoming message.

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

Implements ICommunicator.

◆ requestToSend() [1/4]

void MemoryAccessCommunicator::requestToSend ( const std::vector< Payload > &  payloads)
overridevirtual

Request to send a message.

Parameters
[in]payloadsMessages to send.

Implements ICommunicator.

◆ requestToSend() [2/4]

void MemoryAccessCommunicator::requestToSend ( const std::vector< Payload > &  payloads)
overridevirtual

Request to send a message.

Parameters
[in]payloadsMessages to send.

Implements ICommunicator.

◆ requestToSend() [3/4]

void MemoryAccessCommunicator::requestToSend ( Payload  payload)
overridevirtual

Request to send a message.

Parameters
[in]payloadMessage to send.

Implements ICommunicator.

◆ requestToSend() [4/4]

void MemoryAccessCommunicator::requestToSend ( Payload  payload)
overridevirtual

Request to send a message.

Parameters
[in]payloadMessage to send.

Implements ICommunicator.


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