Represents the location of a resource on a drawing. A marker is associated with exactly one drawing, though a drawing may have many markers. A marker may be associated with one resource, though a resource may have many markers. More...

#include <IVxMarker.h>

Public Member Functions
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...

virtual VxResult::Value	DeleteAssociation () const =0
	Deletes any resource association with this marker. More...

virtual VxResult::Value	DeleteMarker () const =0
	Deletes this marker from the VideoXpert system. More...

virtual VxResult::Value	GetAssociation (IVxDataSource *&dataSource) const =0
	Gets the data source associated with this marker. More...

virtual VxResult::Value	GetDrawing (IVxDrawing *&drawing) const =0
	Gets the drawing that this marker belongs to. 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	SetAssociation (IVxDataSource &dataSource)=0
	Sets the data source associated with this marker. More...

virtual VxResult::Value	SetDirection (float direction)=0
	Sets the angular coordinate indicating the direction that the marker is facing on a polar grid (e.g.: 0 (right), 90 (up), 180 (left), 270 (down)). More...

virtual VxResult::Value	SetName (char name[64])=0
	Sets the name property. More...

virtual VxResult::Value	SetCoordinates (float x, float y)=0
	Sets the location of the marker on the associated drawing. More...

Public Attributes
char	id [64]
	The unique identifier of the marker. More...

char	name [64]
	The friendly name of the marker. More...

float	direction
	The the angular coordinate indicating the direction that the marker is facing. More...

float	x
	The X coordinate. More...

float	y
	The Y coordinate. More...

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

Detailed Description

Represents the location of a resource on a drawing. A marker is associated with exactly one drawing, though a drawing may have many markers. A marker may be associated with one resource, though a resource may have many markers.

Definition at line 16 of file IVxMarker.h.

Member Function Documentation

void VxSdk::IVxMarker::Clear ( )

inlineprotected

Clears this instance.

Definition at line 103 of file IVxMarker.h.

                      {
             VxZeroArray(this->id);
             VxZeroArray(this->name);
             this->direction = 0;
             this->x = 0;
             this->y = 0;
         }

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

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxMarker::DeleteAssociation ( ) const

pure virtual

Deletes any resource association with this marker.

Returns: The Result of deleting the marker.

virtual VxResult::Value VxSdk::IVxMarker::DeleteMarker ( ) const

pure virtual

Deletes this marker from the VideoXpert system.

Returns: The Result of deleting the marker.

virtual VxResult::Value VxSdk::IVxMarker::GetAssociation ( IVxDataSource *& dataSource ) const

pure virtual

Gets the data source associated with this marker.

Parameters

dataSource The associated data source.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxMarker::GetDrawing ( IVxDrawing *& drawing ) const

pure virtual

Gets the drawing that this marker belongs to.

Parameters

drawing The drawing this marker belongs to.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxMarker::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::IVxMarker::SetAssociation ( IVxDataSource & dataSource )

pure virtual

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.

virtual VxResult::Value VxSdk::IVxMarker::SetCoordinates	(	float	x,
		float	y
	)

pure virtual

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.

virtual VxResult::Value VxSdk::IVxMarker::SetDirection ( float direction )

pure virtual

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

Parameters

direction The direction.

Returns: The Result of setting the direction.

virtual VxResult::Value VxSdk::IVxMarker::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

float VxSdk::IVxMarker::direction

The the angular coordinate indicating the direction that the marker is facing.

Definition at line 89 of file IVxMarker.h.

char VxSdk::IVxMarker::id[64]

The unique identifier of the marker.

Definition at line 81 of file IVxMarker.h.

char VxSdk::IVxMarker::name[64]

The friendly name of the marker.

Definition at line 85 of file IVxMarker.h.

float VxSdk::IVxMarker::x

The X coordinate.

Definition at line 93 of file IVxMarker.h.

float VxSdk::IVxMarker::y

The Y coordinate.

Definition at line 97 of file IVxMarker.h.

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

C:/Git/VXSDK_M3/VxSdk/Include/IVxMarker.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation