hyperx.api.Structure Class Reference

Inheritance diagram for hyperx.api.Structure:

Public Member Functions
	__init__ (self, _api.Structure structure)
CollectionModificationStatus	AddElements (self, tuple[int] elementIds)
types.SimpleStatus	AddElementsAndAssignDesigns (self, tuple[int] elementIds, bool overrideMetalDesigns=False, bool overrideLaminateDesigns=False)
CollectionModificationStatus	AddJoint (self, int id)
CollectionModificationStatus	AddJoint (self, item1=None)
CollectionModificationStatus	AddJoint (self, Joint joint)
CollectionModificationStatus	AddPanelSegment (self, int id)
CollectionModificationStatus	AddPanelSegment (self, item1=None)
CollectionModificationStatus	AddPanelSegment (self, PanelSegment segment)
CollectionModificationStatus	AddPfemProperties (self, tuple[int] pfemPropertyIds)
types.SimpleStatus	AddPfemPropertiesAndAssignDesigns (self, tuple[int] pfemPropertyIds, bool overrideMetalDesigns=False, bool overrideLaminateDesigns=False)
CollectionModificationStatus	AddZone (self, int id)
	Add an existing zone to this entity.
CollectionModificationStatus	AddZone (self, item1=None)
CollectionModificationStatus	AddZone (self, Zone zone)
	Add an existing zone to this entity.
CollectionModificationStatus	AddZones (self, item1=None)
CollectionModificationStatus	AddZones (self, tuple[int] ids)
	Add existing zones to this entity.
CollectionModificationStatus	AddZones (self, tuple[Zone] zones)
	Add existing zones to this entity.
PanelSegment	CreatePanelSegment (self, types.DiscreteTechnique discreteTechnique, dict[types.DiscreteDefinitionType, list[int]] discreteElementLkp, str name=None)
Zone	CreateZone (self, tuple[int] elementIds, str name=None)
	Create a zone from imported elements.
None	ExportVCP (self, str fileName)
	Export VCP with this structure's element centroids.
CollectionModificationStatus	Remove (self, item1=None, item2=None, item3=None)
CollectionModificationStatus	Remove (self, tuple[int] zoneIds, tuple[int] jointIds)
CollectionModificationStatus	Remove (self, tuple[int] zoneIds, tuple[int] jointIds, tuple[int] panelSegmentIds)
CollectionModificationStatus	RemoveJoint (self, int id)
CollectionModificationStatus	RemoveJoint (self, item1=None)
CollectionModificationStatus	RemoveJoint (self, Joint joint)
CollectionModificationStatus	RemoveJoints (self, item1=None)
CollectionModificationStatus	RemoveJoints (self, tuple[int] jointIds)
CollectionModificationStatus	RemoveJoints (self, tuple[Joint] joints)
CollectionModificationStatus	RemovePanelSegment (self, int id)
CollectionModificationStatus	RemovePanelSegment (self, item1=None)
CollectionModificationStatus	RemovePanelSegment (self, PanelSegment segment)
CollectionModificationStatus	RemovePanelSegments (self, item1=None)
CollectionModificationStatus	RemovePanelSegments (self, tuple[int] segmentIds)
CollectionModificationStatus	RemovePanelSegments (self, tuple[PanelSegment] segments)
CollectionModificationStatus	RemoveZone (self, int id)
CollectionModificationStatus	RemoveZone (self, item1=None)
CollectionModificationStatus	RemoveZone (self, Zone zone)
CollectionModificationStatus	RemoveZones (self, item1=None)
CollectionModificationStatus	RemoveZones (self, tuple[int] zoneIds)
	Sends provided zones back to unused FEM.
CollectionModificationStatus	RemoveZones (self, tuple[Zone] zones)
Public Member Functions inherited from hyperx.api.ZoneJointContainer
	__init__ (self, _api.ZoneJointContainer zoneJointContainer)
Public Member Functions inherited from hyperx.api.IdNameEntityRenameable
	__init__ (self, _api.IdNameEntityRenameable idNameEntityRenameable)
None	Rename (self, str name)
Public Member Functions inherited from hyperx.api.IdNameEntity
	__init__ (self, _api.IdNameEntity idNameEntity)
Public Member Functions inherited from hyperx.api.IdEntity
	__init__ (self, _api.IdEntity idEntity)

Properties
	Joints = property
	PanelSegments = property
	ParentFolder = property
	Plies = property
	Zones = property
Properties inherited from hyperx.api.ZoneJointContainer
	Centroid = property
	Centroid center determined by weight.
	TotalBeamLength = property
	Summation of beam lengths.
	TotalPanelArea = property
	Summation of panel areas.
	TotalZoneWeight = property
	Get the total weight of all zones contained in this object.
Properties inherited from hyperx.api.IdNameEntity
	Name = property
Properties inherited from hyperx.api.IdEntity
	Id = property

Additional Inherited Members
Protected Attributes inherited from hyperx.api.IdEntity
	_Entity = idEntity
Static Protected Attributes inherited from hyperx.api.ZoneJointContainer
	_Centroid

Constructor & Destructor Documentation

__init__()

hyperx.api.Structure.__init__	(		self,
		_api.Structure	structure )

Member Function Documentation

AddElements()

CollectionModificationStatus hyperx.api.Structure.AddElements	(		self,
		tuple[int]	elementIds )

AddElementsAndAssignDesigns()

types.SimpleStatus hyperx.api.Structure.AddElementsAndAssignDesigns	(		self,
		tuple[int]	elementIds,
		bool	overrideMetalDesigns = False,
		bool	overrideLaminateDesigns = False )

AddJoint() [1/3]

CollectionModificationStatus hyperx.api.Structure.AddJoint	(		self,
		int	id )

Reimplemented from hyperx.api.ZoneJointContainer.

AddJoint() [2/3]

CollectionModificationStatus hyperx.api.Structure.AddJoint	(		self,
			item1 = None )

Reimplemented from hyperx.api.ZoneJointContainer.

AddJoint() [3/3]

CollectionModificationStatus hyperx.api.Structure.AddJoint	(		self,
		Joint	joint )

Reimplemented from hyperx.api.ZoneJointContainer.

AddPanelSegment() [1/3]

CollectionModificationStatus hyperx.api.Structure.AddPanelSegment	(		self,
		int	id )

Reimplemented from hyperx.api.ZoneJointContainer.

AddPanelSegment() [2/3]

CollectionModificationStatus hyperx.api.Structure.AddPanelSegment	(		self,
			item1 = None )

Reimplemented from hyperx.api.ZoneJointContainer.

AddPanelSegment() [3/3]

CollectionModificationStatus hyperx.api.Structure.AddPanelSegment	(		self,
		PanelSegment	segment )

Reimplemented from hyperx.api.ZoneJointContainer.

AddPfemProperties()

CollectionModificationStatus hyperx.api.Structure.AddPfemProperties	(		self,
		tuple[int]	pfemPropertyIds )

AddPfemPropertiesAndAssignDesigns()

types.SimpleStatus hyperx.api.Structure.AddPfemPropertiesAndAssignDesigns	(		self,
		tuple[int]	pfemPropertyIds,
		bool	overrideMetalDesigns = False,
		bool	overrideLaminateDesigns = False )

AddZone() [1/3]

CollectionModificationStatus hyperx.api.Structure.AddZone	(		self,
		int	id )

Add an existing zone to this entity.

Reimplemented from hyperx.api.ZoneJointContainer.

AddZone() [2/3]

CollectionModificationStatus hyperx.api.Structure.AddZone	(		self,
			item1 = None )

Add an existing zone to this entity.

Add an existing zone to this entity.

Reimplemented from hyperx.api.ZoneJointContainer.

AddZone() [3/3]

CollectionModificationStatus hyperx.api.Structure.AddZone	(		self,
		Zone	zone )

Add an existing zone to this entity.

Reimplemented from hyperx.api.ZoneJointContainer.

AddZones() [1/3]

CollectionModificationStatus hyperx.api.Structure.AddZones	(		self,
			item1 = None )

Add existing zones to this entity.

Reimplemented from hyperx.api.ZoneJointContainer.

AddZones() [2/3]

CollectionModificationStatus hyperx.api.Structure.AddZones	(		self,
		tuple[int]	ids )

Add existing zones to this entity.

Reimplemented from hyperx.api.ZoneJointContainer.

AddZones() [3/3]

CollectionModificationStatus hyperx.api.Structure.AddZones	(		self,
		tuple[Zone]	ids )

Add existing zones to this entity.

Reimplemented from hyperx.api.ZoneJointContainer.

CreatePanelSegment()

PanelSegment hyperx.api.Structure.CreatePanelSegment	(		self,
		types.DiscreteTechnique	discreteTechnique,
		dict[types.DiscreteDefinitionType, list[int]]	discreteElementLkp,
		str	name = None )

CreateZone()

Zone hyperx.api.Structure.CreateZone	(		self,
		tuple[int]	elementIds,
		str	name = None )

Create a zone from imported elements.

Exceptions

InvalidOperationException

ExportVCP()

None hyperx.api.Structure.ExportVCP	(		self,
		str	fileName )

Export VCP with this structure's element centroids.

Remove() [1/3]

CollectionModificationStatus hyperx.api.Structure.Remove	(		self,
			item1 = None,
			item2 = None,
			item3 = None )

Remove() [2/3]

CollectionModificationStatus hyperx.api.Structure.Remove	(		self,
		tuple[int]	zoneIds,
		tuple[int]	jointIds )

Remove() [3/3]

CollectionModificationStatus hyperx.api.Structure.Remove	(		self,
		tuple[int]	zoneIds,
		tuple[int]	jointIds,
		tuple[int]	panelSegmentIds )

RemoveJoint() [1/3]

CollectionModificationStatus hyperx.api.Structure.RemoveJoint	(		self,
		int	id )

Reimplemented from hyperx.api.ZoneJointContainer.

RemoveJoint() [2/3]

CollectionModificationStatus hyperx.api.Structure.RemoveJoint	(		self,
			item1 = None )

Reimplemented from hyperx.api.ZoneJointContainer.

RemoveJoint() [3/3]

CollectionModificationStatus hyperx.api.Structure.RemoveJoint	(		self,
		Joint	joint )

Reimplemented from hyperx.api.ZoneJointContainer.

RemoveJoints() [1/3]

CollectionModificationStatus hyperx.api.Structure.RemoveJoints	(		self,
			item1 = None )

Reimplemented from hyperx.api.ZoneJointContainer.

RemoveJoints() [2/3]

CollectionModificationStatus hyperx.api.Structure.RemoveJoints	(		self,
		tuple[int]	jointIds )

Reimplemented from hyperx.api.ZoneJointContainer.

RemoveJoints() [3/3]

CollectionModificationStatus hyperx.api.Structure.RemoveJoints	(		self,
		tuple[Joint]	joints )

Reimplemented from hyperx.api.ZoneJointContainer.

RemovePanelSegment() [1/3]

CollectionModificationStatus hyperx.api.Structure.RemovePanelSegment	(		self,
		int	id )

Reimplemented from hyperx.api.ZoneJointContainer.

RemovePanelSegment() [2/3]

CollectionModificationStatus hyperx.api.Structure.RemovePanelSegment	(		self,
			item1 = None )

Reimplemented from hyperx.api.ZoneJointContainer.

RemovePanelSegment() [3/3]

CollectionModificationStatus hyperx.api.Structure.RemovePanelSegment	(		self,
		PanelSegment	segment )

Reimplemented from hyperx.api.ZoneJointContainer.

RemovePanelSegments() [1/3]

CollectionModificationStatus hyperx.api.Structure.RemovePanelSegments	(		self,
			item1 = None )

Reimplemented from hyperx.api.ZoneJointContainer.

RemovePanelSegments() [2/3]

CollectionModificationStatus hyperx.api.Structure.RemovePanelSegments	(		self,
		tuple[int]	segmentIds )

Reimplemented from hyperx.api.ZoneJointContainer.

RemovePanelSegments() [3/3]

CollectionModificationStatus hyperx.api.Structure.RemovePanelSegments	(		self,
		tuple[PanelSegment]	segments )

Reimplemented from hyperx.api.ZoneJointContainer.

RemoveZone() [1/3]

CollectionModificationStatus hyperx.api.Structure.RemoveZone	(		self,
		int	id )

Reimplemented from hyperx.api.ZoneJointContainer.

RemoveZone() [2/3]

CollectionModificationStatus hyperx.api.Structure.RemoveZone	(		self,
			item1 = None )

Reimplemented from hyperx.api.ZoneJointContainer.

RemoveZone() [3/3]

CollectionModificationStatus hyperx.api.Structure.RemoveZone	(		self,
		Zone	zone )

Reimplemented from hyperx.api.ZoneJointContainer.

RemoveZones() [1/3]

CollectionModificationStatus hyperx.api.Structure.RemoveZones	(		self,
			item1 = None )

Sends provided zones back to unused FEM

Reimplemented from hyperx.api.ZoneJointContainer.

RemoveZones() [2/3]

CollectionModificationStatus hyperx.api.Structure.RemoveZones	(		self,
		tuple[int]	zoneIds )

Sends provided zones back to unused FEM.

Reimplemented from hyperx.api.ZoneJointContainer.

RemoveZones() [3/3]

CollectionModificationStatus hyperx.api.Structure.RemoveZones	(		self,
		tuple[Zone]	zones )

Reimplemented from hyperx.api.ZoneJointContainer.

Property Documentation

Joints

hyperx.api.Structure.Joints = property

static

PanelSegments

hyperx.api.Structure.PanelSegments = property

static

ParentFolder

hyperx.api.Structure.ParentFolder = property

static

Plies

hyperx.api.Structure.Plies = property

static

Zones

hyperx.api.Structure.Zones = property

static

---

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

• C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py