CPPCli::QuickLog Class Reference

The QuickLog class represents a quick system health log. More...

#include <QuickLog.h>

Public Types
enum	LogCreationStatus {   LogCreationStatus::Unknown,   LogCreationStatus::InProgress,   LogCreationStatus::Failed,   LogCreationStatus::Successful }
	Values that represent status of creating a quick log. More...

Public Member Functions
	QuickLog (VxSdk::IVxQuickLog *vxQuickLog)
	Constructor. More...
virtual	~QuickLog ()
	Destructor. More...
	!QuickLog ()
	Finaliser. More...

Package Functions
System::String^	_GetQuickLogEndpoint ()
LogCreationStatus	_GetStatus ()

Package Attributes
VxSdk::IVxQuickLog *	_log

Properties
System::String^	QuickLogEndpoint [get]
	Gets the URI to the download location of the quick log. The endpoint will only be available if the VideoXpert system has completed generating the log. More...
LogCreationStatus	Status [get]
	Gets the current status of generating the quick log. More...

Detailed Description

The QuickLog class represents a quick system health log.

Definition at line 12 of file QuickLog.h.

Member Enumeration Documentation

enum CPPCli::QuickLog::LogCreationStatus

strong

Values that represent status of creating a quick log.

Enumerator
Unknown	An error or unknown value was returned.
InProgress	The log creation is in progress.
Failed	The log failed to be created.
Successful	The log has successfully been created.

Definition at line 18 of file QuickLog.h.

                                     {
            Unknown,
            InProgress,
            Failed,
            Successful
        };

Constructor & Destructor Documentation

CPPCli::QuickLog::QuickLog

(

VxSdk::IVxQuickLog *

vxQuickLog

)

Constructor.

Implements the quick log class.

Parameters

vxQuickLog

The vx quick log.

Definition at line 6 of file QuickLog.cpp.

                                                     {
    _log = vxQuickLog;
}

virtual CPPCli::QuickLog::~QuickLog ( )

inlinevirtual

Destructor.

Definition at line 38 of file QuickLog.h.

                            {
            this->!QuickLog();
        }

CPPCli::QuickLog::!QuickLog

(

)

Finaliser.

Definition at line 10 of file QuickLog.cpp.

                          {
    _log->Delete();
    _log = nullptr;
}

Member Function Documentation

System::String CPPCli::QuickLog::_GetQuickLogEndpoint ( )

package

Definition at line 15 of file QuickLog.cpp.

                                                   {
    char* logEndpoint = nullptr;
    int size = 0;

    // If the quick log endpoint is not available on the system the result will return VxSdk::VxResult::kActionUnavailable,
    // otherwise VxSdk::VxResult::kInsufficientSize
    VxSdk::VxResult::Value result = _log->GetQuickLogEndpoint(logEndpoint, size);
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for logEndpoint
        logEndpoint = new char[size];
        // The result should now be kOK since we have allocated enough space
        _log->GetQuickLogEndpoint(logEndpoint, size);
    }
    return gcnew System::String(logEndpoint);
}

CPPCli::QuickLog::LogCreationStatus CPPCli::QuickLog::_GetStatus ( )

package

Definition at line 31 of file QuickLog.cpp.

                                                           {
    // Get the status of the log
    VxSdk::VxLogCreationStatus::Value status;
    VxSdk::VxResult::Value result = _log->GetStatus(status);
    // Return the status if GetStatus was successful
    if (result == VxSdk::VxResult::kOK)
        return (CPPCli::QuickLog::LogCreationStatus)status;

    return CPPCli::QuickLog::LogCreationStatus::Unknown;
}

Member Data Documentation

VxSdk::IVxQuickLog* CPPCli::QuickLog::_log

package

Definition at line 67 of file QuickLog.h.

Property Documentation

System:: String^ CPPCli::QuickLog::QuickLogEndpoint

get

Gets the URI to the download location of the quick log. The endpoint will only be available if the VideoXpert system has completed generating the log.

Returns

The quick log endpoint, if available.

Definition at line 52 of file QuickLog.h.

LogCreationStatus CPPCli::QuickLog::Status

get

Gets the current status of generating the quick log.

The current quick log creation status.

Definition at line 61 of file QuickLog.h.

---

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

• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/QuickLog.h
• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/QuickLog.cpp