ansys.sherlock.core.types.project_types.OutlineFile

class ansys.sherlock.core.types.project_types.OutlineFile(**data)

Contains the properties for an outline file.

Methods

OutlineFile.construct([_fields_set])
OutlineFile.copy(*[, include, exclude, ...])	Returns a copy of the model.
OutlineFile.dict(*[, include, exclude, ...])
OutlineFile.from_orm(obj)
OutlineFile.json(*[, include, exclude, ...])
OutlineFile.model_construct([_fields_set])	Creates a new instance of the Model class with validated data.
OutlineFile.model_copy(*[, update, deep])	!!! abstract "Usage Documentation"
OutlineFile.model_dump(*[, mode, include, ...])	!!! abstract "Usage Documentation"
OutlineFile.model_dump_json(*[, indent, ...])	!!! abstract "Usage Documentation"
OutlineFile.model_json_schema([by_alias, ...])	Generates a JSON schema for a model class.
OutlineFile.model_parametrized_name(params)	Compute the class name for parametrizations of generic classes.
OutlineFile.model_post_init(context, /)	Override this method to perform additional initialization after __init__ and model_construct.
OutlineFile.model_rebuild(*[, force, ...])	Try to rebuild the pydantic-core schema for the model.
OutlineFile.model_validate(obj, *[, strict, ...])	Validate a pydantic model instance.
OutlineFile.model_validate_json(json_data, *)	!!! abstract "Usage Documentation"
OutlineFile.model_validate_strings(obj, *[, ...])	Validate the given object with string data against the Pydantic model.
OutlineFile.optional_str_validation(value, info)	Allow empty strings for file_comment.
OutlineFile.parse_file(path, *[, ...])
OutlineFile.parse_obj(obj)
OutlineFile.parse_raw(b, *[, content_type, ...])
OutlineFile.schema([by_alias, ref_template])
OutlineFile.schema_json(*[, by_alias, ...])
OutlineFile.str_validation(value, info)	Validate string fields listed.
OutlineFile.update_forward_refs(**localns)
OutlineFile.validate(value)
OutlineFile.validate_non_empty_cca_names(...)	Validate cca_names contains at least one name and none are empty.

Attributes

OutlineFile.model_computed_fields
OutlineFile.model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
OutlineFile.model_extra	Get extra fields set during validation.
OutlineFile.model_fields
OutlineFile.model_fields_set	Returns the set of fields that have been explicitly set on this model instance.
OutlineFile.file_name	The filename of the outline file.
OutlineFile.file_comment	The comment for the outline file.
OutlineFile.file_type	The type of outline file.
OutlineFile.outline_file_data	Specific outline file type properties
OutlineFile.cca_names	The list of CCA names for the outline file.