CppSamples::Common::Utility Class Reference

#include <Utility.h>

Public Member Functions
	Utility ()
	~Utility ()

Static Public Member Functions
static bool	Init ()
	Initialize the SDK. More...
static VxSdk::IVxSystem *	Login (VxSdk::VxLoginInfo &loginInfo)
	Login to the VideoExpert system. More...
static std::string	ConvertLocalTimetoUTC (struct tm t)
	Converts the local time to UTC format More...
static std::string	ConvertUTCtoLocalTime (struct tm t)
	Converts the UTC time to local time format More...
static std::string	Encode (const std::string &toEncode)
	Encode given std::string using Base64 More...
static struct tm	GetDateAndTimeFromUser ()
	Get the date and time input from user and returns in struct format More...
static struct tm	ParseDateTime (char *dateTime)
	Parse a date time string and return in struct format More...
static void	ShowProgress (std::string statusMsg, unsigned int x, unsigned int n, int w=50)
	Show progress indicator in console More...
static std::string	GetNewGuid ()
	Initializes a new instance of the System.Guid structure and returns equivalent std::string. More...
static int	TzOffset ()
	Get the time zone offset in seconds More...
static void	ClearScreen ()
	Clear the screen More...
static std::string	ReadString ()
	Read a line from console input More...
static int	ReadInt ()
	Read an integer from console input More...
static void	Pause ()
	Pause for a user input More...
static std::string	Replace (std::string original, std::string from, std::string to)
	Replace a give string More...
static std::string	ConvertUTCTimeFormatToString (std::string utcFormat)
	Converts UTC time to string More...

Detailed Description

Definition at line 12 of file Utility.h.

Constructor & Destructor Documentation

CppSamples::Common::Utility::Utility ( )

inline

Definition at line 14 of file Utility.h.

{}

CppSamples::Common::Utility::~Utility ( )

inline

Definition at line 15 of file Utility.h.

{}

Member Function Documentation

void Utility::ClearScreen ( )

static

Clear the screen

Definition at line 249 of file Utility.cpp.

                          {
#ifndef WIN32
    system("clear");
#else
    system("cls");
#endif
}

string Utility::ConvertLocalTimetoUTC ( struct tm  t )

static

Converts the local time to UTC format

Parameters

t	Time struct to convert

Parameters

t	time struct to convert

Definition at line 28 of file Utility.cpp.

                                                 {
    // Convert local time to UTC
    stringstream fmt;
    time_t epochTime = mktime(&t);
    struct tm timeinfo;
#ifndef WIN32
    gmtime_r(&epochTime, &timeinfo);
#else
    gmtime_s(&timeinfo, &epochTime);
#endif

    // Convert tm structure to string
    fmt << timeinfo.tm_year + 1900 << "-"
        << setfill('0') << setw(2) << (timeinfo.tm_mon + 1) << "-"
        << setfill('0') << setw(2) << timeinfo.tm_mday << "T"
        << setfill('0') << setw(2) << timeinfo.tm_hour << ":"
        << setfill('0') << setw(2) << timeinfo.tm_min << ":"
        << setfill('0') << setw(2) << timeinfo.tm_sec << "Z";
    return fmt.str();
}

string Utility::ConvertUTCTimeFormatToString ( std::string  utcFormat )

static

Converts UTC time to string

Converts the UTC time format to string format (HH:MM::SS, Day Month)

Parameters

utcFormat

time string in UTC format (YYYYmmddTHHMMSSZ)

Definition at line 312 of file Utility.cpp.

                                                             {
    stringstream dateStream(utcFormat);
    struct tm parseTime;
    //Here parse date and time string value to time structure
    dateStream >> get_time(&parseTime, "%Y-%m-%dT%H:%M:%S");
    char buffer[18];
    strftime(buffer, 18, "%X %x", &parseTime);

    return string(buffer);
}

string Utility::ConvertUTCtoLocalTime ( struct tm  t )

static

Converts the UTC time to local time format

Parameters

t	Time struct to convert

Parameters

t	time struct to convert

Definition at line 53 of file Utility.cpp.

                                                 {
    // Convert UTC to local time
    stringstream fmt;
    time_t epochTime = mktime(&t);
    epochTime += TzOffset();
    struct tm timeinfo;
    localtime_s(&timeinfo, &epochTime);

    // Convert tm structure to string
    fmt << timeinfo.tm_year + 1900 << "-"
        << setfill('0') << setw(2) << (timeinfo.tm_mon + 1) << "-"
        << setfill('0') << setw(2) << timeinfo.tm_mday << "T"
        << setfill('0') << setw(2) << timeinfo.tm_hour << ":"
        << setfill('0') << setw(2) << timeinfo.tm_min << ":"
        << setfill('0') << setw(2) << timeinfo.tm_sec << "Z";
    return fmt.str();
}

string Utility::Encode ( const std::string &  toEncode )

static

Encode given std::string using Base64

Encode given string using Base64

Parameters

toEncode

String to encode

Parameters

toEncode

string to encode

Definition at line 75 of file Utility.cpp.

                                             {
    string kBase64Chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
    const char* data = toEncode.c_str();
    size_t size = toEncode.length();
    string ret;
    int i = 0;
    unsigned char char_array_3[3];
    unsigned char char_array_4[4];

    while (size--) {
        char_array_3[i++] = *(data++);
        if (i == 3) {
            char_array_4[0] = (char_array_3[0] & 0xfc) >> 2;
            char_array_4[1] = ((char_array_3[0] & 0x03) << 4) + ((char_array_3[1] & 0xf0) >> 4);
            char_array_4[2] = ((char_array_3[1] & 0x0f) << 2) + ((char_array_3[2] & 0xc0) >> 6);
            char_array_4[3] = char_array_3[2] & 0x3f;

            for (i = 0; i < 4; i++)
                ret += kBase64Chars[char_array_4[i]];
            i = 0;
        }
    }

    if (i) {
        int j = 0;
        for (j = i; j < 3; j++)
            char_array_3[j] = '\0';

        char_array_4[0] = (char_array_3[0] & 0xfc) >> 2;
        char_array_4[1] = ((char_array_3[0] & 0x03) << 4) + ((char_array_3[1] & 0xf0) >> 4);
        char_array_4[2] = ((char_array_3[1] & 0x0f) << 2) + ((char_array_3[2] & 0xc0) >> 6);
        char_array_4[3] = char_array_3[2] & 0x3f;

        for (j = 0; j < i + 1; j++)
            ret += kBase64Chars[char_array_4[j]];

        while (i++ < 3)
            ret += '=';
    }
    return ret;
}

tm Utility::GetDateAndTimeFromUser ( )

static

Get the date and time input from user and returns in struct format

Definition at line 120 of file Utility.cpp.

                                   {
    struct tm parseTime;
    while (true) {
        // Read a line from user input
        string dateAndTimeVal;
        getline(cin, dateAndTimeVal);

        if (!dateAndTimeVal.empty()) {
            // Here parse date and time string value to time structure
            stringstream dateStream(dateAndTimeVal);
            dateStream >> get_time(&parseTime, "%Y-%m-%d %H:%M:%S");
            if (dateStream.fail()) {
                cout << "Invalid time.\n";
            }
            else {
                break;
            }
        }
        else {
            cout << "Please enter a time.\n";
        }
        cout << "\n" << "Enter time (yyyy-mm-dd hh:mm:ss): ";
    }

    // Create new instance of time structure to avoid unnecessary info.
    struct tm t;
    t.tm_mon = parseTime.tm_mon;
    t.tm_year = parseTime.tm_year;
    t.tm_mday = parseTime.tm_mday;
    t.tm_hour = parseTime.tm_hour;
    t.tm_min = parseTime.tm_min;
    t.tm_sec = parseTime.tm_sec;
    return t;
}

string Utility::GetNewGuid ( )

static

Initializes a new instance of the System.Guid structure and returns equivalent std::string.

Initializes a new instance of the System.Guid structure and returns equivalent string.

Returns

String value of new Guid.

Definition at line 204 of file Utility.cpp.

                           {
    // Create new instance of GUID
#ifndef WIN32
    uuid_t uuid;
    uuid_generate_random ( uuid );
    char buffer[37];
    uuid_unparse ( uuid, buffer );
    return string(buffer);
#else
    GUID newGuid;
    HRESULT hCreateGuid = CoCreateGuid(&newGuid);

    // Convert the GUID to string
    char buffer[37];
    sprintf_s(buffer, "%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X",
        newGuid.Data1, newGuid.Data2, newGuid.Data3,
        newGuid.Data4[0], newGuid.Data4[1], newGuid.Data4[2], newGuid.Data4[3],
        newGuid.Data4[4], newGuid.Data4[5], newGuid.Data4[6], newGuid.Data4[7]);
    return string(buffer);
#endif
}

static bool CppSamples::Common::Utility::Init ( )

static

Initialize the SDK.

IVxSystem * Utility::Login ( VxSdk::VxLoginInfo &  loginInfo )

static

Login to the VideoExpert system.

Definition at line 15 of file Utility.cpp.

                                                {
    // Login to the VideoExpert system and get an instance of it.
    IVxSystem* system = nullptr;
    VxSystemLogin(loginInfo, system);

    // Return the system
    return system;
}

tm Utility::ParseDateTime ( char *  dateTime )

static

Parse a date time string and return in struct format

Parses a date time string and returns in struct format

Definition at line 158 of file Utility.cpp.

                                        {
    struct tm parseTime;
    string dateAndTimeVal = string(dateTime);

    // Here parse date and time string value to time structure
    stringstream dateStream(dateAndTimeVal);
    dateStream >> get_time(&parseTime, "%Y-%m-%dT%H:%M:%S");

    // Create new instance of time structure to avoid unnecessary info.
    struct tm t;
    t.tm_mon = parseTime.tm_mon;
    t.tm_year = parseTime.tm_year;
    t.tm_mday = parseTime.tm_mday;
    t.tm_hour = parseTime.tm_hour;
    t.tm_min = parseTime.tm_min;
    t.tm_sec = parseTime.tm_sec;
    return t;
}

void Utility::Pause ( )

static

Pause for a user input

Definition at line 280 of file Utility.cpp.

                    {
#ifndef WIN32
    std::cout << "Press any key to continue...";
    std::cin.clear();
    fseek(stdin, 0, SEEK_END);
    fflush(stdin);
    while (std::cin.get() != '\n');
#else
    system("pause");
#endif
}

int Utility::ReadInt ( )

static

Read an integer from console input

Definition at line 269 of file Utility.cpp.

                     {
    string line = "";
    cin >> line;
    int value = atoi(line.c_str());
    while (std::cin.get() != '\n');
    return value;
}

string Utility::ReadString ( )

static

Read a line from console input

Read a string from console input

Definition at line 260 of file Utility.cpp.

                           {
    string line = "";
    std::getline(std::cin, line);
    return line;
}

string Utility::Replace ( std::string  original, std::string  from, std::string  to  )

static

Replace a give string

Definition at line 295 of file Utility.cpp.

                                                               {
    int index = 0;
    int len = from.length();
    while (true) {
        index = original.find(from);
        if (index < 0) {
            break;
        }
        original = original.replace(index, len, to);
    }
    return original;
}

void Utility::ShowProgress ( std::string  statusMsg, unsigned int  x, unsigned int  n, int  w = 50  )

static

Show progress indicator in console

Parameters

statusMsg	Message to display
x	progress value
n	actual size
w	width of bar

Definition at line 184 of file Utility.cpp.

                                                                                  {
    if ((x != n) && (x % (n / 100 + 1) != 0))
        return;

    float ratio = x / static_cast<float>(n);
    int  c = static_cast<int>(ratio * w);
    int percentToDisplay = static_cast<int>(ratio * 100);
    // Sometimes, it can go upto 101, 102; so limit it to 100.
    if (percentToDisplay > 100)
        percentToDisplay = 100;
    cout << "  " << statusMsg << "  " << setfill(' ') << setw(3) << percentToDisplay << "% [";
    for (int k = 0; k < c; k++) cout << "=";
    for (int m = c; m < w; m++) cout << " ";
    cout << "]\r" << flush;
}

int Utility::TzOffset ( )

static

Get the time zone offset in seconds

Definition at line 229 of file Utility.cpp.

                      {
    int offset;
    tm utcTm{ 0 }, localTm{ 0 };
    time_t local = time(nullptr), utc;
#ifndef WIN32
    gmtime_r(&local, &utcTm);
#else
    gmtime_s(&utcTm, &local);
#endif
    localtime_s(&localTm, &local);
    localTm.tm_isdst = 0;
    local = mktime(&localTm);
    utc = mktime(&utcTm);
    offset = static_cast<int>(difftime(local, utc));
    return offset;
}

---

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

• C:/Git/VxSDK-Samples/CppSamples/Source/Common/Utility.h
• C:/Git/VxSDK-Samples/CppSamples/Source/Common/Utility.cpp