VxSdk::IVxMonitor Struct Reference

Represents a display for view data (typically video). More...

#include <IVxMonitor.h>

Public Member Functions
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...
virtual VxResult::Value	GetAvailableLayouts (VxCollection< VxCellLayout::Value * > &layoutCollection) const =0
	Gets the layouts available for this monitor. More...
virtual VxResult::Value	GetHostDevice (IVxDevice *&hostDevice) const =0
	Gets the host device of this monitor. More...
virtual VxResult::Value	GetMonitorCells (VxCollection< IVxMonitorCell ** > &cellCollection)=0
	Gets the cells currently active on this monitor. More...
virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...
virtual VxResult::Value	RemoveMonitor () const =0
	Deletes this monitor from the VideoXpert system. More...
virtual VxResult::Value	SetLayout (VxCellLayout::Value layout)=0
	Sets the layout property. More...
virtual VxResult::Value	SetName (char name[64])=0
	Sets the name property. More...
virtual VxResult::Value	SetNumber (int number)=0
	Sets the number property. More...

Public Attributes
char	id [64]
	The unique identifier of the monitor. More...
char	name [64]
	The friendly name of this monitor. More...
int	number
	The number used to designate the monitor. More...
VxCellLayout::Value	layout
	The cell grid layout. More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

Represents a display for view data (typically video).

Definition at line 18 of file IVxMonitor.h.

Member Function Documentation

void VxSdk::IVxMonitor::Clear ( )

inlineprotected

Clears this instance.

Definition at line 94 of file IVxMonitor.h.

                     {
            VxZeroArray(this->id);
            VxZeroArray(this->name);
            this->number = 0;
            this->layout = VxCellLayout::Value::k1x1;
        }

virtual VxResult::Value VxSdk::IVxMonitor::Delete ( ) const

pure virtual

Deletes this instance.

Returns

The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxMonitor::GetAvailableLayouts ( VxCollection< VxCellLayout::Value * > &  layoutCollection ) const

pure virtual

Gets the layouts available for this monitor.

Parameters

layoutCollection

A VxCollection of the available layouts.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxMonitor::GetHostDevice ( IVxDevice *&  hostDevice ) const

pure virtual

Gets the host device of this monitor.

Parameters

hostDevice

The host IVxDevice.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxMonitor::GetMonitorCells ( VxCollection< IVxMonitorCell ** > &  cellCollection )

pure virtual

Gets the cells currently active on this monitor.

Parameters

cellCollection

A VxCollection of the active monitor cells.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxMonitor::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns

The Result of refreshing the member values for this object.

virtual VxResult::Value VxSdk::IVxMonitor::RemoveMonitor ( ) const

pure virtual

Deletes this monitor from the VideoXpert system.

Returns

The Result of deleting the monitor.

virtual VxResult::Value VxSdk::IVxMonitor::SetLayout ( VxCellLayout::Value  layout )

pure virtual

Sets the layout property.

Parameters

layout

The new layout value.

Returns

The Result of setting the property.

virtual VxResult::Value VxSdk::IVxMonitor::SetName ( char  name[64] )

pure virtual

Sets the name property.

Parameters

name	The new name value.

Returns

The Result of setting the property.

virtual VxResult::Value VxSdk::IVxMonitor::SetNumber ( int  number )

pure virtual

Sets the number property.

Parameters

number

The new number value.

Returns

The Result of setting the property.

Member Data Documentation

char VxSdk::IVxMonitor::id[64]

The unique identifier of the monitor.

Definition at line 76 of file IVxMonitor.h.

VxCellLayout::Value VxSdk::IVxMonitor::layout

The cell grid layout.

Definition at line 88 of file IVxMonitor.h.

char VxSdk::IVxMonitor::name[64]

The friendly name of this monitor.

Definition at line 80 of file IVxMonitor.h.

int VxSdk::IVxMonitor::number

The number used to designate the monitor.

Definition at line 84 of file IVxMonitor.h.

---

The documentation for this struct was generated from the following file:

• C:/Git/VXSDK_M3/VxSdk/Include/IVxMonitor.h