HyperX Scripting API Documentation
Project Class
Represents a HyperX project within a database.
Definition
Namespace: HyperX.Scripting
Assembly: HyperX.Scripting (in HyperX.Scripting.dll) Version: 9.0.0.0 (9.0.0)
Assembly: HyperX.Scripting (in HyperX.Scripting.dll) Version: 9.0.0.0 (9.0.0)
C#
public sealed class Project : IDisposable- Inheritance
- Object Project
- Implements
- IDisposable
Properties
| AnalysisProperties | Analysis Properties for this project. |
| Beams | |
| DesignLoads | |
| DesignProperties | Design properties for this project. |
| DiscreteFieldTables | |
| FemDataSet | |
| FemFormat | |
| HyperFea | |
| Id | |
| Joints | |
| LoadProperties | Load Properties for this project. |
| Name | |
| Panels | |
| PanelSegments | |
| Rundecks | |
| SectionCuts | |
| Sets | |
| Structures | |
| WorkingFolder | |
| Zones |
Methods
| AnalyzeZones(ListZone) | Analyze a list of zones. |
| AnalyzeZones(ListInt32) | Analyze a list of zones by ID. |
| CreateNonFeaZone | Create a non-FEA zone by name and category. |
| Dispose | Releases all resources used by the Project |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExportCad(String) | Export all CAD for this project to a file. |
| ExportCad(IEnumerableInt32, String) | Export CAD by Id. |
| ExportFem | |
| GetDashboardCompanies | This method fetches an array of Dashboard company names that are available to the user who is currently logged in. The URL and authentication token are taken from the last Dashboard login made through HyperX. |
| GetDashboardPrograms | This method fetches an array of Dashboard program names that are available to the user who is currently logged in. The URL and authentication token are taken from the last Dashboard login made through HyperX. |
| GetDashboardTags | This method fetches an array of Dashboard tags that are available to the user who is currently logged in. The URL and authentication token are taken from the last Dashboard login made through HyperX. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetJointsWithoutResults | Given a list of joints, returns the ids of the joints that were passed in but did not have results. If the list of joints is not a subset of the joints passed into the previous joint sizing operation, a new sizing operation will be kicked off. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ImportCad | Import CAD from a file. |
| ImportFeaResults | Manually import design loads. |
| ImportFem | |
| RegeneratePfem | Regenerates and displays the preview FEM. If running a script outside of the Script Runner, do not call this method |
| ReturnToUnusedFem | Return zones to unused FEM or delete non-FEA zones. |
| SetFemFormat | |
| SetFemUnits | |
| SizeJoints | Size a list of joints. |
| SizeZones(ListZone) | Size a list of zones. |
| SizeZones(ListInt32) | Size a list of zones by ID. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| UnimportFemAsync | |
| Upload | Does some checks to make sure the given parameters are valid, then uploads the given zones and joints to the Dashboard. The URL and authentication token are taken from the last Dashboard login made through HyperX. If any problems are encountered when uploading, this method will throw a UserException with a message describing what went wrong. |