dca_interface  6.3.4
dca_ipr::IprClassification Class Reference

#include <ipr_classification.h>

Detailed Description

Definition of the IprClassification class.

Use the static create() function to create an instance of this class.

An IprClassification instance can be used to create a IprClassifier instance.

A IprCategoriesInfo class can be retrieved by using the getCategoriesInfo() function, which is used to enumerate all container objects.

Definition at line 60 of file ipr_classification.h.

Public Member Functions

IprCategoriesInfo getCategoriesInfo () const
 Retrieve the IprCategoriesInfo class.
 
IprClassifier createClassifier (const dca::DbConnection &aDbConnection, const IprClassifierOptions &aIprClassifierOptions=IprClassifierOptions()) const
 Creates a IprClassifier that is used to classify dca_ipr::Ip objects. More...
 
dca::LogLevel setLogLevel (dca::LogLevel newLevel)
 Changes the log level of the package and returns the previously used log level. Usually the logging level is set to LOG_Notice. More...
 

Static Public Member Functions

static IprClassification create (const dca::DcaInstance &aDca, const dca::License &aLicense)
 Initializes the IprClassification module. More...
 

Static Public Attributes

static DCA_MODULE_ID_TYPE ID
 The unique ID of the IPR classification module.
 

Member Function Documentation

◆ create()

static IprClassification dca_ipr::IprClassification::create ( const dca::DcaInstance aDca,
const dca::License aLicense 
)
static

Initializes the IprClassification module.

Parameters
[in]aDcaA previously initialized DcaInstance object
[in]aLicenseAn initialized License object
Returns
An initialized IprClassification instance.

◆ createClassifier()

IprClassifier dca_ipr::IprClassification::createClassifier ( const dca::DbConnection aDbConnection,
const IprClassifierOptions aIprClassifierOptions = IprClassifierOptions() 
) const

Creates a IprClassifier that is used to classify dca_ipr::Ip objects.

Parameters
[in]aDbConnectionAn initialized database connection object
[in]aIprClassifierOptionsOptions to use, if not provided the default options will be used
Returns
An initialized IprClassifier instance.
Exceptions
ExDca- One of the following error codes (available by using ExDca::getReturnCode() in your catch-handler)

◆ setLogLevel()

dca::LogLevel dca_ipr::IprClassification::setLogLevel ( dca::LogLevel  newLevel)

Changes the log level of the package and returns the previously used log level. Usually the logging level is set to LOG_Notice.

Parameters
[in]newLevelThe new log level the class instance should use for logging
Returns
The old used logging level.

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