SimScripts.state_variable.sv_properties Class Reference

Data structure with state variable properties. More...

Public Member Functions
def	__post_init__ (self)
	Data Check properties provided and set error and skip flags according with data provided: If no data is provided in for pub/sub or oldb we will skip it but will set the error flag if data is provided partially either for pubsub or oldb.

Public Attributes
	sv_entity
	pubsub_uri
	pubsub_key
	msg_pbsub
	skip_pubsub
	error_pubsub
	oldb_uris
	oldb_pub_period_ms
	msg_oldb
	skip_oldb
	error_oldb

Static Public Attributes
str	sv_entity = None
str	pubsub_uri = None
str	pubsub_key = None
int	pubsub_pub_period_ms = None
dict	oldb_uris = None
int	oldb_pub_period_ms = None
str	msg_pbsub = ""
bool	skip_pubsub = False
bool	error_pubsub = False
str	msg_oldb = ""
bool	skip_oldb = False
bool	error_oldb = False

Detailed Description

Data structure with state variable properties.

Parameters

sv_entity	entity classname (fully qualified), e.g. "ModCcsinsif.Ccsinsif.AltAz".
pubsub_uri	pub/sub uri to where we should be published or subscribed.
pubsub_key	the parameter to be used as key for a keyed topic, if None it is published as a keyless topic.
pubsub_pub_period_ms	Maximum periodicity (milliseconds) in which sv should be updated in pubsub channel.
oldb_uris	Dictionary with all Oldb uris for all parameters of state variable.
oldb_pub_period_ms	Maximum periodicity (milliseconds) in which sv should be updated in Oldb.

Member Function Documentation

__post_init__()

def SimScripts.state_variable.sv_properties.__post_init__

(

self

)

Data Check properties provided and set error and skip flags according with data provided: If no data is provided in for pub/sub or oldb we will skip it but will set the error flag if data is provided partially either for pubsub or oldb.

Member Data Documentation

error_oldb [1/2]

bool SimScripts.state_variable.sv_properties.error_oldb = False

static

error_oldb [2/2]

SimScripts.state_variable.sv_properties.error_oldb

error_pubsub [1/2]

bool SimScripts.state_variable.sv_properties.error_pubsub = False

static

error_pubsub [2/2]

SimScripts.state_variable.sv_properties.error_pubsub

msg_oldb [1/2]

str SimScripts.state_variable.sv_properties.msg_oldb = ""

static

msg_oldb [2/2]

SimScripts.state_variable.sv_properties.msg_oldb

msg_pbsub [1/2]

str SimScripts.state_variable.sv_properties.msg_pbsub = ""

static

msg_pbsub [2/2]

SimScripts.state_variable.sv_properties.msg_pbsub

oldb_pub_period_ms [1/2]

int SimScripts.state_variable.sv_properties.oldb_pub_period_ms = None

static

oldb_pub_period_ms [2/2]

SimScripts.state_variable.sv_properties.oldb_pub_period_ms

oldb_uris [1/2]

dict SimScripts.state_variable.sv_properties.oldb_uris = None

static

oldb_uris [2/2]

SimScripts.state_variable.sv_properties.oldb_uris

pubsub_key [1/2]

str SimScripts.state_variable.sv_properties.pubsub_key = None

static

pubsub_key [2/2]

SimScripts.state_variable.sv_properties.pubsub_key

pubsub_pub_period_ms

int SimScripts.state_variable.sv_properties.pubsub_pub_period_ms = None

static

pubsub_uri [1/2]

str SimScripts.state_variable.sv_properties.pubsub_uri = None

static

pubsub_uri [2/2]

SimScripts.state_variable.sv_properties.pubsub_uri

skip_oldb [1/2]

bool SimScripts.state_variable.sv_properties.skip_oldb = False

static

skip_oldb [2/2]

SimScripts.state_variable.sv_properties.skip_oldb

skip_pubsub [1/2]

bool SimScripts.state_variable.sv_properties.skip_pubsub = False

static

skip_pubsub [2/2]

SimScripts.state_variable.sv_properties.skip_pubsub

sv_entity [1/2]

str SimScripts.state_variable.sv_properties.sv_entity = None

static

sv_entity [2/2]

SimScripts.state_variable.sv_properties.sv_entity

---

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

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