NVIDIA DeepStream SDK API Reference: CommunicatorFactoryParams Class Reference | NVIDIA Docs


NVIDIA DeepStream SDK API Reference	9.2 Release

Detailed Description

Store communicator-factory configuration parameters.

Definition at line 27 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/Communicator_factory.hpp.

Inheritance diagram for CommunicatorFactoryParams:

Inheritance graph

[legend]

Collaboration diagram for CommunicatorFactoryParams:

Collaboration graph

[legend]

Public Member Functions
	CommunicatorFactoryParams ()
	Initialize factory parameters with the dummy communicator type. More...

	CommunicatorFactoryParams (const std::string &configFilePath, const std::string moduleName)
	Initialize factory parameters from a configuration module. More...

	CommunicatorFactoryParams (const YAML::Node &fn)
	Initialize factory parameters from a YAML node. More...

void	read (const YAML::Node &fn) override
	Update factory parameters from a YAML node. More...

	CommunicatorFactoryParams ()
	Initialize factory parameters with the dummy communicator type. More...

	CommunicatorFactoryParams (const std::string &configFilePath, const std::string moduleName)
	Initialize factory parameters from a configuration module. More...

	CommunicatorFactoryParams (const YAML::Node &fn)
	Initialize factory parameters from a YAML node. More...

void	read (const YAML::Node &fn) override
	Update factory parameters from a YAML node. More...

Static Public Member Functions
static std::string	resolvePathRelativeToConfig (const std::string &configFilePath, const std::string &filePath)
	Resolve a configured path relative to the tracker configuration file. More...

static std::string	resolvePathRelativeToConfig (const std::string &configFilePath, const std::string &filePath)
	Resolve a configured path relative to the tracker configuration file. More...

static const YAML::Node	getConfigRoot (const std::string &configFilePath, const bool printMessage=false)
	Load the root YAML node from a tracker configuration file. More...

static const YAML::Node	getConfigRoot (const std::string &configFilePath, const bool printMessage=false)
	Load the root YAML node from a tracker configuration file. More...

Data Fields
COMMUNICATOR_TYPES	m_communicatorType
	Selects the communicator implementation. More...

Constructor & Destructor Documentation

◆ CommunicatorFactoryParams() [1/6]

CommunicatorFactoryParams::CommunicatorFactoryParams ( )

inline

Initialize factory parameters with the dummy communicator type.

Definition at line 31 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/Communicator_factory.hpp.

References DUMMY_COMMUNICATOR, and m_communicatorType.

Referenced by read().

◆ CommunicatorFactoryParams() [2/6]

CommunicatorFactoryParams::CommunicatorFactoryParams	(	const std::string &	configFilePath,
		const std::string	moduleName
	)

inline

Initialize factory parameters from a configuration module.

Parameters

[in]	configFilePath	The path to a configuration file.
[in]	moduleName	The configuration module name.

Definition at line 41 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/Communicator_factory.hpp.

References NvTrackerParams::getConfigRoot(), and read().

◆ CommunicatorFactoryParams() [3/6]

CommunicatorFactoryParams::CommunicatorFactoryParams ( const YAML::Node & fn )

inline

Initialize factory parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure of config to update.

Definition at line 51 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/Communicator_factory.hpp.

References read().

◆ CommunicatorFactoryParams() [4/6]

CommunicatorFactoryParams::CommunicatorFactoryParams ( )

inline

Initialize factory parameters with the dummy communicator type.

Definition at line 31 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/Communicator_factory.hpp.

References DUMMY_COMMUNICATOR, and m_communicatorType.

◆ CommunicatorFactoryParams() [5/6]

CommunicatorFactoryParams::CommunicatorFactoryParams	(	const std::string &	configFilePath,
		const std::string	moduleName
	)

inline

Initialize factory parameters from a configuration module.

Parameters

[in]	configFilePath	The path to a configuration file.
[in]	moduleName	The configuration module name.

Definition at line 41 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/Communicator_factory.hpp.

References NvTrackerParams::getConfigRoot(), and read().

◆ CommunicatorFactoryParams() [6/6]

CommunicatorFactoryParams::CommunicatorFactoryParams ( const YAML::Node & fn )

inline

Initialize factory parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure of config to update.

Definition at line 51 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/Communicator_factory.hpp.

References read().

Member Function Documentation

◆ getConfigRoot() [1/2]

static const YAML::Node NvTrackerParams::getConfigRoot	(	const std::string &	configFilePath,
		const bool	printMessage = `false`
	)

inlinestaticinherited

Load the root YAML node from a tracker configuration file.

Parameters

[in]	configFilePath	Path to the tracker configuration file.
[in]	printMessage	Enables warning output when the configuration cannot be loaded.

Returns: Loaded YAML root node, or an empty node when loading fails.

Definition at line 121 of file sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/NvTrackerParams.hpp.

References CLOG.

Referenced by CommunicatorFactoryParams(), CommunicatorParams::CommunicatorParams(), DataAssociatorFactoryParams::DataAssociatorFactoryParams(), EstimatorFactoryParams2::EstimatorFactoryParams2(), MqttCommunicatorParams::MqttCommunicatorParams(), MultiViewAssociatorFactoryParams::MultiViewAssociatorFactoryParams(), MultiViewAssociatorParams::MultiViewAssociatorParams(), PoseEstimatorFactoryParams::PoseEstimatorFactoryParams(), ReIDFactoryParams::ReIDFactoryParams(), ReIDServiceFactoryParams::ReIDServiceFactoryParams(), SegmenterFactoryParams::SegmenterFactoryParams(), and VisualTrackerFactoryParams::VisualTrackerFactoryParams().

◆ getConfigRoot() [2/2]

static const YAML::Node NvTrackerParams::getConfigRoot	(	const std::string &	configFilePath,
		const bool	printMessage = `false`
	)

inlinestaticinherited

Load the root YAML node from a tracker configuration file.

Parameters

[in]	configFilePath	Path to the tracker configuration file.
[in]	printMessage	Enables warning output when the configuration cannot be loaded.

Returns: Loaded YAML root node, or an empty node when loading fails.

Definition at line 121 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/NvTrackerParams.hpp.

References CLOG.

◆ read() [1/2]

void CommunicatorFactoryParams::read ( const YAML::Node & fn )

inlineoverridevirtual

Update factory parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure of config to update.

Implements NvTrackerParams.

Definition at line 60 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/Communicator_factory.hpp.

References CommunicatorFactoryParams(), and m_communicatorType.

◆ read() [2/2]

void CommunicatorFactoryParams::read ( const YAML::Node & fn )

inlineoverridevirtual

Update factory parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure of config to update.

Implements NvTrackerParams.

Definition at line 60 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/Communicator_factory.hpp.

References CommunicatorFactoryParams(), and m_communicatorType.

Referenced by CommunicatorFactoryParams().

◆ resolvePathRelativeToConfig() [1/2]

static std::string NvTrackerParams::resolvePathRelativeToConfig	(	const std::string &	configFilePath,
		const std::string &	filePath
	)

inlinestaticinherited

Resolve a configured path relative to the tracker configuration file.

Existing paths are canonicalized, while nonexistent relative paths remain joined to the configuration directory.

Parameters

[in]	configFilePath	Path to the tracker configuration file.
[in]	filePath	Absolute or configuration-relative path to resolve.

Returns: Resolved path, or the original path when the configuration path cannot be resolved.

Definition at line 55 of file sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/NvTrackerParams.hpp.

Referenced by CommunicatorParams::CommunicatorParams(), and MqttCommunicatorParams::MqttCommunicatorParams().

◆ resolvePathRelativeToConfig() [2/2]

static std::string NvTrackerParams::resolvePathRelativeToConfig	(	const std::string &	configFilePath,
		const std::string &	filePath
	)

inlinestaticinherited

Resolve a configured path relative to the tracker configuration file.

Existing paths are canonicalized, while nonexistent relative paths remain joined to the configuration directory.

Parameters

[in]	configFilePath	Path to the tracker configuration file.
[in]	filePath	Absolute or configuration-relative path to resolve.

Returns: Resolved path, or the original path when the configuration path cannot be resolved.

Definition at line 55 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/NvTrackerParams.hpp.

Field Documentation

◆ m_communicatorType

COMMUNICATOR_TYPES CommunicatorFactoryParams::m_communicatorType

Selects the communicator implementation.

Definition at line 74 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/Communicator_factory.hpp.

Referenced by CommunicatorFactoryParams(), CommunicatorFactory::makeCommunicator(), and read().

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

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

Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact
© 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
NVIDIA Confidential | Subject to Change | For test and development only.
Wed Oct 28 2026 12:03:24 | PR-09318-R32