alias_api.store

alias_api.store(*args, **kwargs)

Overloaded function.

1. store(file_name: str, dag_node: alias_api.AlDagNode = 0) -> int

   If the AlDagNode argument is absent or NULL then this method stores all the AlObjects in the universe to a file as an Alias Wire file. If the AlDagNode argument is not NULL then only the model below the AlDagNode is stored. If the AlDagNode is in the middle of a hierarchy, the AlDagNodes above the argument will also be stored so as to preserve transformations on the model.

   param file_name

   The name of the file to be stored

   type file_name

   str

   param dag_node

   See description

   type dag_node

   AlDagNode

   return

   The status code result: Success - the file was stored successfully Failure - the wire file could not be stored properly

2. store(file_name: str, dag_node: alias_api.AlDagNode, embed_image_references: bool, include_installed_images: bool, file_type: alias_api.AlFileType = <AlFileType.Wire: 1>) -> int

   If the AlDagNode argument is absent or NULL then this method stores all the AlObjects in the universe to a file as an Alias Wire file. If the AlDagNode argument is not NULL then only the model below the AlDagNode is stored. If the AlDagNode is in the middle of a hierarchy, the AlDagNodes above the argument will also be stored so as to preserve transformations on the model.

   The embedImageReferences flag can be used to set the option for saving Embedded Images with the wirefile.

   The includeInstalledImages flag can be used to set the option for saving including installed images with the embedded references in the wirefile.

   param file_name

   The name of the file to be stored

   type file_name

   str

   param dag_node

   See description

   type dag_node

   AlDagNode

   param embed_image_references

   See description

   type embed_image_references

   bool

   param include_installed_images

   See description

   type include_installed_images

   bool

   param file_type

   The type of the file to store, see AlFileType

   type file_type

   AlFileType

   return

   The status code result: Success - the file was stored successfully Failure - the wire file could not be stored properly

3. store(filename: str, active: bool, file_type: alias_api.AlFileType = <AlFileType.Wire: 1>) -> int

   This is a very early implementation of a general file saving method. It accepts a filename, active flag and a file type. Currently it will only store wire files, iges files, and dxf files, as well as IGES derivatives C4, Jamias and VDAIS and VDAFS.

   param fileName

   The name of the file to be stored.

   param active

   Store all or just the selected objects.

   param filetype

   The type of file to save.

   return The status code result

   Success - the file was stored successfully Failure - the wire file could not be stored properly InvalidArgument - unrecognized file type or fileName is NULL.

   rtype

   int(AlStatusCode)