VxSdk::IVxDrawing Struct Reference

Represents a diagrammatic representation of an area. A drawing may contain any number of markers to represent points of interest within the area. More...

#include <IVxDrawing.h>

Public Member Functions
virtual VxResult::Value	AddMarker (VxNewMarker &newMarker) const =0
	Creates a new marker. More...
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...
virtual VxResult::Value	DeleteDrawing () const =0
	Delete this drawing from the VideoXpert system. More...
virtual VxResult::Value	DeleteImage () const =0
	Deletes the binary drawing image data. More...
virtual VxResult::Value	GetImage (char *endpoint, int &size) const =0
	Gets the binary image data, if any. More...
virtual VxResult::Value	GetMarkers (VxCollection< IVxMarker ** > &markerCollection) const =0
	Gets the markers contained within this drawing. More...
virtual VxResult::Value	GetLock (IVxResourceLock *&resourceLock) const =0
	Gets the resource lock, if any. 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	SetImage (char *imagePath) const =0
	Sets the binary drawing image data. The maximum allowable size of the image is 128 MB. More...
virtual VxResult::Value	SetLock () const =0
	Sets a resource lock on this drawing, owned by the current user. More...
virtual VxResult::Value	SetName (char name[64])=0
	Sets the name property. More...

Public Attributes
char	id [64]
	The unique identifier of the drawing. More...
char	name [64]
	The friendly name of the drawing. More...

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

Detailed Description

Represents a diagrammatic representation of an area. A drawing may contain any number of markers to represent points of interest within the area.

Definition at line 17 of file IVxDrawing.h.

Member Function Documentation

virtual VxResult::Value VxSdk::IVxDrawing::AddMarker ( VxNewMarker &  newMarker ) const

pure virtual

Creates a new marker.

Parameters

newMarker

The new marker to be added.

Returns

The Result of the request.

void VxSdk::IVxDrawing::Clear ( )

inlineprotected

Clears this instance.

Definition at line 97 of file IVxDrawing.h.

                     {
            VxZeroArray(this->id);
            VxZeroArray(this->name);
        }

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

pure virtual

Deletes this instance.

Returns

The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxDrawing::DeleteDrawing ( ) const

pure virtual

Delete this drawing from the VideoXpert system.

Returns

The Result of deleting the Drawing.

virtual VxResult::Value VxSdk::IVxDrawing::DeleteImage ( ) const

pure virtual

Deletes the binary drawing image data.

Returns

The Result of deleting the Drawing.

virtual VxResult::Value VxSdk::IVxDrawing::GetImage ( char *  endpoint, int &  size  ) const

pure virtual

Gets the binary image data, if any.

Parameters

endpoint	The image endpoint.
size	The size of endpoint .

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxDrawing::GetLock ( IVxResourceLock *&  resourceLock ) const

pure virtual

Gets the resource lock, if any.

Parameters

resourceLock

The current resource lock if present.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxDrawing::GetMarkers ( VxCollection< IVxMarker ** > &  markerCollection ) const

pure virtual

Gets the markers contained within this drawing.

Available filters: kModifiedSince, kResourceId.

Parameters

markerCollection

A VxCollection of the associated markers.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxDrawing::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::IVxDrawing::SetImage ( char *  imagePath ) const

pure virtual

Sets the binary drawing image data. The maximum allowable size of the image is 128 MB.

Parameters

imagePath

The local path to the image file.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxDrawing::SetLock ( ) const

pure virtual

Sets a resource lock on this drawing, owned by the current user.

Returns

The Result of the request.

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

pure virtual

Sets the name property.

Parameters

name	The new name value.

Returns

The Result of setting the property.

Member Data Documentation

char VxSdk::IVxDrawing::id[64]

The unique identifier of the drawing.

Definition at line 87 of file IVxDrawing.h.

char VxSdk::IVxDrawing::name[64]

The friendly name of the drawing.

Definition at line 91 of file IVxDrawing.h.

---

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

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