roxieapi.input.builder module

class roxieapi.input.builder.RoxieInputBuilder

Bases: object

Class RoxieInputBuilder builds a ROXIE input

DEFAULT_FLAGS = {'LALGO': False, 'LANS2RX': False, 'LANSYS': False, 'LANSYSCN': False, 'LAXIS': False, 'LAYER': False, 'LBEMFEM': False, 'LBRICK': False, 'LCATIA': False, 'LCNC': False, 'LDXF': False, 'LEDDY': False, 'LEND': False, 'LEULER': False, 'LEXEL': False, 'LEXPR': False, 'LF3LIN': False, 'LFIELD3': False, 'LFIL2D': False, 'LFIL3D': False, 'LFLUX': False, 'LFORCE2D': False, 'LGRAPHCSV': False, 'LHARD': False, 'LHARM': False, 'LHEAD': False, 'LHMO': False, 'LICC': False, 'LICCA': False, 'LICCIND': False, 'LIFF': False, 'LIMAGX': False, 'LIMAGY': False, 'LIMAGZZ': False, 'LINDU': False, 'LINMARG': False, 'LIRON': False, 'LITERNL': False, 'LKVAL': False, 'LLEAD': False, 'LMAP2D': False, 'LMAP3D': False, 'LMARG': False, 'LMARKER': False, 'LMATRF': False, 'LMIRIRON': False, 'LMORPH': False, 'LMQE': False, 'LOPER20': False, 'LOPERA': False, 'LPEAK': False, 'LPERS': False, 'LPLOT': False, 'LPOSTP': False, 'LPSI': False, 'LQUEN3': False, 'LQUENCH': False, 'LQUENCH0D': False, 'LQUNPLOT': False, 'LQVOLT': False, 'LRAEND': False, 'LROLER2': False, 'LROLERP': False, 'LRX2ANS': False, 'LSELF': False, 'LSELF3': False, 'LSKIPDPL': False, 'LSKIPTPL': False, 'LSOLE': False, 'LSOLV': False, 'LSTEP': False, 'LSUPP': False, 'LTOPO': False, 'LVERS52': False, 'LVRML': False, 'LWEDG': False, 'LWEIRON': False}

DEFAULT_VERSION = '23.9.0'

build(output_path: Path) → None

Method building a ROXIE input based on a template file :param output_path: an output path for the input .data file

static convert_flag_dct_to_str(flags: dict) → str

Static method converting a dictionary with flags into a formatted string :param flags: a dictionary with flags :return: a formatted string representation of the dictionary with flags

static from_datafile(filename)

Constructs a RoxieInputBuilder, initializing its values from a .data file :param filename: The .data file :return a constructed RoxieInputBuilder object

prepare_data_file_str_from_template() → str

set_flag(flag_name: str, flag_value: bool) → RoxieInputBuilder

Method setting a flag in a ROXIE input file. An error is thrown if a flag does not exist :param flag_name: name of a flag :param flag_value: value of a flag :return: an updated RoxieInputBuilder instance

update_version()