Project
This namespace holds top-level commands and queries related to the Project, File and Units.
Abandon all top-level pending background DP updates if none is running.
This command is used to allow the expression of a property to reference data in the named table. This is a reference and not a copy, and so if the table is used in the expression, and a change is made on the referenced table and the change is in the data being referenced the value of the property will be modified. The command creates table functions in the context of this expression which can be used with constants, field variables, or another named expression. If the property does not support an expression an error will occur.
Return
An int which corresponds to the Index passed in to the command and indicates the comand successfully completed.
Required Arguments
Optional Arguments
tbl1 = pressure1.CreateTable(Columns=[[“X”, “Length”], [“Y”, “Length”], [“Z”, “Length”], [“Pressure”, “Pressure”], [“Temperature”, “Temperature Difference”]])
#
# Use three of the columns from tbl1
bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Index=1, Independents=[“X”, “Y”], Dependents=[“Pressure”])
# In the table function the x and y refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expresssion=“table1(x, y)”)
#
# Use four of the columns from tbl1
bc1.AddPropertyTable(Property=“Temperature”, Table=tbl1, Index=1, Independents=[“X”, “Y”, “Z”], Dependents=[“Temperature”])
# In the table function the x, y, and z refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Temperature”, Expression=“table1(x, y, z)”)
#
# Use two of the columns from tbl1
bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Index=1, Independents=[“X”], Dependents=[“Pressure”])
# In the table function the x refers to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(x)”)
#
# Use of a constant
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(20)”)
Add a connection between two components in the same system.
Required Arguments
AddColumn will add a column at the specified index to the table.
Return
The Integer which corresponds to the index of the column which was newly added to the table.
Required Arguments
Optional Arguments
This example illustrates adding columns to a table.
# NameSpace is the Addin namespace in use (e.g. Study, EngData, etc.) which may have its specific CreateTable command
# drParent is the DataReference of an object that has been previously created
table1 = NameSpace.CreateTable(Parent=drParent, Columns=[])
table1.AddRow()
table1.AddRow()
table1.AddRow()
table1.AddColumn("Displacement", "Length", Data=["0 [m]",".001 [m]"])
table1.AddColumn("Temperature","Temperature", Index=0)
AddRow will add a row at the specified index to the table.
Return
The Integer which corresponds to the index of the row which was newly added to the table.
Required Arguments
Optional Arguments
This example illustrates adding rows to a table.
# NameSpace is the Addin namespace in use (e.g. Study, EngData, etc.) which may have its specific CreateTable command
# drParent is the DataReference of an object that has been previously created
table1 = NameSpace.CreateTable(Parent=drParent, Columns=[("Temperature","Temperature"),("Displacement","Length")])
table1.AddRow(Data=["100 [C]","1.0 [m]"])
table1.AddRow()
table1.AddRow(Data=["300 [C]",".06 [m]"])
table1.AddRow(Index=0, Data=["50 [C]",".001 [m]"])
Creates a project archive based on current project files and contents. The project must be saved before an archive can be created.
Required Arguments
Optional Arguments
This example creates a project archive from the currently loaded project. The full file path is specified and the argument will include items from the user_files folder, include results/solution files, and exclude external files imported into the project.
Archive(FilePath=r"C:\Users\AnsUser\simpleStructural.zip",
IncludeUserFiles=True,
IncludeSkippedFiles=True,
IncludeExternalImportedFiles=False,
FailIfFilesNeedRepair=False)
Clears generated data on all components in the given system(s).
Required Arguments
Clears all messages that have no Source from the message store.
Optional Arguments
Convert a repository file to local file
Required Arguments
Copies a file to a target directory. Either the SourceFile argument or the SourceFilePath argument must be specified.
Return
A reference to the created file is returned in this argument.
Required Arguments
Optional Arguments
This example illustrates a path-based file copy procedure. The specified file will be copied to the specified destination directory path. The destination file will not be registered and the return value will be null.
CopyFile(SourceFilePath=r"C:\Users\anyuser\myTextFile.txt",
DestinationDirectoryPath=r"C:\Users\anyuser\newfolder",
Overwrite=True)
This second example illustrates a reference-based file copy procedure. The specified file will be copied to the specified destination directory path. The destination file will also be registered and the new reference returned.
file1 = GetRegisteredFile(FilePath=r"C:\path_to_file\file.txt")
file2 = CopyFile(SourceFile=file1,
DestinationDirectoryPath=r"C:\Users\anyuser\newfolder",
Overwrite=True)
Creates a custom unit system based on predefined unit system (e.g., MKS, US Customary) or other custom unit sytem already defined.
Return
A reference to the created UnitSystem data entity.
Required Arguments
This example illustrates the creation of a custom unit system.
myUnitSystem = CreateCustomUnitSystem(UnitSystemName="MyUnitSystem",
UnitSystemDisplayName="My Custom Unit System",
BaseUnitSystemName="SI")
Creates a Project Template from the current project and adds it to the list of Custom systems.
Return
A reference to the created CustomProjectTemplate entity.
Required Arguments
Creates the UnitSystem data entity for the named system.
Return
A data reference to the created UnitSystem entity.
Required Arguments
Deletes the specified file. Either the File argument or the FilePath argument must be specified.
Optional Arguments
The following example illustrates a simple file deletion; file is not deleteed if it is registered.
DeleteFile(FilePath=r"C:\Users\anyuser\path-to-file.extension")
The next example illustrates forced file deletion.
DeleteFile(FilePath=r"C:\Users\anyuser\path-to-file.extension", DeleteIfShared=True)
The next example illustrates a deletion of a registered file via a file reference. The file will be deleted if even if it is still in use. Note that the file will be backed up.
fileRef = GetRegisteredFile(FilePath=r"C:\Users\anyuser\path-to-file.extension")
DeleteFile(File=fileRef, DeleteIfShared=True,
BackUp=True)
The final example illustrates a deletion of a registered file via a file reference without a forced deletion. If the file is shared, an error will not occur, and the file reference count will be decremented.
fileRef = GetRegisteredFile(FilePath=r"C:\Users\anyuser\path-to-file.extension")
DeleteFile(File=fileRef, ErrorIfShared=False)
DeleteColumn will delete a column at the specified index from the table.
Required Arguments
This example illustrates removing a column from a table.
# NameSpace is the Addin namespace in use (e.g. Study, EngData, etc.) which may have its specific CreateTable command
# drParent is the DataReference of an object that has been previously created
table1 = NameSpace.CreateTable(Parent=drParent, Columns=[("Temperature","Temperature"),("Displacement","Length")])
table1.AddRow(Data=["100 [C]","1.0 [m]"])
table1.AddRow(Data=["200 [C]",".02 [m]"])
table1.AddRow(Data=["300 [C]",".06 [m]"])
table1.DeleteColumn(Index='Displacement')
DeleteRow will delete a row at the specified index from the table.
Required Arguments
This example illustrates removing a row from a table.
# NameSpace is the Addin namespace in use (e.g. Study, EngData, etc.) which may have its specific CreateTable command
# drParent is the DataReference of an object that has been previously created
table1 = NameSpace.CreateTable(Parent=drParent, Columns=[("Temperature","Temperature"),("Displacement","Length")])
table1.AddRow(Data=["100 [C]","1.0 [m]"])
table1.AddRow(Data=["200 [C]",".02 [m]"])
table1.AddRow(Data=["300 [C]",".06 [m]"])
table1.DeleteRow(Index=2)
Delete a row from a tabular data sheet.
Required Arguments
Optional Arguments
The following example illustrates the deletion of a row from a tabular data sheet.
#
# Create a new Engineering Data System and access Structural Steel
#
template1 = GetTemplate(TemplateName="EngData")
system1 = template1.CreateSystem()
engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
#
# Delete the first row in the Density property
#
matlProp1 = matl1.GetProperty(Name="Density")
matlProp1.DeleteTabularDataRow(Index = 0)
#
# Delete the first row in the Coefficient of Thermal Expansion property with optional SheeetNamea nd SheetQualifiers
#
matlProp2 = matl1.GetProperty(Name="Coefficient of Thermal Expansion")
matlProp2.DeleteTabularDataRow(
SheetName="Coefficient of Thermal Expansion",
SheetQualifiers={"Definition Method": "Secant", "Behavior": "Isotropic"},
Index = 0)
Deletes the named unit system.
Required Arguments
Download the specified file from repository
Return
Holds the reference to the Repository file as the output value.
Required Arguments
Writes out project report containing both framework- and addin-supplied content. The report output is XML in accordance to EKM schema. If the file path extension is html, the XML will be converted to an html output file.
Required Arguments
release the license reservation held by a given reservation key, if the reservation key matches the id reserved by the project then the reservation record and reservation count stored in the project is deleted. The id doesn't have to be supplied in which case the value used is the id reserved by the project.
Optional Arguments
Gets the absolute user path name for the given relative path name, based on the current setting of the user path root. See also GetUserPathRoot and SetUserPathRoot.
Return
The returned absolute user path name.
Required Arguments
This example uses the SetUserPathRoot and GetAbsoluteUserPathName to read a project from two different user directories.
SetUserPathRoot(DirectoryPath = "C:/Users/myUser1/Projects")
Open(FilePath=GetAbsoluteUserPathName("proj1.wbpj")) # Read project from first location
SetUserPathRoot(UserPathRoot = "C:/Users/myUser2/Projects")
Open(FilePath=GetAbsoluteUserPathName("proj1.wbpj")) # Read project from second location
Gets the list of all files that have been registered with the project (even if external to the project directory) or exist within the project files directory.
Query to return the set of Data References to all System entities in the project.
Return
Data Reference set of Systems
Query to return the Data Reference to the Component Template of the given name.
Return
Component Template Data Reference.
Required Arguments
Gets the files registered with the project.
Return
The set of data references to registered files.
Query to return the singleton DesignPointSolveSettings.
Return
DesignPointSolveSettings Data Reference.
Gets the File Reference to a registered file based upon the file reference's name. Throws an Invalid Operation Exception if a matching File Reference is not found.
Return
The data reference of the file whose name matches the supplied parameter.
Required Arguments
Gets the set of data references to registered files within a directory.
Return
The set of data references to files in the directory.
Required Arguments
Returns a reference to a FileType data entity, given the data entity name of the FileType object.
Return
The data reference to the FileType data entitity.
Required Arguments
Get the current framework build version.
Return
Return the framework build version.
Get the currently executing framework version.
Return
Return the currently executing framework version.
Query to return license features ID and names.
Return
Returns license feature IDs along with readible names.
Gets the max project path length created in WorkBench based on the project directory and project name.
Return
The max project path length
Returns DataReferences for all stored messages, ordered by message publication date/time with most recent messages first.
Return
The list of StoredMessage data entities for current messages.
Query to return the needed licenses to update project.
Return
Needed licenses based on previous updates, with license feature
ID as key, along with needed count.
Given the path to a WB project, return the last-saved-in version. Note: The command will return '00' if a project is not supplied and the current session project has not been saved.
Return
The Project's persisted version (e.g, 120, 121, 130, 140, 145, ...).
Optional Arguments
Gets the full path to the current project directory.
Return
The project directory full path.
Gets the full path of the current project file (*.wbpj).
Return
The full path of the current project file.
Query to return the Project Template of the given name.
Return
Project Template Data Reference.
Required Arguments
Gets the current unit system for the project.
Return
A reference to the UnitSystem data entity.
Gets the expression defining a data entity property's value.
Return
Returns the expression that currently defines the property's value.
Required Arguments
Gets the unit for a quantity in the specified unit system.
Return
The current Unit for the quantity.
Gets the File Reference to a registered file based upon the file's path.
Return
The data reference of the file whose location points to the specified path. Null if
no data reference is found.
Required Arguments
Gets list of File References for a directory path.
Return
The list of data reference of files whose location root is DirectoryPath. Empty list if
no data reference is found.
Required Arguments
Query to return Rsm queue names from available configured queues when Rsm is running using the new architecture
Query to return the singleton SchematicSettings.
Return
SchematicSettings Data Reference.
returns the software version that the current script that is being executed is compliant with
Return
the software version that the current script that is being executed is compliant with
Query to return the Data Reference to the system of the given name.
Return
System Data Reference
Required Arguments
GetData will return the data in a table.
Required Arguments
Optional Arguments
This example illustrates data retrieval from a table.
# drParent is the DataReference of an object that has been previously created
table1 = drParent.CreateTable(Columns=[("Temperature","Temperature"),("Displacement","Length")])
table1.AddRow(Data=["100 [C]","1.0 [m]"])
table1.AddRow(Data=["200 [C]",".02 [m]"])
table1.AddRow(Data=["300 [C]",".06 [m]"])
table1.GetData(RowRange=1) # get the second row of the table
table1.GetData(RowRange=(1,2)) # get the second and third row of the table
table1.GetData() # complete table in row-major
# Get table as column major
numCol = len(table1.GetData(RowRange=0))
colMajorArr = [0 for i in range(numCol)]
for colIdx in range(numCol):
colMajorArr[colIdx] = [row[colIdx] for row in table1.GetData()]
colMajorArr
Returns the tabular data associated with the data entity.
Return
The returned data in scalar, list, or dictionary format.
Required Arguments
Optional Arguments
In this example, all data is requested for the given tabular data entity.
tabData1.GetData()
In this example, all data is requested in row-major order.
tabData1.GetData(ColumnMajor=False)
In this example, all data is requested in dictionary format.
tabData1.GetData(AsDictionary=True)
In this example, data for variables Density and Temperature is requested in dictionary format.
tabData1.GetData(Variables=["Density", "Temperature"], AsDictionary=True)
Query to return a System Template reference, based on the template name and additional solver specification.
Return
Template Data Reference.
Required Arguments
Optional Arguments
Gets the value of units display settings ("DisplayValuesAsDefined" or "DisplayValuesInProjectUnits").
Return
The current value of the Units display setting.
Gets a reference to the UnitSystem entity of the given internal name.
Return
A reference to the UnitSystem data entity.
Required Arguments
Gets the internal names of all currently defined unit systems (Predefined and Custom Unit Systems).
Gets the current user_files directory.
Return
The full path to the user_files directory.
Imports a file into the project. The result of the import varies, dependent upon the file type's defined import behavior. Usually a corresponding system is created in the project view. Sometimes, the file is simply added to the files view. To be imported, a file's type must be registered and the ImportFileCommandName property must be non-null. Use FileTypeRepository.RegisterFileTypeTemplate or FileTypeTemplateRecord.ImportFileCommandName to specify the command to be invoked when importing a file of a given type.
Required Arguments
Optional Arguments
Imports any variables defined in the currently-recorded journal file into the scripting environment so they can be accessed in the command window.
Importing a project into the current project. There are several restrictions / limitations to this
Required Arguments
Imports a unit system from a Units .xml file.
Return
A reference to the created UnitSystem data entity.
Required Arguments
Optional Arguments
A query to determine if all systems and their components in the project are fully up to date, that is, NOT even interrupted-but-up-to-date.
Return
The return is True if the project is up to date.
Merging multiple project tasks solved from RSM design point updates into the current project. This command should *NOT* be used to merge any un-related projects. Solved projects may be either intermediate or final results.
Required Arguments
Optional Arguments
The following example illustrates how this command may be used to merge all Design Points from RSM-solved projects into the current project. Existing Rsm Project files are retained. Any existing archive with the same name in the destination project will be overwritted. The project will be first saved using a revertible save.
MergeRsmProject(MergingProjects={(r"Path_to_RSM_Project", {(r"Path_to_current_project", {Updated DesignPoints})})},
KeepFilesInRsmProject=True,
Overwrite=True,
SaveFirst=True,
DoRevertibleSave=True)
Moves a file to a new directory. Either the File argument or the FilePath argument must be specified.
Required Arguments
Optional Arguments
This example illustrates a path-based file move procedure. The specified file will be moved to the specified destination directory path.
MoveFile(FilePath=r"C:\Users\anyuser\myTextFile.txt",
NewDirectoryPath=r"C:\Users\anyuser\newfolder")
This second example illustrates a reference-based file move procedure. The specified file will be moved to the specified destination directory path.
file1 = GetRegisteredFile(FilePath=r"C:\path_to_file\file.txt")
MoveFile(SourceFile=file1,
NewDirectoryPath=r"C:\Users\anyuser\newfolder")
This final example also illustrates a reference-based file move procedure. The specified file will be moved to the specified destination directory path. The file will not be backed up prior to the move.
file1 = GetRegisteredFile(FilePath=r"C:\path_to_file\file.txt")
MoveFile(SourceFile=file1,
NewDirectoryPath=r"C:\Users\anyuser\newfolder",
Backup=False)
Opens a Workbench project from the specified .wbpj file.
Required Arguments
Refreshes the input data for the entire project by reading changed data from upstream sources. Does not perform any calculations or updates based on the new data.
Registers the specified file with the project. Either the FilePath argument or the RepositoryFile argument must be specified.
Return
Holds the reference to the registered file as the output value.
Optional Arguments
This example illustrates a path-based file registration procedure. The specified file will be registered and the resulting file reference will be returned.
file1 = RegisterFile(FilePath=r"C:\Users\anyuser\myTextFile.txt")
This second example illustrates a file type based file registration procedure. The specified file will be registered with the corresponding (supplied) file type and the resulting file reference will be returned.
fileType1 = GetFileType(Name="MyFileType")
file1 = RegisterFile(FilePath=r"C:\Users\anyuser\myFile.abc",
FileType=fileType1)
Remove a table reference from a property to prevent its use in an expression. If the property does not support an expression an error will occur.
Required Arguments
tbl1 = pressure1.CreateTable(Columns=[[“X”, “Length”], [“Y”, “Length”], [“Pressure”, “Pressure”]])
bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Independents=[“X”, “Y”], Dependents=[“Pressure”])
# In the table function the x and y refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(x, y)”)
bc1.RemovePropertyTable(Property=“Magnitude”, Index=1);
Renames a file. Either the File argument or the FilePath argument must be specified.
Required Arguments
Optional Arguments
This example illustrates a path-based file rename procedure. The specified file will be renamed with the specified new name.
RenameFile(FilePath=r"C:\Users\anyuser\myTextFile.txt",
NewName="myTextFileRENAMED.txt")
This second example illustrates a reference-based file rename procedure. The specified file reference will be renamed with the specified new name.
file1 = GetRegisteredFile(FilePath=r"C:\path_to_file\file.txt")
RenameFile(File=file1,
NewName="fileRENAMED.txt")
This final example also illustrates a reference-based file rename procedure. The specified file will be renamed with the specified new name. The file will not be backed up prior to the move.
file1 = GetRegisteredFile(FilePath=r"C:\path_to_file\file.txt")
RenameFile(File=file1,
NewName="fileRENAMED.txt",
Backup=False)
A command used to resolve the data object to make it consistent with the rest of the data model
Required Arguments
Resume given design point update session previously submitted for remote execution.
Return
Optional output which will be set immediately to the input session.
It is provided for the convenience of the invoking code so that the
same type of output can be returned from this vs. UADP command.
Optional Arguments
Resume design point updates suspended waiting for subtasks executed in background; or resume suspended parametric updates.
Executes a Workbench script file from the specified location.
Required Arguments
Saves a project archive to Teamcenter. The project archive must be created before calling this function.
Required Arguments
Optional Arguments
Saves a project archive to Teamcenter
SaveProjectArchiveToTeamcenter(ArchiveFileName=r"C:\Users\AnsUser\simpleStructural.wbpz",
TeamcenterUserName="infodba",
TeamcenterUserPassword="infodba",
ItemName="ANS0048",
ItemRevision="001",
Decription="Workbench2 Project Archive")
Set the design point updates run mode.
Required Arguments
Sets the unit system for the current project.
Return
A reference to the UnitSystem entity that is now the project unit system.
Required Arguments
Sets the unit for a Quantity in the specified unit system. Changing Base or Common units will change derived units if appropriate. Note: Quantity unit for a predefined unit system cannot be changed. Note: Only consistent units (SI or US Customary) are allowed.
Return
A dictionary of the Quantity names and new units for all resulting quantity changes.
This will be more than just the target quantity if a base unit is changed.
Required Arguments
The following example illustrates the setting of a quantity unit in a given unit system.
changedUnits = SetQuantityUnitForUnitSystem(UnitSystemName="myUnitSystem",
QuantityName="Temperature",
Unit="C")
Sets the command API version used when executing a script.
Required Arguments
SetData will overwrite the data in a table beginning at the specified location.
Required Arguments
Optional Arguments
This example illustrates setting data in a table.
# NameSpace is the Addin namespace in use (e.g. Study, EngData, etc.) which may have its specific CreateTable command
# drParent is the DataReference of an object that has been previously created
table1 = NameSpace.CreateTable(Parent=drParent, Columns=[("Temperature","Temperature"),("Displacement","Length")])
table1.AddRow(Data=["100 [C]","1.0 [m]"])
table1.AddRow(Data=["200 [C]",".02 [m]"])
table1.AddRow(Data=["300 [C]",".06 [m]"])
tableData = ["100 [C]","0.0 [m]"]
table1.SetData(Row=0, Column=0, Data=tableData)
Set tabular data associated with the data entity.
Required Arguments
Optional Arguments
#
# Create a new Engineering Data System and access Structural Steel
#
template1 = GetTemplate(TemplateName="EngData")
system1 = template1.CreateSystem()
engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
#
# Change the value of a simple single-valued property
#
matlProp1 = matl1.GetProperty(Name="Density")
matlProp1.SetData(
Variables="Density",
Values="8500 [kg m^-3]")
#
# Set Temperature-dependent data for Elasticity based
# on lists of variables and values.
matlProp2 = matl1.GetProperty(Name="Elasticity")
temperature = ["400 [K]", "600 [K]", "800 [K]"]
E = ["2e5 [MPa]", "1.9e5 [MPa]", "1.6e5 [MPa]"]
matlProp2.SetData(
Variables = ["Temperature","Young's Modulus"],
Values = [temperature, E])
#
# Change the Temperature for the second table entry.
#
matlProp2.SetData(
Index = 1,
Variables = "Temperature",
Values = "625 [K]")
#
# Set a list for Poisson's Ratio starting at the second table entry.
#
matlProp2.SetData(
Index = 1,
Variables = "Poisson's Ratio",
Values = [0.3, 0.3])
#
# Set Temperature-dependent property data for the Coefficient of Thermal Expansion
# using a dictionary. The dictionary key is the Variable name,
# followed by the list of values for the variable.
#
matlProp3 = matl1.GetProperty(Name="Coefficient of Thermal Expansion")
newData = {"Temperature": ["200 [F]","400 [F]","600 [F]","800 [F]","1000 [F]"],
"Coefficient of Thermal Expansion" : ["6.3e-6 [F^-1]", "7.0e-6 [F^-1]",
"7.46e-6 [F^-1]", "7.8e-6 [F^-1]",
"8.04e-6 [F^-1]"]}
matlProp3.SetData(
SheetName="Coefficient of Thermal Expansion",
SheetQualifiers={"Definition Method": "Secant", "Behavior": "Isotropic"},
Data = newData)
Changes the values of a specifiec qualifier in a data table.
Required Arguments
Optional Arguments
The following example changes the 'Derive From' setting within an Isotropic Elasticity material property to be "Bulk Modulus and Poisson's Ratio".
matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
matlProp1 = matl1.GetProperty(Name="Elasticity")
matlProp1.SetQualifier(
SheetName="Elasticity",
Qualifier="Derive from",
Value="Bulk Modulus and Poisson's Ratio")
Sets units display settings.
Required Arguments
| DisplayValuesAsDefined |
| DisplayValuesInProjectUnits |
Sets the current user path root. The root path facilitates portability of session journals by allowing relative rather than absolute paths to be recorded. During command journal replay, paths are reconstructed using the active user path root setting.
Required Arguments
Restores a project from an archive to the specified location.
Required Arguments
Optional Arguments
This example illustrates an unarchive procedure. The specified archive will be un-archived to the specified project file path. If the project file path already exists, it will be overwritten since Overwrite=True.
Unarchive(ArchivePath=r"C:\Users\anyuser\myProjectArchive.wbpz",
ProjectFilePath=r"C:\Users\anyuser\myProject.wbpj",
Overwrite=True)
Updates all design points or a subset of them if specified.
Return
The reference to the DesignPointUpdateBackgroundSession object,
if the command is executed via RSM.
Optional Arguments
The following example illustrates a more verbose usage of UpdateAllDesignPoints, as general users will typically call just UpdateAllDesignPoints(). The following call processes two design points for all parameters (all when None is specified), skips the executing design point when observing an error, and stops if a design point update cannot be completed.
dps = []
dp = Parameters.GetDesignPoint("1")
dps.append(dp)
dp = Parameters.GetDesignPoint("2")
dps.append(dp)
UpdateAllDesignPoints(DesignPoints=dps,
Parameters=None,
ErrorBehavior="SkipDesignPoint",
CannotCompleteBehavior="Stop")
Updates all components in the project by refreshing all input data and performing local calcuations to produce new output if the component is out of date.
Optional Arguments
Updates all components in the given systems by refreshing the input from all upstream sources, and then performing local calculation based on current data.
Required Arguments