utils.named_positions_helper.NamedPositionsHelper Class Reference

Structure that help decode and encode a datapoint value with a yaml string It uses the CiiConfigDocument and CiiConfigng to do the convertion between yaml string value and a python list with the a group of the telescope named posistions. More...

Public Member Functions
def	__init__ (self, str name, float altitude, float azimuth)
	Constructor.
def	__repr__ (self)
	String representation of NamedPositionsHelper.

Static Public Member Functions
def	convert_to_dict (instance)
	Converter to convert value of instance to python object (map) that can be converted into config-ng node hirearchy.
def	node_to_instance (CiiConfigNode node)
	Convert document node in to python object NamedPositionsHelper.
def	decode_from_configng (str configuration_string)
	Returns a python list of dictionary with information based on the datapoint yaml string value.

Protected Attributes
	_name
	_altitude
	_azimuth

Detailed Description

Structure that help decode and encode a datapoint value with a yaml string It uses the CiiConfigDocument and CiiConfigng to do the convertion between yaml string value and a python list with the a group of the telescope named posistions.

Constructor & Destructor Documentation

__init__()

def utils.named_positions_helper.NamedPositionsHelper.__init__	(		self,
		str	name,
		float	altitude,
		float	azimuth
	)

Constructor.

Parameters

name	Position string name from Configng document
altitude	Altitude position value from Configng document
azimuth	Azimuth position value from Configng document

Member Function Documentation

__repr__()

def utils.named_positions_helper.NamedPositionsHelper.__repr__

(

self

)

String representation of NamedPositionsHelper.

convert_to_dict()

def utils.named_positions_helper.NamedPositionsHelper.convert_to_dict (   instance )

static

Converter to convert value of instance to python object (map) that can be converted into config-ng node hirearchy.

Parameters

instance

NamedPositionsHelper class to be convert in to a dictionary

Returns

Python dict representing value of the instance

decode_from_configng()

def utils.named_positions_helper.NamedPositionsHelper.decode_from_configng ( str  configuration_string )

static

Returns a python list of dictionary with information based on the datapoint yaml string value.

Parameters

configuration_string

yaml string from a datapoint value or file

Returns

Dictionary with readable NamedPositionsHelper

node_to_instance()

def utils.named_positions_helper.NamedPositionsHelper.node_to_instance ( CiiConfigNode  node )

static

Convert document node in to python object NamedPositionsHelper.

Parameters

node	Document node given by CiiConfigng

Returns

Instance of NamedPositionsHelper

Member Data Documentation

_altitude

utils.named_positions_helper.NamedPositionsHelper._altitude

protected

_azimuth

utils.named_positions_helper.NamedPositionsHelper._azimuth

protected

_name

utils.named_positions_helper.NamedPositionsHelper._name

protected

---

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

• common/python/src/hlcc/utils/named_positions_helper.py