ResultFileDefinition

class ase2sprkkr.result_files.result_files_definitions.ResultFileDefinition(name, members=[], written_name=None, info=None, description=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, has_hidden_members=False, name_in_grammar=None, force_order=None, name_regex=False, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=False, write_condition=None, warning_condition=None, validators=())[source]

This class describes the format of one structure of a structured result file

Class hierarchy

Inheritance diagram of ase2sprkkr.result_files.result_files_definitions.ResultFileDefinition


Constructor

Parameters:

validators (Callable[[Any, Any, str], Any] | Iterable[Callable[[Any, Any, str], Any]] | None)

__init__(name, members=[], written_name=None, info=None, description=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, has_hidden_members=False, name_in_grammar=None, force_order=None, name_regex=False, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=False, write_condition=None, warning_condition=None, validators=())
Parameters:

validators (Callable[[Any, Any, str], Any] | Iterable[Callable[[Any, Any, str], Any]] | None)

force_order = True

The order of items in a result file is fixed

value_name_format = '{:<12}'

The (print) format, how the name is written

child_class

standard child class

alias of ase2sprkkr.result_files.result_files_definitions.ResultFileValueDefinition

custom_class = None

No custom members in the result files

delimiter

Options are delimited by newlines in result files.

Parameters:

name (Optional[str])

Return type:

ParserElement

result_class

alias of ase2sprkkr.result_files.result_files.ResultFile

configuration_type_name = 'RESULT FILE'

Name of the container type in the runtime documentation

add_ignored(out)[source]

In the result files, do not ignore doublecrossed lines

property extension