CPPCli::QuickReport Class Reference

The QuickReport class represents a quick system health report. More...

#include <QuickReport.h>

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

Public Member Functions
	QuickReport (VxSdk::IVxQuickReport *vxQuickReport)
	Constructor. More...
virtual	~QuickReport ()
	Destructor. More...
	!QuickReport ()
	Finaliser. More...

Package Functions
System::String^	_GetQuickReportEndpoint ()
ReportCreationStatus	_GetStatus ()

Package Attributes
VxSdk::IVxQuickReport *	_report

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

Detailed Description

The QuickReport class represents a quick system health report.

Definition at line 13 of file QuickReport.h.

Member Enumeration Documentation

enum CPPCli::QuickReport::ReportCreationStatus

strong

Values that represent status of creating a quick report.

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

Definition at line 19 of file QuickReport.h.

                                        {
            Unknown,
            InProgress,
            Failed,
            Successful
        };

Constructor & Destructor Documentation

CPPCli::QuickReport::QuickReport

(

VxSdk::IVxQuickReport *

vxQuickReport

)

Constructor.

Implements the clip class.

Parameters

vxQuickReport

The vx quick report.

Definition at line 6 of file QuickReport.cpp.

                                                                 {
    _report = vxQuickReport;
}

virtual CPPCli::QuickReport::~QuickReport ( )

inlinevirtual

Destructor.

Definition at line 39 of file QuickReport.h.

                               {
            this->!QuickReport();
        }

CPPCli::QuickReport::!QuickReport

(

)

Finaliser.

Definition at line 10 of file QuickReport.cpp.

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

Member Function Documentation

System::String CPPCli::QuickReport::_GetQuickReportEndpoint ( )

package

Definition at line 15 of file QuickReport.cpp.

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

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

CPPCli::QuickReport::ReportCreationStatus CPPCli::QuickReport::_GetStatus ( )

package

Definition at line 31 of file QuickReport.cpp.

                                                                    {
    // Get the status of the report
    VxSdk::VxReportCreationStatus::Value status;
    VxSdk::VxResult::Value result = _report->GetStatus(status);
    // Return the status if GetStatus was successful
    if (result == VxSdk::VxResult::kOK)
        return (CPPCli::QuickReport::ReportCreationStatus)status;

    return CPPCli::QuickReport::ReportCreationStatus::Unknown;
}

Member Data Documentation

VxSdk::IVxQuickReport* CPPCli::QuickReport::_report

package

Definition at line 68 of file QuickReport.h.

Property Documentation

System:: String^ CPPCli::QuickReport::QuickReportEndpoint

get

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

Returns

The quick report endpoint, if available.

Definition at line 53 of file QuickReport.h.

ReportCreationStatus CPPCli::QuickReport::Status

get

Gets the current status of generating the quick report.

The current quick report creation status.

Definition at line 62 of file QuickReport.h.

---

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

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