hyperx.api.DesignLoadCol Class Reference

Inheritance diagram for hyperx.api.DesignLoadCol:

Public Member Functions
	__getitem__ (self, int index)
	__init__ (self, _api.DesignLoadCol designLoadCol)
	__iter__ (self)
	__len__ (self)
None	ClearOverrides (self)
	Remove all design load overrides from the database.
DesignLoad	Create (self, item1=None, item2=None, item3=None, item4=None, item5=None, item6=None, item7=None, item8=None)
DesignLoad	Create (self, str name, str description, list[DesignLoadSubcase] designLoadSubcases)
	Use hyperx.api.Project.DesignLoadSubcases to find available subcases.
DesignLoad	Create (self, str name, str description, list[DesignLoadSubcase] designLoadSubcases, float limitFactor, float ultimateFactor, float multiplier)
	Use hyperx.api.Project.DesignLoadSubcases to find available subcases.
DesignLoad	Create (self, str name, str description, list[DesignLoadSubcase] designLoadSubcases, float limitFactor, float ultimateFactor, float multiplier, float analysisTemperature)
	Use hyperx.api.Project.DesignLoadSubcases to find available subcases.
DesignLoad	Create (self, str name, str description, list[DesignLoadSubcase] designLoadSubcases, float limitFactor, float ultimateFactor, float multiplier, float analysisTemperature, types.LoadCaseType loadCaseType)
	Use hyperx.api.Project.DesignLoadSubcases to find available subcases.
list[DesignLoad]	Create (self, tuple[DesignLoadDefinition] designLoads)
	Create multiple hyperx.api.DesignLoad in bulk.
types.SimpleStatus	Delete (self, int designLoadId)
types.SimpleStatus	Delete (self, item1=None)
types.SimpleStatus	Delete (self, str designLoadName)
DesignLoadDefinition	GenerateDesignLoadDefinition (self, str name, str description, tuple[DesignLoadSubcase] subcases)
	This constructs a hyperx.api.DesignLoadDefinition object for use in hyperx.api.DesignLoadCol.Create(System.Collections.Generic.IEnumerable{hyperx.api.DesignLoadDefinition}).
DesignLoad	Get (self, int id)
DesignLoad	Get (self, item1=None)
DesignLoad	Get (self, str name)
DesignLoadBulkUpdater	GetBulkUpdater (self)
	Get a hyperx.api.BulkUpdaterBase to bulk update entities in this collection.
list[ZoneDesignLoadOverride]	GetOverrides (self)
	Get the full zone design load overrides table.
list[ZoneDesignLoadOverride]	GetOverridesForDesignLoads (self, set[str] designLoads)
	Get the zone design load overrides for a set of design loads.
list[ZoneDesignLoadOverride]	GetOverridesForZoneDesignLoadKeys (self, set[ZoneDesignLoadKey] keys)
	Get the zone design load overrides for the given set of hyperx.api.ZoneDesignLoadKey keys.
list[ZoneDesignLoadOverride]	GetOverridesForZones (self, set[int] zoneIds)
	Get the zone design load overrides for a set of zones.
None	ReplaceOverrides (self, list[ZoneDesignLoadOverride] overrides)
	Persist changes made to a list of hyperx.api.ZoneDesignLoadOverride objects to the database.
types.SimpleStatus	SetIsActiveById (self, set[int] designLoads, bool isActive)
	Set the hyperx.api.DesignLoad.IsActive></see> flag for a set of hyperx.api.DesignLoad>based on the isActive parameter.
types.SimpleStatus	SetIsActiveByName (self, set[str] designLoads, bool isActive)
	Set the hyperx.api.DesignLoad.IsActive></see> flag for a set of hyperx.api.DesignLoad>based on the isActive parameter.
None	SetOverrides (self, list[ZoneDesignLoadOverride] overrides)
	Persist changes made to a list of hyperx.api.ZoneDesignLoadOverride objects to the database.
Public Member Functions inherited from hyperx.api.IdNameEntityCol
	__init__ (self, _api.IdNameEntityCol idNameEntityCol)
Public Member Functions inherited from hyperx.api.IdEntityCol
	__init__ (self, _api.IdEntityCol idEntityCol)
bool	Contains (self, int id)
int	Count (self)

Properties
	DesignLoadColList = property
	FilterOptions = property
	Options to determine how design load filtering is applied or updated during sizing and analysis.
Properties inherited from hyperx.api.IdNameEntityCol
	Names = property
Properties inherited from hyperx.api.IdEntityCol
	Ids = property

Additional Inherited Members
Protected Attributes inherited from hyperx.api.IdNameEntityCol
	_CollectedClass = T
Protected Attributes inherited from hyperx.api.IdEntityCol
	_Entity = idEntityCol

Constructor & Destructor Documentation

__init__()

hyperx.api.DesignLoadCol.__init__	(		self,
		_api.DesignLoadCol	designLoadCol )

Member Function Documentation

__getitem__()

hyperx.api.DesignLoadCol.__getitem__	(		self,
		int	index )

__iter__()

hyperx.api.DesignLoadCol.__iter__

(

self

)

__len__()

hyperx.api.DesignLoadCol.__len__

(

self

)

ClearOverrides()

None hyperx.api.DesignLoadCol.ClearOverrides

(

self

)

Remove all design load overrides from the database.

Create() [1/6]

DesignLoad hyperx.api.DesignLoadCol.Create	(		self,
			item1 = None,
			item2 = None,
			item3 = None,
			item4 = None,
			item5 = None,
			item6 = None,
			item7 = None,
			item8 = None )

Use hyperx.api.Project.DesignLoadSubcases to find available subcases.

Use hyperx.api.Project.DesignLoadSubcases to find available subcases.

Use hyperx.api.Project.DesignLoadSubcases to find available subcases.

Use hyperx.api.Project.DesignLoadSubcases to find available subcases.

Create multiple hyperx.api.DesignLoad in bulk. Use hyperx.api.DesignLoadCol.GenerateDesignLoadDefinition(System.String,System.String,System.Collections.Generic.IEnumerable{hyperx.api.DesignLoadSubcase}) or hyperx.api.DesignLoadDefinition.Generate(System.String,System.String,System.Collections.Generic.IEnumerable{hyperx.api.DesignLoadSubcase}) to create hyperx.api.DesignLoadDefinition objects.

Create() [2/6]

DesignLoad hyperx.api.DesignLoadCol.Create	(		self,
		str	name,
		str	description,
		list[DesignLoadSubcase]	designLoadSubcases )

Use hyperx.api.Project.DesignLoadSubcases to find available subcases.

Create() [3/6]

DesignLoad hyperx.api.DesignLoadCol.Create	(		self,
		str	name,
		str	description,
		list[DesignLoadSubcase]	designLoadSubcases,
		float	limitFactor,
		float	ultimateFactor,
		float	multiplier )

Use hyperx.api.Project.DesignLoadSubcases to find available subcases.

Create() [4/6]

DesignLoad hyperx.api.DesignLoadCol.Create	(		self,
		str	name,
		str	description,
		list[DesignLoadSubcase]	designLoadSubcases,
		float	limitFactor,
		float	ultimateFactor,
		float	multiplier,
		float	analysisTemperature )

Use hyperx.api.Project.DesignLoadSubcases to find available subcases.

Create() [5/6]

DesignLoad hyperx.api.DesignLoadCol.Create	(		self,
		str	name,
		str	description,
		list[DesignLoadSubcase]	designLoadSubcases,
		float	limitFactor,
		float	ultimateFactor,
		float	multiplier,
		float	analysisTemperature,
		types.LoadCaseType	loadCaseType )

Use hyperx.api.Project.DesignLoadSubcases to find available subcases.

Create() [6/6]

list[DesignLoad] hyperx.api.DesignLoadCol.Create	(		self,
		tuple[DesignLoadDefinition]	designLoads )

Create multiple hyperx.api.DesignLoad in bulk.

Use hyperx.api.DesignLoadCol.GenerateDesignLoadDefinition(System.String,System.String,System.Collections.Generic.IEnumerable{hyperx.api.DesignLoadSubcase}) or hyperx.api.DesignLoadDefinition.Generate(System.String,System.String,System.Collections.Generic.IEnumerable{hyperx.api.DesignLoadSubcase}) to create hyperx.api.DesignLoadDefinition objects.

Delete() [1/3]

types.SimpleStatus hyperx.api.DesignLoadCol.Delete	(		self,
		int	designLoadId )

Delete() [2/3]

types.SimpleStatus hyperx.api.DesignLoadCol.Delete	(		self,
			item1 = None )

Delete() [3/3]

types.SimpleStatus hyperx.api.DesignLoadCol.Delete	(		self,
		str	designLoadName )

GenerateDesignLoadDefinition()

DesignLoadDefinition hyperx.api.DesignLoadCol.GenerateDesignLoadDefinition	(		self,
		str	name,
		str	description,
		tuple[DesignLoadSubcase]	subcases )

This constructs a hyperx.api.DesignLoadDefinition object for use in hyperx.api.DesignLoadCol.Create(System.Collections.Generic.IEnumerable{hyperx.api.DesignLoadDefinition}).

Calling this method on its own without a call to a hyperx.api.DesignLoadCol.Create(System.Collections.Generic.IEnumerable{hyperx.api.DesignLoadDefinition}) method does not add a design load to the database.

Get() [1/3]

DesignLoad hyperx.api.DesignLoadCol.Get	(		self,
		int	id )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [2/3]

DesignLoad hyperx.api.DesignLoadCol.Get	(		self,
			item1 = None )

Reimplemented from hyperx.api.IdNameEntityCol.

Get() [3/3]

DesignLoad hyperx.api.DesignLoadCol.Get	(		self,
		str	name )

Reimplemented from hyperx.api.IdNameEntityCol.

GetBulkUpdater()

DesignLoadBulkUpdater hyperx.api.DesignLoadCol.GetBulkUpdater

(

self

)

Get a hyperx.api.BulkUpdaterBase to bulk update entities in this collection.

Also available via the DesignLoadBulkUpdater.GetBulkUpdater() static method.

Returns

Returns a hyperx.api.DesignLoadBulkUpdater to bulk update hyperx.api.DesignLoad entities in this collection.

GetOverrides()

list[ZoneDesignLoadOverride] hyperx.api.DesignLoadCol.GetOverrides

(

self

)

Get the full zone design load overrides table.

Editing the hyperx.api.ZoneDesignLoadOverride objects will not immediately persist changes to the database.

GetOverridesForDesignLoads()

list[ZoneDesignLoadOverride] hyperx.api.DesignLoadCol.GetOverridesForDesignLoads	(		self,
		set[str]	designLoads )

Get the zone design load overrides for a set of design loads.

Editing the hyperx.api.ZoneDesignLoadOverride objects will not immediately persist changes to the database.

GetOverridesForZoneDesignLoadKeys()

list[ZoneDesignLoadOverride] hyperx.api.DesignLoadCol.GetOverridesForZoneDesignLoadKeys	(		self,
		set[ZoneDesignLoadKey]	keys )

Get the zone design load overrides for the given set of hyperx.api.ZoneDesignLoadKey keys.

Editing the hyperx.api.ZoneDesignLoadOverride objects will not immediately persist changes to the database.

Parameters

keys	A set of zone, design load pairings for which overrides are requested.

Exceptions

InvalidOperationException

An exception is thrown if any zones or design loads are not present in the database.

GetOverridesForZones()

list[ZoneDesignLoadOverride] hyperx.api.DesignLoadCol.GetOverridesForZones	(		self,
		set[int]	zoneIds )

Get the zone design load overrides for a set of zones.

Editing the hyperx.api.ZoneDesignLoadOverride objects will not immediately persist changes to the database.

ReplaceOverrides()

None hyperx.api.DesignLoadCol.ReplaceOverrides	(		self,
		list[ZoneDesignLoadOverride]	overrides )

Persist changes made to a list of hyperx.api.ZoneDesignLoadOverride objects to the database.

Any existing design load overrides that don't have a corresponding element in the list will be removed.

SetIsActiveById()

types.SimpleStatus hyperx.api.DesignLoadCol.SetIsActiveById	(		self,
		set[int]	designLoads,
		bool	isActive )

Set the hyperx.api.DesignLoad.IsActive></see> flag for a set of hyperx.api.DesignLoad>based on the isActive parameter.

SetIsActiveByName()

types.SimpleStatus hyperx.api.DesignLoadCol.SetIsActiveByName	(		self,
		set[str]	designLoads,
		bool	isActive )

Set the hyperx.api.DesignLoad.IsActive></see> flag for a set of hyperx.api.DesignLoad>based on the isActive parameter.

SetOverrides()

None hyperx.api.DesignLoadCol.SetOverrides	(		self,
		list[ZoneDesignLoadOverride]	overrides )

Persist changes made to a list of hyperx.api.ZoneDesignLoadOverride objects to the database.

Any existing design load overrides that don't have a corresponding element in the list will be unchanged.

Property Documentation

DesignLoadColList

hyperx.api.DesignLoadCol.DesignLoadColList = property

static

FilterOptions

hyperx.api.DesignLoadCol.FilterOptions = property

static

Options to determine how design load filtering is applied or updated during sizing and analysis.

---

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

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