SDF.file_io package

class InputFormat(value)[source]

Bases: enum.Enum

Possible input formats for SDF converters

FORCE_SDF = 6
JPK = 1
JPK_MAP = 7
LSM = 5
MFP = 2
OIB = 3
OIF = 4
SDF = 0
class OutputFormat(value)[source]

Bases: enum.Enum

Possible output formats for SDF converters

FORCE = 1
MAT = 2
SDF = 0
class SDFConverter(input_format: typing.Optional[SDF.file_io.convert.InputFormat] = None, output_directory: typing.Optional[str] = None, generate_mat: bool = False, generate_force: bool = True, dry_run: bool = False)[source]

Bases: object

Handles SDF file conversion

convert_file(input_file: str) → None[source]

Converts the input file

static get_load_function(input_format: SDF.file_io.convert.InputFormat) → typing.Callable[str, SDF.data_model.sdf_object.SDFObject][source]

Determines the load function for a input format

static infer_input_format(original_file: str) → SDF.file_io.convert.InputFormat[source]

Infers the input format from the filename

infer_output_formats(sdf: SDF.data_model.sdf_object.SDFObject, input_format: SDF.file_io.convert.InputFormat) → typing.List[SDF.file_io.convert.OutputFormat][source]

Infers the output formats for writing the SDF object

input_format: typing.Optional[SDF.file_io.convert.InputFormat]
output_directory: typing.Optional[str]
force_sdf_to_mat(sdf: SDF.force_sdf.force_sdf.ForceSDF, mat_file: typing.Union[str, typing.BinaryIO]) → None[source]
load_from_force_sdf(filename: typing.Union[str, typing.TextIO]) → SDF.force_sdf.force_sdf.ForceSDF[source]
load_from_jpk(filename: str) → SDF.data_model.workspace.Workspace[source]
load_from_lsm(filename: str) → SDF.data_model.workspace.Workspace[source]
load_from_mfp(filename: str) → SDF.data_model.workspace.Workspace[source]
load_from_oib(filename: str) → SDF.data_model.workspace.Workspace[source]
load_from_oif(filename: str) → SDF.data_model.workspace.Workspace[source]
load_from_sdf(filename: typing.Union[str, typing.TextIO]) → SDF.data_model.sdf_object.SDFObject[source]
sdf_to_force_sdf(sdf: SDF.data_model.sdf_object.SDFObject) → SDF.force_sdf.force_sdf.ForceSDF[source]
write_sdf(obj: SDF.data_model.sdf_object.SDFObject, file: typing.Union[str, typing.TextIO]) → None[source]