HyperX.Scripting.Api
The HyperX C# Scripting Application Programming Interface
Loading...
Searching...
No Matches
HyperX.Scripting.Structure Class Referencesealed
Inheritance diagram for HyperX.Scripting.Structure:
HyperX.Scripting.ZoneJointContainer HyperX.Scripting.IdNameEntityRenameable HyperX.Scripting.IdNameEntity HyperX.Scripting.IdEntity

Public Member Functions

CollectionModificationStatus AddElements (IEnumerable< int > elementIds)
SimpleStatus AddElementsAndAssignDesigns (IEnumerable< int > elementIds, bool overrideMetalDesigns=false, bool overrideLaminateDesigns=false)
override CollectionModificationStatus AddJoint (Joint joint)
override CollectionModificationStatus AddPanelSegment (PanelSegment segment)
CollectionModificationStatus AddPfemProperties (IEnumerable< int > pfemPropertyIds)
SimpleStatus AddPfemPropertiesAndAssignDesigns (IEnumerable< int > pfemPropertyIds, bool overrideMetalDesigns=false, bool overrideLaminateDesigns=false)
override CollectionModificationStatus AddZones (IEnumerable< Zone > zones)
PanelSegment CreatePanelSegment (DiscreteTechnique discreteTechnique, Dictionary< DiscreteDefinitionType, List< int > > discreteElementLkp, string name=null)
Zone CreateZone (IEnumerable< int > elementIds, string name=null)
 Create a zone from imported elements.
void ExportVCP (string fileName)
 Export VCP with this structure's element centroids.
CollectionModificationStatus Remove (IEnumerable< int > zoneIds, IEnumerable< int > jointIds)
CollectionModificationStatus Remove (IEnumerable< int > zoneIds, IEnumerable< int > jointIds, IEnumerable< int > panelSegmentIds)
override CollectionModificationStatus RemoveJoints (IEnumerable< int > jointIds)
override CollectionModificationStatus RemovePanelSegments (IEnumerable< int > segmentIds)
override CollectionModificationStatus RemoveZones (IEnumerable< int > zoneIds)
 Sends provided zones back to unused FEM.
Public Member Functions inherited from HyperX.Scripting.ZoneJointContainer
CollectionModificationStatus AddJoint (int id)
CollectionModificationStatus AddJoint (Joint joint)
CollectionModificationStatus AddPanelSegment (int id)
CollectionModificationStatus AddPanelSegment (PanelSegment segment)
 Add an existing panel segment to this entity.
CollectionModificationStatus AddZone (int id)
 Add an existing zone to this entity.
CollectionModificationStatus AddZone (Zone zone)
 Add an existing zone to this entity.
CollectionModificationStatus AddZones (IEnumerable< int > ids)
 Add existing zones to this entity.
CollectionModificationStatus AddZones (IEnumerable< Zone > zones)
 Add existing zones to this entity.
CollectionModificationStatus RemoveJoint (int id)
CollectionModificationStatus RemoveJoint (Joint joint)
CollectionModificationStatus RemoveJoints (IEnumerable< int > jointIds)
CollectionModificationStatus RemoveJoints (IEnumerable< Joint > joints)
CollectionModificationStatus RemovePanelSegment (int id)
CollectionModificationStatus RemovePanelSegment (PanelSegment segment)
CollectionModificationStatus RemovePanelSegments (IEnumerable< int > segmentIds)
CollectionModificationStatus RemovePanelSegments (IEnumerable< PanelSegment > segments)
CollectionModificationStatus RemoveZone (int id)
CollectionModificationStatus RemoveZone (Zone zone)
CollectionModificationStatus RemoveZones (IEnumerable< int > zoneIds)
CollectionModificationStatus RemoveZones (IEnumerable< Zone > zones)
Public Member Functions inherited from HyperX.Scripting.IdNameEntityRenameable
void Rename (string name)

Protected Member Functions

override void UpdateNameInDatabase (string name)
override bool ValidateName (string name)
Protected Member Functions inherited from HyperX.Scripting.IdNameEntityRenameable
void UpdateNameInDatabase (string name)
 Rename this entity in the database.
bool ValidateName (string name)
 Return true if this name is valid to use, false otherwise.

Properties

override JointCol Joints [get]
override PanelSegmentCol PanelSegments [get]
Folder< Structure > ParentFolder [get]
PlyCol Plies [get]
override ZoneCol Zones [get]
Properties inherited from HyperX.Scripting.ZoneJointContainer
Centroid Centroid [get]
 Centroid center determined by weight.
JointCol Joints [get]
PanelSegmentCol PanelSegments [get]
double TotalBeamLength [get]
 Summation of beam lengths.
double TotalPanelArea [get]
 Summation of panel areas.
double TotalZoneWeight [get]
 Get the total weight of all zones contained in this object.
ZoneCol Zones [get]
Properties inherited from HyperX.Scripting.IdNameEntity
string Name [get, protected set]
Properties inherited from HyperX.Scripting.IdEntity
int Id [get]

Additional Inherited Members

Protected Attributes inherited from HyperX.Scripting.ZoneJointContainer
readonly Application _application
readonly IJointRepo _jointRepo
readonly IModelRepository _modelRepo

Member Function Documentation

◆ AddElements()

CollectionModificationStatus HyperX.Scripting.Structure.AddElements ( IEnumerable< int > elementIds)

◆ AddElementsAndAssignDesigns()

SimpleStatus HyperX.Scripting.Structure.AddElementsAndAssignDesigns ( IEnumerable< int > elementIds,
bool overrideMetalDesigns = false,
bool overrideLaminateDesigns = false )

◆ AddJoint()

override CollectionModificationStatus HyperX.Scripting.Structure.AddJoint ( Joint joint)

◆ AddPanelSegment()

override CollectionModificationStatus HyperX.Scripting.Structure.AddPanelSegment ( PanelSegment segment)

◆ AddPfemProperties()

CollectionModificationStatus HyperX.Scripting.Structure.AddPfemProperties ( IEnumerable< int > pfemPropertyIds)

◆ AddPfemPropertiesAndAssignDesigns()

SimpleStatus HyperX.Scripting.Structure.AddPfemPropertiesAndAssignDesigns ( IEnumerable< int > pfemPropertyIds,
bool overrideMetalDesigns = false,
bool overrideLaminateDesigns = false )

◆ AddZones()

override CollectionModificationStatus HyperX.Scripting.Structure.AddZones ( IEnumerable< Zone > zones)

◆ CreatePanelSegment()

PanelSegment HyperX.Scripting.Structure.CreatePanelSegment ( DiscreteTechnique discreteTechnique,
Dictionary< DiscreteDefinitionType, List< int > > discreteElementLkp,
string name = null )

◆ CreateZone()

Zone HyperX.Scripting.Structure.CreateZone ( IEnumerable< int > elementIds,
string name = null )

Create a zone from imported elements.

Parameters
elementIds
name
Returns
Exceptions
InvalidOperationException

◆ ExportVCP()

void HyperX.Scripting.Structure.ExportVCP ( string fileName)

Export VCP with this structure's element centroids.

◆ Remove() [1/2]

CollectionModificationStatus HyperX.Scripting.Structure.Remove ( IEnumerable< int > zoneIds,
IEnumerable< int > jointIds )

◆ Remove() [2/2]

CollectionModificationStatus HyperX.Scripting.Structure.Remove ( IEnumerable< int > zoneIds,
IEnumerable< int > jointIds,
IEnumerable< int > panelSegmentIds )

◆ RemoveJoints()

override CollectionModificationStatus HyperX.Scripting.Structure.RemoveJoints ( IEnumerable< int > jointIds)

◆ RemovePanelSegments()

override CollectionModificationStatus HyperX.Scripting.Structure.RemovePanelSegments ( IEnumerable< int > segmentIds)

◆ RemoveZones()

override CollectionModificationStatus HyperX.Scripting.Structure.RemoveZones ( IEnumerable< int > zoneIds)

Sends provided zones back to unused FEM.

◆ UpdateNameInDatabase()

override void HyperX.Scripting.Structure.UpdateNameInDatabase ( string name)
protected

◆ ValidateName()

override bool HyperX.Scripting.Structure.ValidateName ( string name)
protected

Property Documentation

◆ Joints

override JointCol HyperX.Scripting.Structure.Joints
get

◆ PanelSegments

override PanelSegmentCol HyperX.Scripting.Structure.PanelSegments
get

◆ ParentFolder

Folder<Structure> HyperX.Scripting.Structure.ParentFolder
get

◆ Plies

PlyCol HyperX.Scripting.Structure.Plies
get

◆ Zones

override ZoneCol HyperX.Scripting.Structure.Zones
get

The documentation for this class was generated from the following file: