The Drawing class 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 <Drawing.h>

Public Member Functions
	Drawing (VxSdk::IVxDrawing *vxDrawing)
	Constructor. More...

virtual	~Drawing ()
	Destructor. More...

	!Drawing ()
	Finaliser. More...

Results::Value	AddMarker (NewMarker^ newMarker)
	Creates a new marker. More...

Results::Value	DeleteImage ()
	Deletes the binary drawing image data. More...

Results::Value	DeleteLock ()
	Deletes the resource lock, if any. More...

Results::Value	DeleteMarker (Marker^ marker)
	Deletes a marker. More...

System::String^	GetImageUri ()
	Gets the image uri, if any. More...

ResourceLock^	GetLock ()
	Gets the resource lock, if any. More...

Results::Value	Refresh ()
	Refreshes this instances properties. More...

Results::Value	SetImage (System::String^ imagePath)
	Sets the binary drawing image data. The maximum allowable size of the image is 128 MB. Supported file types are DWG, JPG and PNG. More...

Results::Value	SetLock ()
	Sets a resource lock on this drawing, owned by the current user. More...

Package Functions
System::Collections::Generic::List< Marker^ >^	_GetMarkers ()

Package Attributes
VxSdk::IVxDrawing *	_drawing

Properties
System::String^	Id `[get]`
	Gets the unique drawing identifier. More...

System::Collections::Generic::List< Marker^ >^	Markers `[get]`
	Gets the markers associated with this drawing. More...

System::String^	Name `[get, set]`
	Gets or sets the friendly name. More...

Detailed Description

The Drawing class 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 Drawing.h.

Constructor & Destructor Documentation

CPPCli::Drawing::Drawing ( VxSdk::IVxDrawing * vxDrawing )

Constructor.

Parameters

vxDrawing The vx Drawing.

Definition at line 8 of file Drawing.cpp.

                                                  {
     _drawing = vxDrawing;
 }

virtual CPPCli::Drawing::~Drawing ( )

inlinevirtual

Destructor.

Definition at line 29 of file Drawing.h.

                            {
             this->!Drawing();
         }

CPPCli::Drawing::!Drawing ( )

Finaliser.

Definition at line 12 of file Drawing.cpp.

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

Member Function Documentation

System::Collections::Generic::List< CPPCli::Marker^ > CPPCli::Drawing::_GetMarkers ( )

package

Definition at line 98 of file Drawing.cpp.

                                                                         {
     // Create a list of managed marker objects
     List<CPPCli::Marker^>^ mlist = gcnew List<CPPCli::Marker^>();
     // Create a collection of unmanaged marker objects
     VxSdk::VxCollection<VxSdk::IVxMarker**> markers;
 
     // Make the GetMarkers call, which will return with the total marker count, this allows the client to allocate memory.
     VxSdk::VxResult::Value result = _drawing->GetMarkers(markers);
     // Unless there are no markers on the system, this should return VxSdk::VxResult::kInsufficientSize
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // Allocate enough space for the IVxMarker collection
         markers.collection = new VxSdk::IVxMarker*[markers.collectionSize];
         result = _drawing->GetMarkers(markers);
         // The result should now be kOK since we have allocated enough space
         if (result == VxSdk::VxResult::kOK) {
             for (int i = 0; i < markers.collectionSize; i++)
                 mlist->Add(gcnew CPPCli::Marker(markers.collection[i]));
         }
         // Remove the memory we previously allocated to the collection
         delete[] markers.collection;
     }
     return mlist;
 }

CPPCli::Results::Value CPPCli::Drawing::AddMarker ( NewMarker^ newMarker )

Creates a new marker.

Parameters

newMarker The new marker to be added.

Returns: The Result of the request.

Definition at line 17 of file Drawing.cpp.

                                                                 {
     // Create a new marker object and populate its fields using newMarker
     VxSdk::VxNewMarker vxNewMarker;
     VxSdk::Utilities::StrCopySafe(vxNewMarker.associatedDataSourceId, Utils::ConvertSysString(newMarker->AssociatedDataSourceId));
     VxSdk::Utilities::StrCopySafe(vxNewMarker.name, Utils::ConvertSysString(newMarker->Name));
     vxNewMarker.direction = newMarker->Direction;
     vxNewMarker.x = newMarker->X;
     vxNewMarker.y = newMarker->Y;
 
     // Make the call to add the marker to the drawing
     VxSdk::VxResult::Value result = _drawing->AddMarker(vxNewMarker);
     // Unless there was an issue creating the marker the result should be VxSdk::VxResult::kOK
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::Drawing::DeleteImage ( )

Deletes the binary drawing image data.

Returns: The Result of deleting the image.

Definition at line 32 of file Drawing.cpp.

                                               {
     return (CPPCli::Results::Value)_drawing->DeleteImage();
 }

CPPCli::Results::Value CPPCli::Drawing::DeleteLock ( )

Deletes the resource lock, if any.

Returns: The Result of deleting the lock.

Definition at line 36 of file Drawing.cpp.

                                              {
     // Get the lock for this drawing
     VxSdk::IVxResourceLock* lock = nullptr;
     VxSdk::VxResult::Value result = _drawing->GetLock(lock);
 
     // Delete the lock if present
     if (result == VxSdk::VxResult::kOK && lock != nullptr)
         return (CPPCli::Results::Value)lock->DeleteResourceLock();
 
     return (CPPCli::Results::Value)result;
 }

CPPCli::Results::Value CPPCli::Drawing::DeleteMarker ( Marker^ marker )

Deletes a marker.

Parameters

marker The marker to be deleted.

Returns: The Result of the request.

Definition at line 48 of file Drawing.cpp.

                                                              {
     return (CPPCli::Results::Value)marker->_marker->DeleteMarker();
 }

System::String CPPCli::Drawing::GetImageUri ( )

Gets the image uri, if any.

Returns: The the image uri.

Definition at line 52 of file Drawing.cpp.

                                          {
     char* imageEndpoint = nullptr;
     int size = 0;
 
     // If the rtsp uri is not available on the datasource the result will return VxSdk::VxResult::kActionUnavailable,
     // otherwise VxSdk::VxResult::kInsufficientSize
     VxSdk::VxResult::Value result = _drawing->GetImage(imageEndpoint, size);
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // Allocate enough space for rtspEndpoint
         imageEndpoint = new char[size];
         // The result should now be kOK since we have allocated enough space
         _drawing->GetImage(imageEndpoint, size);
     }
     return gcnew System::String(imageEndpoint);
 }

CPPCli::ResourceLock CPPCli::Drawing::GetLock ( )

Gets the resource lock, if any.

Returns: The Result of the request.

Definition at line 68 of file Drawing.cpp.

                                            {
     // Get the lock for this drawing
     VxSdk::IVxResourceLock* lock = nullptr;
     VxSdk::VxResult::Value result = _drawing->GetLock(lock);
 
     // Return the lock if present
     if (result == VxSdk::VxResult::kOK && lock != nullptr)
         return gcnew CPPCli::ResourceLock(lock);
 
     return nullptr;
 }

CPPCli::Results::Value CPPCli::Drawing::Refresh ( )

Refreshes this instances properties.

Returns: The Result of updating the properties.

Definition at line 80 of file Drawing.cpp.

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

CPPCli::Results::Value CPPCli::Drawing::SetImage ( System::String^ imagePath )

Sets the binary drawing image data. The maximum allowable size of the image is 128 MB. Supported file types are DWG, JPG and PNG.

Parameters

imagePath The local path to the image file.

Returns: The Result of the request.

Definition at line 84 of file Drawing.cpp.

                                                                   {
     // Copy the image path to a new char
     int len = imagePath->Length + 1;
     char* image = new char[len];
     VxSdk::Utilities::StrCopySafe(image, Utils::ConvertSysString(imagePath), len);
 
     // Set the image path
     return (CPPCli::Results::Value)_drawing->SetImage(image);
 }

CPPCli::Results::Value CPPCli::Drawing::SetLock ( )

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

Returns: The Result of the request.

Definition at line 94 of file Drawing.cpp.

                                           {
     return (CPPCli::Results::Value)_drawing->SetLock();
 }

Member Data Documentation

VxSdk::IVxDrawing* CPPCli::Drawing::_drawing

package

Definition at line 129 of file Drawing.h.

Property Documentation

System:: String^ CPPCli::Drawing::Id

get

Gets the unique drawing identifier.

The unique identifier.

Definition at line 100 of file Drawing.h.

System:: Collections:: Generic:: List< Marker^>^ CPPCli::Drawing::Markers

get

Gets the markers associated with this drawing.

A List of the associated markers.

Definition at line 109 of file Drawing.h.

System:: String^ CPPCli::Drawing::Name

getset

Gets or sets the friendly name.

The friendly name.

Definition at line 118 of file Drawing.h.

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

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

Public Member Functions

Package Functions

Package Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation