poi_manager_logic.PoI Class Reference

The actual individual poi is saved in this generic object. More...

Public Member Functions
def	__init__ (self, pos=None, name=None, key=None)
def	to_dict (self)
def	set_coords_in_sample (self, coords=None)
	Defines the position of the poi relative to the sample, allowing a sample map to be constructed. More...
def	add_position_to_history (self, position=None)
	Adds an explicitly known position+time to the history of the POI. More...
def	get_coords_in_sample (self)
	Returns the coordinates of the POI relative to the sample. More...
def	set_name (self, name=None)
	Sets the name of the poi. More...
def	get_name (self)
	Returns the name of the poi. More...
def	get_key (self)
	Returns the dictionary key of the poi. More...
def	get_position_history (self)
	Returns the whole position history as array. More...
def	delete_last_position (self, empty_array_completely=False)
	Delete the last position in the history. More...

Public Attributes
	log

Detailed Description

The actual individual poi is saved in this generic object.

Member Function Documentation

add_position_to_history()

def poi_manager_logic.PoI.add_position_to_history	(		self,
			position = None
	)

Adds an explicitly known position+time to the history of the POI.

Parameters

float[3]

position: position coordinates of the poi

Returns

int: error code (0:OK, -1:error)

delete_last_position()

def poi_manager_logic.PoI.delete_last_position	(		self,
			empty_array_completely = False
	)

Delete the last position in the history.

Parameters

bool	empty_array_completely: If _position_time_trace can be deleted completely this variable is set to True if not the last value will not be deleted

Returns

float[4]: the position just deleted.

get_coords_in_sample()

def poi_manager_logic.PoI.get_coords_in_sample

(

self

)

Returns the coordinates of the POI relative to the sample.

Returns

float[3]: the POI coordinates.

get_key()

def poi_manager_logic.PoI.get_key

(

self

)

Returns the dictionary key of the poi.

Returns

string: key

get_name()

def poi_manager_logic.PoI.get_name

(

self

)

Returns the name of the poi.

Returns

string: name

get_position_history()

def poi_manager_logic.PoI.get_position_history

(

self

)

Returns the whole position history as array.

Returns

float[][4]: the whole position history

set_coords_in_sample()

def poi_manager_logic.PoI.set_coords_in_sample	(		self,
			coords = None
	)

Defines the position of the poi relative to the sample, allowing a sample map to be constructed.

Once set, these "coordinates in sample" will not be altered unless the user wants to manually redefine this POI (for example, they put the POI in the wrong place).

Parameters

float[3]

coords: relative position of poi in sample

set_name()

def poi_manager_logic.PoI.set_name	(		self,
			name = None
	)

Sets the name of the poi.

Parameters

string

name: name to be set.

Returns

int: error code (0:OK, -1:error)

---

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

• logic/poi_manager_logic.py