NVIDIA DeepStream SDK API Reference

9.2 Release
DummySegmenterConfigParams Class Reference

Detailed Description

Stores configuration for a segmenter implementation.

Definition at line 26 of file sources/libs/nvmultiobjecttracker/include/modules/Segmenter/DummySegmenter.hpp.

Inheritance diagram for DummySegmenterConfigParams:
Collaboration diagram for DummySegmenterConfigParams:

Public Member Functions

 DummySegmenterConfigParams ()
 Construct a DummySegmenterConfigParams instance. More...
 
 DummySegmenterConfigParams (const std::string &configFilePath, const std::string moduleName)
 Construct a DummySegmenterConfigParams instance. More...
 
 DummySegmenterConfigParams (const YAML::Node &fn)
 Construct a DummySegmenterConfigParams instance. More...
 
void read (const YAML::Node &fn) override
 Load configuration values from a YAML node. More...
 
 DummySegmenterConfigParams ()
 Construct a DummySegmenterConfigParams instance. More...
 
 DummySegmenterConfigParams (const std::string &configFilePath, const std::string moduleName)
 Construct a DummySegmenterConfigParams instance. More...
 
 DummySegmenterConfigParams (const YAML::Node &fn)
 Construct a DummySegmenterConfigParams instance. More...
 
void read (const YAML::Node &fn) override
 Load configuration values 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

int m_debugVerboseLevel
 Debug message verbose mode level. More...
 
SEGMENTER_TYPES m_segmenterType
 The type of Segmenter. More...
 

Constructor & Destructor Documentation

◆ DummySegmenterConfigParams() [1/6]

DummySegmenterConfigParams::DummySegmenterConfigParams ( )

Construct a DummySegmenterConfigParams instance.

◆ DummySegmenterConfigParams() [2/6]

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

Construct a DummySegmenterConfigParams instance.

Parameters
[in]configFilePathPath to the tracker configuration file.
[in]moduleNameConfiguration module name.

◆ DummySegmenterConfigParams() [3/6]

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

Construct a DummySegmenterConfigParams instance.

Parameters
[in]fnParsed YAML node.

◆ DummySegmenterConfigParams() [4/6]

DummySegmenterConfigParams::DummySegmenterConfigParams ( )

Construct a DummySegmenterConfigParams instance.

◆ DummySegmenterConfigParams() [5/6]

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

Construct a DummySegmenterConfigParams instance.

Parameters
[in]configFilePathPath to the tracker configuration file.
[in]moduleNameConfiguration module name.

◆ DummySegmenterConfigParams() [6/6]

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

Construct a DummySegmenterConfigParams instance.

Parameters
[in]fnParsed YAML node.

Member Function Documentation

◆ getConfigRoot() [1/2]

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

◆ 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]configFilePathPath to the tracker configuration file.
[in]printMessageEnables 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 DummySegmenterConfigParams::read ( const YAML::Node &  fn)
overridevirtual

Load configuration values from a YAML node.

Parameters
[in]fnParsed YAML node.

Implements NvTrackerParams.

◆ read() [2/2]

void DummySegmenterConfigParams::read ( const YAML::Node &  fn)
overridevirtual

Load configuration values from a YAML node.

Parameters
[in]fnParsed YAML node.

Implements NvTrackerParams.

◆ 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]configFilePathPath to the tracker configuration file.
[in]filePathAbsolute 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]configFilePathPath to the tracker configuration file.
[in]filePathAbsolute 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_debugVerboseLevel

int DummySegmenterConfigParams::m_debugVerboseLevel

Debug message verbose mode level.

Definition at line 51 of file sources/libs/nvmultiobjecttracker/include/modules/Segmenter/DummySegmenter.hpp.

◆ m_segmenterType

SEGMENTER_TYPES DummySegmenterConfigParams::m_segmenterType

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