alias_api.retrieve
- alias_api.retrieve(file_name: str) int
Retrieves an Alias Wire file and adds the objects stored in the file to the list of Alias AlDagNode objects. If fileName is NULL the file is read from stdin.
If the universe has been initialized with Y-axis up, and the wire file retrieved was stored in a Z-axis up system, or vice versa, then the model will be rotated by 90 degrees. It is best to initialize the universe in the same orientation as the wire files that will be retrieved.
Note that if InvalidWireFile is returned you are likely trying to retrieve a newer wire file than your application recognizes. In this case you should link your application with the OpenModel library distributed with the newer Alias.
- Parameters
file_name (str) – The name of the file to be retrieved
- Returns
The status code result of the operation: Success - the file was retrieved successfully InsufficientMemory - not enough memory Failure - the wire file could not be retrieved properly InvalidWireFile - the file was not a compatible Alias wire file.
- Return type