hyperx.api.ZoneJointContainer Class Reference

Represents an entity that contains a collection of Zones and Joints. More...

Inheritance diagram for hyperx.api.ZoneJointContainer:

Public Member Functions
	__init__ (self, _api.ZoneJointContainer zoneJointContainer)
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)
	Add an existing panel segment to this entity.
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.
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)
CollectionModificationStatus	RemoveZones (self, tuple[Zone] zones)
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)

Static Protected Attributes
	_Centroid

Properties
	Centroid = property
	Centroid center determined by weight.
	Joints = property
	PanelSegments = property
	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.
	Zones = property
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

Detailed Description

Represents an entity that contains a collection of Zones and Joints.

Constructor & Destructor Documentation

__init__()

hyperx.api.ZoneJointContainer.__init__	(		self,
		_api.ZoneJointContainer	zoneJointContainer )

Member Function Documentation

AddJoint() [1/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

AddJoint() [2/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

AddJoint() [3/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

AddPanelSegment() [1/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

AddPanelSegment() [2/3]

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

Add an existing panel segment to this entity

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

AddPanelSegment() [3/3]

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

Add an existing panel segment to this entity.

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

AddZone() [1/3]

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

Add an existing zone to this entity.

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

AddZone() [2/3]

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

Add an existing zone to this entity.

Add an existing zone to this entity.

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

AddZone() [3/3]

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

Add an existing zone to this entity.

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

AddZones() [1/3]

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

Add existing zones to this entity.

Add existing zones to this entity

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

AddZones() [2/3]

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

Add existing zones to this entity.

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

AddZones() [3/3]

CollectionModificationStatus hyperx.api.ZoneJointContainer.AddZones	(		self,
		tuple[Zone]	zones )

Add existing zones to this entity.

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemoveJoint() [1/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemoveJoint() [2/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemoveJoint() [3/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemoveJoints() [1/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemoveJoints() [2/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemoveJoints() [3/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemovePanelSegment() [1/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemovePanelSegment() [2/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemovePanelSegment() [3/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemovePanelSegments() [1/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemovePanelSegments() [2/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemovePanelSegments() [3/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemoveZone() [1/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemoveZone() [2/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemoveZone() [3/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemoveZones() [1/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemoveZones() [2/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

RemoveZones() [3/3]

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

Reimplemented in hyperx.api.Set, hyperx.api.Set, hyperx.api.Set, hyperx.api.Structure, hyperx.api.Structure, and hyperx.api.Structure.

Member Data Documentation

_Centroid

hyperx.api.ZoneJointContainer._Centroid

staticprotected

Property Documentation

Centroid

hyperx.api.ZoneJointContainer.Centroid = property

static

Centroid center determined by weight.

Joints

hyperx.api.ZoneJointContainer.Joints = property

static

PanelSegments

hyperx.api.ZoneJointContainer.PanelSegments = property

static

TotalBeamLength

hyperx.api.ZoneJointContainer.TotalBeamLength = property

static

Summation of beam lengths.

TotalPanelArea

hyperx.api.ZoneJointContainer.TotalPanelArea = property

static

Summation of panel areas.

TotalZoneWeight

hyperx.api.ZoneJointContainer.TotalZoneWeight = property

static

Get the total weight of all zones contained in this object.

Zones

hyperx.api.ZoneJointContainer.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