CPPCli::Marker Class Reference

The Marker class represents the location of a resource on a drawing. More...

#include <Marker.h>

Public Member Functions
	Marker (VxSdk::IVxMarker *vxMarker)
	Constructor. More...
virtual	~Marker ()
	Destructor. More...
	!Marker ()
	Finaliser. More...
Results::Value	DeleteAssociation ()
	Deletes the data source associated with this marker. More...
DataSource^	GetAssociation ()
	Gets the data source associated with this marker. More...
Results::Value	Refresh ()
	Refreshes this instances properties. More...
Results::Value	SetAssociation (DataSource^ dataSource)
	Sets the data source associated with this marker. More...
Results::Value	SetCoordinates (float x, float y)
	Sets the location of the marker on the associated drawing. More...

Package Functions
CPPCli::Drawing^	_GetDrawing ()

Package Attributes
VxSdk::IVxMarker *	_marker

Properties
float	Direction [get, set]
	Gets or sets the angular coordinate indicating the direction, if any, that the marker is facing on a polar grid(e.g.: 0 (right), 90 (up), 180 (left), 270 (down)). More...
Drawing^	Drawing [get]
	Gets the drawing that this marker belongs to. More...
System::String^	Id [get]
	Gets the unique marker identifier. More...
System::String^	Name [get, set]
	Gets or sets the friendly name of the marker. More...
float	X [get]
	Gets the X coordinate. More...
float	Y [get]
	Gets the Y coordinate. More...

Detailed Description

The Marker class represents the location of a resource on a drawing.

Definition at line 15 of file Marker.h.

Constructor & Destructor Documentation

CPPCli::Marker::Marker

(

VxSdk::IVxMarker *

vxMarker

)

Constructor.

Parameters

vxMarker

The vx Marker.

Definition at line 9 of file Marker.cpp.

                                             {
    _marker = vxMarker;
}

virtual CPPCli::Marker::~Marker ( )

inlinevirtual

Destructor.

Definition at line 27 of file Marker.h.

                          {
            this->!Marker();
        }

CPPCli::Marker::!Marker

(

)

Finaliser.

Definition at line 13 of file Marker.cpp.

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

Member Function Documentation

CPPCli::Drawing CPPCli::Marker::_GetDrawing ( )

package

Definition at line 49 of file Marker.cpp.

                                         {
    // Get the drawing
    VxSdk::IVxDrawing* drawing = nullptr;
    VxSdk::VxResult::Value result = _marker->GetDrawing(drawing);

    // Return the drawing if GetDrawing was successful
    if (result == VxSdk::VxResult::kOK)
        return gcnew CPPCli::Drawing(drawing);

    return nullptr;
}

CPPCli::Results::Value CPPCli::Marker::DeleteAssociation

(

)

Deletes the data source associated with this marker.

Returns

The Result of the request.

Definition at line 18 of file Marker.cpp.

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

CPPCli::DataSource CPPCli::Marker::GetAssociation

(

)

Gets the data source associated with this marker.

Returns

The associated data source if present, otherwise nullptr.

Definition at line 22 of file Marker.cpp.

                                               {
    // Get the data source
    VxSdk::IVxDataSource* dataSource = nullptr;
    VxSdk::VxResult::Value result = _marker->GetAssociation(dataSource);

    // Return the data source if GetAssociation was successful
    if (result == VxSdk::VxResult::kOK)
        return gcnew CPPCli::DataSource(dataSource);

    return nullptr;
}

CPPCli::Results::Value CPPCli::Marker::Refresh

(

)

Refreshes this instances properties.

Returns

The Result of updating the properties.

Definition at line 34 of file Marker.cpp.

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

CPPCli::Results::Value CPPCli::Marker::SetAssociation

(

DataSource^

dataSource

)

Sets the data source associated with this marker.

Parameters

dataSource

The data source to associate with this marker.

Returns

The Result of setting the property.

Definition at line 38 of file Marker.cpp.

                                                                      {
    // Make the call to set the associated data source
    VxSdk::VxResult::Value result = _marker->SetAssociation(*dataSource->_dataSource);
    // Unless there was an issue associating the data source the result should be VxSdk::VxResult::kOK
    return CPPCli::Results::Value(result);
}

CPPCli::Results::Value CPPCli::Marker::SetCoordinates	(	float	x,
		float	y
	)

Sets the location of the marker on the associated drawing.

Parameters

x	The X coordinate.
y	The Y coordinate.

Returns

The Result of setting the coordinates.

Definition at line 45 of file Marker.cpp.

                                                                {
    return (CPPCli::Results::Value)_marker->SetCoordinates(x, y);
}

Member Data Documentation

VxSdk::IVxMarker* CPPCli::Marker::_marker

package

Definition at line 131 of file Marker.h.

Property Documentation

float CPPCli::Marker::Direction

getset

Gets or sets the angular coordinate indicating the direction, if any, that the marker is facing on a polar grid(e.g.: 0 (right), 90 (up), 180 (left), 270 (down)).

The angular direction.

Definition at line 74 of file Marker.h.

Drawing^ CPPCli::Marker::Drawing

get

Gets the drawing that this marker belongs to.

The drawing that this marker belongs to.

Definition at line 84 of file Marker.h.

System:: String^ CPPCli::Marker::Id

get

Gets the unique marker identifier.

The unique identifier.

Definition at line 93 of file Marker.h.

System:: String^ CPPCli::Marker::Name

getset

Gets or sets the friendly name of the marker.

The friendly name of the marker.

Definition at line 102 of file Marker.h.

float CPPCli::Marker::X

get

Gets the X coordinate.

The X coordinate.

Definition at line 116 of file Marker.h.

float CPPCli::Marker::Y

get

Gets the Y coordinate.

The Y coordinate.

Definition at line 125 of file Marker.h.

---

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

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