mcstasscript.data.pyvinylData.pyvinylMCPLData¶

class mcstasscript.data.pyvinylData.pyvinylMCPLData(key, data_dict=None, filename='none', file_format_class=None, file_format_kwargs=None)¶

__init__(key, data_dict=None, filename='none', file_format_class=None, file_format_kwargs=None)¶

Methods

`__init__`(key[, data_dict, filename, ...])
`from_dict`(data_dict, key)	Create a Data Object mapping a data dict.
`from_file`(filename[, key])	Create a Data Object mapping a file.
`get_data`()	Return the data in a dictionary
`list_formats`()	Print supported formats
`set_dict`(data_dict)	Set a mapping dict for this DataClass.
`set_file`(filename, format_class, **kwargs)	Set a mapping file for this DataClass.
`supported_formats`()
`write`(filename, format_class[, key])	Write the data mapped by the Data Object into a file and return a Data Object mapping the file.

Attributes

`data_dict`	The data_dict of the class instance for calculator usage
`expected_data`	The expected_data of the class instance for calculator usage
`file_format_class`	The FormatClass to map the file by this DataClass
`file_format_kwargs`	The kwargs needed to map the file
`filename`	The filename of the file to map by this DataClass.
`key`	The key of the class instance for calculator usage
`mapping_content`	Returns an overview of the keys of the mapped dict or the filename of the mapped file
`mapping_type`	If this data class is a file mapping or python dict mapping.

classmethod from_file(filename: str, key='mcpl')¶

Create a Data Object mapping a file.

Parameters

filename (str, optional) – The filename of the file to map by this DataClass. It has to be None if a dict mapping was already set, defaults to None.
file_format_class (class, optional) – The FormatClass to map the file by this DataClass, It has to be None if a dict mapping was already set, defaults to None
file_format_kwargs (dict, optional) – The kwargs needed to map the file, defaults to None.
key (str) – The key to identify the Data Object.

Returns

A Data Object

Return type

BaseData

McStasScript documentation

mcstasscript.data.pyvinylData.pyvinylMCPLData

mcstasscript.data.pyvinylData.pyvinylMCPLData¶