UsageManager Class Reference

UsageManager class is a utility class that helps with configuration parameters. More...

#include <UsageManager.hpp>

Public Member Functions
	UsageManager (UsageManager &other)=delete
	Disabling the possibility to clone the Singleton object. Singletons should not be cloneable. More...
void	operator= (const UsageManager &)=delete
	Disabling the possibility to assign a Singleton object. Singletons should not be assignable. More...
virtual	~UsageManager ()
	Destroy the Usage Manager object. More...
int *	get_argc (void)
	Get the argc's pointer. More...
char ***	get_argv (void)
	Get the argv's pointer. More...

Static Public Member Functions
static UsageManager *	getInstance (int *argc, char ***argv, const int expected_argc, const char *expectedUsageMessage)
	Get the unique class instance, given input parameters. This method should be called the first time when we want to create a reference to the object of this class. More...
static UsageManager *	getInstance (void)
	Get the unique class instance. This methods should be called in the following scenario: when we just want to retrieve the reference to the object of this class. More...

Private Member Functions
const int	get_expected_argc (void)
	Get the expected argc value. More...
const char *	get_expectedUsageMessage (void)
	Get the expected usage message. More...
void	checkUsage (void)
	Checks if the configuration parameters are valid and if they are equal to the number of the expected parameters. If not, it raises an error. More...
	UsageManager (int *argc=nullptr, char ***argv=nullptr, const int expected_argc=0, const char *expectedUsageMessage=nullptr)
	Construct a new UsageManager object. More...

Private Attributes
int *	argc
	configuration parameters' number. More...
char ***	argv
	configuration parameters. More...
const int	expected_argc
	expected configuration parameters' number. More...
const char *	expectedUsageMessage
	a simple message that lets the user understand how to properly run the executable. More...

Static Private Attributes
static UsageManager *	sharedInstance { nullptr }
	The field for storing the singleton instance. More...
static std::mutex	singletonMutex
	Mutex for thread-safe access. More...

Detailed Description

UsageManager class is a utility class that helps with configuration parameters.

UsageManager class is a class that keeps track of configuration parameters read from a configuration file, checks if these parameters are valid, and if they are equal to the number of the expected parameters. Furthermore, it offers an on-demand service by returning the parameters read from the file to the callers.

Definition at line 27 of file UsageManager.hpp.

Constructor & Destructor Documentation

UsageManager() [1/2]

UsageManager::UsageManager ( int *  argc = nullptr, char ***  argv = nullptr, const int  expected_argc = 0, const char *  expectedUsageMessage = nullptr  )

inlineprivate

Construct a new UsageManager object.

Parameters

argc	configuration parameters' number.
argv	configuration parameters.
expected_argc	expected configuration parameters' number.
expectedUsageMessage	a simple message that lets the user understand how to properly run the executable.

Definition at line 84 of file UsageManager.hpp.

                                                                                                                                           : argc(argc), argv(argv), expected_argc(expected_argc), expectedUsageMessage(expectedUsageMessage) {
        checkUsage();
    }

References checkUsage().

Referenced by getInstance().

UsageManager() [2/2]

UsageManager::UsageManager ( UsageManager &  other )

delete

Disabling the possibility to clone the Singleton object. Singletons should not be cloneable.

Parameters

other

~UsageManager()

UsageManager::~UsageManager ( )

virtual

Destroy the Usage Manager object.

Definition at line 37 of file UsageManager.cpp.

                            {
    for (unsigned int i = 0; i < * get_argc(); i++) delete [] (* get_argv())[i];
    delete get_argc();
    delete get_argv();
    delete sharedInstance;
}

References get_argc(), get_argv(), and sharedInstance.

Member Function Documentation

checkUsage()

void UsageManager::checkUsage ( void  )

private

Checks if the configuration parameters are valid and if they are equal to the number of the expected parameters. If not, it raises an error.

Definition at line 20 of file UsageManager.cpp.

                                   {
    if (* get_argc() != get_expected_argc()) {
        std::string buffer = "Usage: ./" + std::string((* get_argv())[programNameOffset]) + std::string(get_expectedUsageMessage()) + " -- " + std::string(CHECK_USAGE_SCOPE);
        CV_Error(CHECK_USAGE_ERROR, buffer);
    }
}

References CHECK_USAGE_ERROR, CHECK_USAGE_SCOPE, get_argc(), get_argv(), get_expected_argc(), get_expectedUsageMessage(), and programNameOffset.

Referenced by UsageManager().

get_argc()

int * UsageManager::get_argc

(

void

)

Get the argc's pointer.

Returns

int*

Definition at line 56 of file UsageManager.cpp.

                                  {
    return this->argc;
}

References argc.

Referenced by checkUsage(), and ~UsageManager().

get_argv()

char *** UsageManager::get_argv

(

void

)

Get the argv's pointer.

Returns

char ***

Definition at line 60 of file UsageManager.cpp.

                                     {
    std::stringstream openPoseTerminalCommand;
    UsageManager * usageManagerInstance = UsageManager::getInstance();
    if (usageManagerInstance == nullptr) CV_Error(USAGE_MANAGER_NULLPTR_ERROR, USAGE_MANAGER_NULLPTR_SCOPE);
    return usageManagerInstance->argv;
}

References argv, getInstance(), USAGE_MANAGER_NULLPTR_ERROR, and USAGE_MANAGER_NULLPTR_SCOPE.

Referenced by checkUsage(), OpenCV_Manager::getVideoFramesCV(), FacadeSingleton::sendData(), CleanCommand::setCommand(), OpenPoseCommand::setCommand(), MoveCommand::setCommand(), OpenCV_Manager::showSkeletonsCV(), and ~UsageManager().

get_expected_argc()

const int UsageManager::get_expected_argc ( void  )

private

Get the expected argc value.

Returns

const int

Definition at line 27 of file UsageManager.cpp.

                                               {
    return this->expected_argc;
}

References expected_argc.

Referenced by checkUsage().

get_expectedUsageMessage()

const char * UsageManager::get_expectedUsageMessage ( void  )

private

Get the expected usage message.

Returns

const char *

Definition at line 31 of file UsageManager.cpp.

                                                         {
    return this->expectedUsageMessage;
}

References expectedUsageMessage.

Referenced by checkUsage().

getInstance() [1/2]

UsageManager * UsageManager::getInstance ( int *  argc, char ***  argv, const int  expected_argc, const char *  expectedUsageMessage  )

static

Get the unique class instance, given input parameters. This method should be called the first time when we want to create a reference to the object of this class.

Parameters

argc	configuration parameters' number.
argv	configuration parameters.
expected_argc	expected configuration parameters' number.
expectedUsageMessage	a simple message that lets the user understand how to properly run the executable.

Returns

UsageManager *

Definition at line 44 of file UsageManager.cpp.

                                                                                                                               {
    std::lock_guard <std::mutex> lock(singletonMutex);
    if (sharedInstance == nullptr) sharedInstance = new UsageManager(argc, argv, expected_argc, expectedUsageMessage);
    return sharedInstance;
}

References argc, argv, expected_argc, expectedUsageMessage, sharedInstance, singletonMutex, and UsageManager().

getInstance() [2/2]

UsageManager * UsageManager::getInstance ( void  )

static

Get the unique class instance. This methods should be called in the following scenario: when we just want to retrieve the reference to the object of this class.

Returns

UsageManager*

Definition at line 50 of file UsageManager.cpp.

                                              {
    std::lock_guard <std::mutex> lock(singletonMutex);
    if (sharedInstance == nullptr) return nullptr;
    return sharedInstance;
}

References sharedInstance, and singletonMutex.

Referenced by FacadeSingleton::FacadeSingleton(), get_argv(), OpenCV_Manager::getVideoFramesCV(), CleanCommand::setCommand(), OpenPoseCommand::setCommand(), and MoveCommand::setCommand().

operator=()

void UsageManager::operator= ( const UsageManager &  )

delete

Disabling the possibility to assign a Singleton object. Singletons should not be assignable.

Member Data Documentation

argc

int* UsageManager::argc

private

configuration parameters' number.

Definition at line 43 of file UsageManager.hpp.

Referenced by get_argc(), and getInstance().

argv

char*** UsageManager::argv

private

configuration parameters.

Definition at line 47 of file UsageManager.hpp.

Referenced by get_argv(), and getInstance().

expected_argc

const int UsageManager::expected_argc

private

expected configuration parameters' number.

Definition at line 51 of file UsageManager.hpp.

Referenced by get_expected_argc(), and getInstance().

expectedUsageMessage

const char* UsageManager::expectedUsageMessage

private

a simple message that lets the user understand how to properly run the executable.

Definition at line 55 of file UsageManager.hpp.

Referenced by get_expectedUsageMessage(), and getInstance().

sharedInstance

UsageManager * UsageManager::sharedInstance { nullptr }

staticprivate

The field for storing the singleton instance.

Definition at line 32 of file UsageManager.hpp.

Referenced by getInstance(), and ~UsageManager().

singletonMutex

std::mutex UsageManager::singletonMutex

staticprivate

Mutex for thread-safe access.

Definition at line 36 of file UsageManager.hpp.

Referenced by getInstance().

---

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

• Managers/UsageManager.hpp
• Managers/UsageManager.cpp