CPPCli::Monitor Class Reference

The Monitor class represents a display for view data (typically video). More...

#include <Monitor.h>

Public Types
enum	Layouts {   Layouts::CellLayout1x1,   Layouts::CellLayout1x2,   Layouts::CellLayout2x1,   Layouts::CellLayout2x2,   Layouts::CellLayout2x3,   Layouts::CellLayout3x2,   Layouts::CellLayout3x3,   Layouts::CellLayout4x3,   Layouts::CellLayout4x4,   Layouts::CellLayout1plus12,   Layouts::CellLayout2plus8,   Layouts::CellLayout3plus4,   Layouts::CellLayout1plus5,   Layouts::CellLayout1plus7,   Layouts::CellLayout12plus1,   Layouts::CellLayout8plus2,   Layouts::CellLayout1plus4tall,   Layouts::CellLayout1plus4wide }
	Values that represent the layouts of a monitor. More...

Public Member Functions
	Monitor (VxSdk::IVxMonitor *vxMonitor)
	Constructor. More...
virtual	~Monitor ()
	Destructor. More...
	!Monitor ()
	Finaliser. More...
Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Functions
System::Collections::Generic::List< MonitorCell^ >^	_GetMonitorCells ()
System::Collections::Generic::List< CPPCli::Monitor::Layouts >^	_GetAvailableLayouts ()
CPPCli::Device^	_GetHostDevice ()

Package Attributes
VxSdk::IVxMonitor *	_monitor

Properties
System::Collections::Generic::List< CPPCli::Monitor::Layouts >^	AvailableLayouts [get]
	Gets the layouts available for this monitor. More...
CPPCli::Device^	HostDevice [get]
	Gets the device that hosts this monitor. More...
System::String^	Id [get]
	Gets the unique monitor identifier. More...
Layouts	Layout [get, set]
	Gets or sets the current layout for this monitor. More...
System::Collections::Generic::List< MonitorCell^ >^	MonitorCells [get]
	Gets the cells currently active on this monitor. More...
System::String^	Name [get, set]
	Gets or sets the friendly name of this monitor. More...
int	Number [get, set]
	Gets or sets the number used to designate this monitor. More...

Detailed Description

The Monitor class represents a display for view data (typically video).

Definition at line 15 of file Monitor.h.

Member Enumeration Documentation

enum CPPCli::Monitor::Layouts

strong

Values that represent the layouts of a monitor.

Enumerator
CellLayout1x1	A 1x1 monitor layout.
CellLayout1x2	A 1x2 monitor layout.
CellLayout2x1	A 2x1 monitor layout.
CellLayout2x2	A 2x2 monitor layout.
CellLayout2x3	A 2x3 monitor layout.
CellLayout3x2	A 3x2 monitor layout.
CellLayout3x3	A 3x3 monitor layout.
CellLayout4x3	A 4x3 monitor layout.
CellLayout4x4	A 4x4 monitor layout.
CellLayout1plus12	A 1 plus 12 monitor layout.
CellLayout2plus8	A 2 plus 8 monitor layout.
CellLayout3plus4	A 3 plus 4 monitor layout.
CellLayout1plus5	A 1 plus 5 monitor layout.
CellLayout1plus7	A 1 plus 7 monitor layout.
CellLayout12plus1	A 12 plus 1 monitor layout.
CellLayout8plus2	A 8 plus 2 monitor layout.
CellLayout1plus4tall	A 1 plus 4 tall monitor layout.
CellLayout1plus4wide	A 1 plus 4 wide monitor layout.

Definition at line 21 of file Monitor.h.

                           {
            CellLayout1x1,

            CellLayout1x2,

            CellLayout2x1,

            CellLayout2x2,

            CellLayout2x3,

            CellLayout3x2,

            CellLayout3x3,

            CellLayout4x3,

            CellLayout4x4,

            CellLayout1plus12,

            CellLayout2plus8,

            CellLayout3plus4,

            CellLayout1plus5,

            CellLayout1plus7,

            CellLayout12plus1,

            CellLayout8plus2,

            CellLayout1plus4tall,

            CellLayout1plus4wide
        };

Constructor & Destructor Documentation

CPPCli::Monitor::Monitor

(

VxSdk::IVxMonitor *

vxMonitor

)

Constructor.

Parameters

vxMonitor

The vx monitor.

Definition at line 10 of file Monitor.cpp.

                                                 {
    _monitor = vxMonitor;
}

virtual CPPCli::Monitor::~Monitor ( )

inlinevirtual

Destructor.

Definition at line 86 of file Monitor.h.

                           {
            this->!Monitor();
        }

CPPCli::Monitor::!Monitor

(

)

Finaliser.

Definition at line 14 of file Monitor.cpp.

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

Member Function Documentation

List< CPPCli::Monitor::Layouts > CPPCli::Monitor::_GetAvailableLayouts ( )

package

Definition at line 59 of file Monitor.cpp.

                                                                {
    // Create a list of managed layout objects
    List<CPPCli::Monitor::Layouts>^ mlist = gcnew List<CPPCli::Monitor::Layouts>();
    // Create a collection of unmanaged layout objects
    VxSdk::VxCollection<VxSdk::VxCellLayout::Value*> availableLayouts;

    // Make the call, which will return with the total count of available layouts, this allows the client to allocate memory.
    VxSdk::VxResult::Value result = _monitor->GetAvailableLayouts(availableLayouts);
    // Unless there are no available layouts for the monitor, this should return VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // An array of pointers is allocated using the size returned by the previous GetAvailableLayouts call
        availableLayouts.collection = new VxSdk::VxCellLayout::Value[availableLayouts.collectionSize];
        result = _monitor->GetAvailableLayouts(availableLayouts);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < availableLayouts.collectionSize; i++)
            {
                CPPCli::Monitor::Layouts limit = (CPPCli::Monitor::Layouts)availableLayouts.collection[i];
                mlist->Add(limit);
            }
        }
        // Remove the memory we previously allocated to the collection
        delete[] availableLayouts.collection;
    }
    return mlist;
}

CPPCli::Device CPPCli::Monitor::_GetHostDevice ( )

package

Definition at line 23 of file Monitor.cpp.

                                            {
    // Get the device which hosts this monitor
    VxSdk::IVxDevice* device = nullptr;
    VxSdk::VxResult::Value result = _monitor->GetHostDevice(device);

    // Return the device if GetHostDevice was successful
    if (result == VxSdk::VxResult::kOK)
        return gcnew Device(device);

    return nullptr;
}

List< CPPCli::MonitorCell^ > CPPCli::Monitor::_GetMonitorCells ( )

package

Definition at line 35 of file Monitor.cpp.

                                                          {
    // Create a list of managed monitor cell objects
    List<MonitorCell^>^ mlist = gcnew List<MonitorCell^>();
    // Create a collection of unmanaged monitor cell objects
    VxSdk::VxCollection<VxSdk::IVxMonitorCell**> monitorCells;

    // Make the call, which will return with the total count of monitor cells, this allows the client to allocate memory.
    VxSdk::VxResult::Value result = _monitor->GetMonitorCells(monitorCells);
    // Unless there are no monitor cells on the monitor, this should return VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // An array of pointers is allocated using the size returned by the previous GetMonitorCells call
        monitorCells.collection = new VxSdk::IVxMonitorCell*[monitorCells.collectionSize];
        result = _monitor->GetMonitorCells(monitorCells);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < monitorCells.collectionSize; i++)
                mlist->Add(gcnew CPPCli::MonitorCell(monitorCells.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] monitorCells.collection;
    }
    return mlist;
}

CPPCli::Results::Value CPPCli::Monitor::Refresh

(

)

Refreshes this instances properties.

Returns

The Result of updating the properties.

Definition at line 19 of file Monitor.cpp.

                                          {
    return (CPPCli::Results::Value)_monitor->Refresh();
}

Member Data Documentation

VxSdk::IVxMonitor* CPPCli::Monitor::_monitor

package

Definition at line 170 of file Monitor.h.

Property Documentation

System:: Collections:: Generic:: List< CPPCli:: Monitor:: Layouts>^ CPPCli::Monitor::AvailableLayouts

get

Gets the layouts available for this monitor.

A List of the available layouts.

Definition at line 105 of file Monitor.h.

CPPCli:: Device^ CPPCli::Monitor::HostDevice

get

Gets the device that hosts this monitor.

The host device.

Definition at line 114 of file Monitor.h.

System:: String^ CPPCli::Monitor::Id

get

Gets the unique monitor identifier.

The unique identifier.

Definition at line 123 of file Monitor.h.

Layouts CPPCli::Monitor::Layout

getset

Gets or sets the current layout for this monitor.

The cell layout.

Definition at line 132 of file Monitor.h.

System:: Collections:: Generic:: List< MonitorCell^>^ CPPCli::Monitor::MonitorCells

get

Gets the cells currently active on this monitor.

A List of the currently active cells.

Definition at line 142 of file Monitor.h.

System:: String^ CPPCli::Monitor::Name

getset

Gets or sets the friendly name of this monitor.

The friendly name.

Definition at line 151 of file Monitor.h.

int CPPCli::Monitor::Number

getset

Gets or sets the number used to designate this monitor.

The monitor number.

Definition at line 163 of file Monitor.h.

---

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

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