Detailed Description

Store communicator configuration parameters.

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

Inheritance diagram for CommunicatorParams:

[legend]

Collaboration diagram for CommunicatorParams:

[legend]

Public Member Functions
	CommunicatorParams ()
	Initialize communicator parameters with default values. More...

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

	CommunicatorParams (const YAML::Node &fn)
	Initialize communicator parameters from a YAML node. More...

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

	CommunicatorParams ()
	Initialize communicator parameters with default values. More...

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

	CommunicatorParams (const YAML::Node &fn)
	Initialize communicator parameters from a YAML node. More...

void	read (const YAML::Node &fn) override
	Update communicator 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...

int	m_debugVerboseLevel
	Controls debug message verbosity. More...

int	m_saveLog2File
	Indicates whether communicator logs are saved to a file. More...

std::string	m_mqttProtoAdaptorConfigPath
	Stores the MQTT protocol-adaptor configuration path. More...

std::string	m_pubSubInfoConfigPath
	Path to publish/subscribe configuration file. More...

int	m_waitForConnInterval
	Specifies the interval between connection checks. More...

int	m_connTimeout
	Specifies the connection timeout. More...

Constructor & Destructor Documentation

◆ CommunicatorParams() [1/6]

CommunicatorParams::CommunicatorParams ( )

inline

Initialize communicator parameters with default values.

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

References DUMMY_COMMUNICATOR, m_communicatorType, m_connTimeout, m_debugVerboseLevel, m_mqttProtoAdaptorConfigPath, m_pubSubInfoConfigPath, m_saveLog2File, and m_waitForConnInterval.

Referenced by read().

◆ CommunicatorParams() [2/6]

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

inline

Initialize communicator parameters from a configuration module.

Parameters

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

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

References NvTrackerParams::getConfigRoot(), m_mqttProtoAdaptorConfigPath, m_pubSubInfoConfigPath, read(), and NvTrackerParams::resolvePathRelativeToConfig().

◆ CommunicatorParams() [3/6]

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

inline

Initialize communicator parameters from a YAML node.

Parameters

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

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

References read().

◆ CommunicatorParams() [4/6]

CommunicatorParams::CommunicatorParams ( )

inline

Initialize communicator parameters with default values.

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

References DUMMY_COMMUNICATOR, m_communicatorType, m_connTimeout, m_debugVerboseLevel, m_mqttProtoAdaptorConfigPath, m_pubSubInfoConfigPath, m_saveLog2File, and m_waitForConnInterval.

◆ CommunicatorParams() [5/6]

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

inline

Initialize communicator parameters from a configuration module.

Parameters

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

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

References NvTrackerParams::getConfigRoot(), m_mqttProtoAdaptorConfigPath, m_pubSubInfoConfigPath, read(), and NvTrackerParams::resolvePathRelativeToConfig().

◆ CommunicatorParams() [6/6]

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

inline

Initialize communicator parameters from a YAML node.

Parameters

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

Definition at line 59 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MemoryAccessCommunicator.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::CommunicatorFactoryParams(), 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 CommunicatorParams::read ( const YAML::Node & fn )

inlineoverridevirtual

Update communicator parameters from a YAML node.

Parameters

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

Implements NvTrackerParams.

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

References CommunicatorParams(), m_communicatorType, m_connTimeout, m_debugVerboseLevel, m_mqttProtoAdaptorConfigPath, m_pubSubInfoConfigPath, m_saveLog2File, and m_waitForConnInterval.

◆ read() [2/2]

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

inlineoverridevirtual

Update communicator parameters from a YAML node.

Parameters

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

Implements NvTrackerParams.

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

References CommunicatorParams(), m_communicatorType, m_connTimeout, m_debugVerboseLevel, m_mqttProtoAdaptorConfigPath, m_pubSubInfoConfigPath, m_saveLog2File, and m_waitForConnInterval.

Referenced by CommunicatorParams().

◆ 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(), 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 CommunicatorParams::m_communicatorType

Selects the communicator implementation.

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

Referenced by CommunicatorParams(), and read().

◆ m_connTimeout

int CommunicatorParams::m_connTimeout

Specifies the connection timeout.

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

Referenced by CommunicatorParams(), and read().

◆ m_debugVerboseLevel

int CommunicatorParams::m_debugVerboseLevel

Controls debug message verbosity.

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

Referenced by CommunicatorParams(), and read().

◆ m_mqttProtoAdaptorConfigPath

std::string CommunicatorParams::m_mqttProtoAdaptorConfigPath

Stores the MQTT protocol-adaptor configuration path.

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

Referenced by CommunicatorParams(), and read().

◆ m_pubSubInfoConfigPath

std::string CommunicatorParams::m_pubSubInfoConfigPath

Path to publish/subscribe configuration file.

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

Referenced by CommunicatorParams(), and read().

◆ m_saveLog2File

int CommunicatorParams::m_saveLog2File

Indicates whether communicator logs are saved to a file.

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

Referenced by CommunicatorParams(), and read().

◆ m_waitForConnInterval

int CommunicatorParams::m_waitForConnInterval

Specifies the interval between connection checks.

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

Referenced by CommunicatorParams(), and read().

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

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

NVIDIA DeepStream SDK API Reference

9.2 Release

Detailed Description

Public Member Functions

Static Public Member Functions

Data Fields

Constructor & Destructor Documentation

◆ CommunicatorParams() [1/6]

◆ CommunicatorParams() [2/6]

◆ CommunicatorParams() [3/6]

◆ CommunicatorParams() [4/6]

◆ CommunicatorParams() [5/6]

◆ CommunicatorParams() [6/6]

Member Function Documentation

◆ getConfigRoot() [1/2]

◆ getConfigRoot() [2/2]

◆ read() [1/2]

◆ read() [2/2]

◆ resolvePathRelativeToConfig() [1/2]

◆ resolvePathRelativeToConfig() [2/2]

Field Documentation

◆ m_communicatorType

◆ m_connTimeout

◆ m_debugVerboseLevel

◆ m_mqttProtoAdaptorConfigPath

◆ m_pubSubInfoConfigPath

◆ m_saveLog2File

◆ m_waitForConnInterval