SimScripts.m2m3_estimation.m2m3_estimation Class Reference

Top level CCS state estimation. More...

Public Member Functions
def	__init__ (self, p_sv_name, p_configuration)
	CcsStateEstimation Class Initializer.
def	dds_uri_refactor_domain (self, str dds_uri_generic, domain)
	Refactors the dds uri to contain the hlcc internal domain.
def	yaml_string_to_dictionary (self, str yaml_str)
	Convert a string containing data in yaml format to a python dictionary.
def	get_current_sv_configuration (self)
	Retrieve the configuration for the current state variable executed by this instance.
def	configure_logging (self, logger_name)
	Set the log level to be close to the one set in C++ Maps C++ log4cpp log levels to python log levels.
def	Execute (self, arg, iteration_start_timestamp_ms)
	Perform Ccs global state Estimation.
def	Terminate (self, arg)
	Set the correct Ccs state when the telmon application is about to exit.
def	state_estimation (self, comm=False, remote=False, poweron=False, initialized=False, closedloop=False, moving=False)
	Estimate the operational state of the Position Stage subsystem function.

Public Attributes
	sv_name
	configuration
	oldb_last_publishing
	whole_config
	last_decoded_sv_specific_config
	sv_m2ps
	exec_stats
	logger

Detailed Description

Top level CCS state estimation.

Constructor & Destructor Documentation

__init__()

def SimScripts.m2m3_estimation.m2m3_estimation.__init__	(		self,
			p_sv_name,
			p_configuration
	)

CcsStateEstimation Class Initializer.

Parameters

Dictionary

with Application configuration

Member Function Documentation

configure_logging()

def SimScripts.m2m3_estimation.m2m3_estimation.configure_logging	(		self,
			logger_name
	)

Set the log level to be close to the one set in C++ Maps C++ log4cpp log levels to python log levels.

dds_uri_refactor_domain()

def SimScripts.m2m3_estimation.m2m3_estimation.dds_uri_refactor_domain	(		self,
		str	dds_uri_generic,
			domain
	)

Refactors the dds uri to contain the hlcc internal domain.

Execute()

def SimScripts.m2m3_estimation.m2m3_estimation.Execute	(		self,
			arg,
			iteration_start_timestamp_ms
	)

Perform Ccs global state Estimation.

Parameters

arg	Shared dictionary with all python scripts being executed and c++ side
iteration_start_timestamp_ms	timestamp in ms of current iteration start

get_current_sv_configuration()

def SimScripts.m2m3_estimation.m2m3_estimation.get_current_sv_configuration

(

self

)

Retrieve the configuration for the current state variable executed by this instance.

state_estimation()

def SimScripts.m2m3_estimation.m2m3_estimation.state_estimation	(		self,
			comm = False,
			remote = False,
			poweron = False,
			initialized = False,
			closedloop = False,
			moving = False
	)

Estimate the operational state of the Position Stage subsystem function.

Parameters

[in]	comm	True if communication with LCS is possible, false otherwise.
[in]	remote	True if LCS is in remote mode, false otherwise.
[in]	poweron	True if PS is powered on, false otherwise.
[in]	initialized	True if PS is initialized, false otherwise.
[in]	closedloop	True if PS control loop is closed, false otherwise.
[in]	moving	True if PS is moving, false otherwise.

Terminate()

def SimScripts.m2m3_estimation.m2m3_estimation.Terminate	(		self,
			arg
	)

Set the correct Ccs state when the telmon application is about to exit.

yaml_string_to_dictionary()

def SimScripts.m2m3_estimation.m2m3_estimation.yaml_string_to_dictionary	(		self,
		str	yaml_str
	)

Convert a string containing data in yaml format to a python dictionary.

Member Data Documentation

configuration

SimScripts.m2m3_estimation.m2m3_estimation.configuration

exec_stats

SimScripts.m2m3_estimation.m2m3_estimation.exec_stats

last_decoded_sv_specific_config

SimScripts.m2m3_estimation.m2m3_estimation.last_decoded_sv_specific_config

logger

SimScripts.m2m3_estimation.m2m3_estimation.logger

oldb_last_publishing

SimScripts.m2m3_estimation.m2m3_estimation.oldb_last_publishing

sv_m2ps

SimScripts.m2m3_estimation.m2m3_estimation.sv_m2ps

sv_name

SimScripts.m2m3_estimation.m2m3_estimation.sv_name

whole_config

SimScripts.m2m3_estimation.m2m3_estimation.whole_config

---

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

• lsvsim/simulationscripts/simScripts/src/hlcc/SimScripts/m2m3_estimation.py