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)
DesignLoad	Get (self, int id)
DesignLoad	Get (self, item1=None)
DesignLoad	Get (self, str name)
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.
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

)

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.

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.

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