hyperx.api.DesignVariable Class Reference

Inheritance diagram for hyperx.api.DesignVariable:

Public Member Functions
	__init__ (self, _api.DesignVariable designVariable)
None	AddMaterials (self, item1=None)
None	AddMaterials (self, set[int] materialIds)
	Add sizing materials by material Id.
None	AddMaterials (self, set[str] materialNames)
	Add sizing materials by material Name.
int|None	GetAnalysisMaterial (self)
	Get the material used for analysis, if it exists.
list[int]	GetSizingMaterials (self)
	Get a list of material Ids used for sizing, if they exist.
None	RemoveAnalysisMaterial (self)
	Remove the analysis material assigned to this variable.
None	RemoveSizingMaterials (self, tuple[int] materialIds=None)
	Remove sizing materials assigned to this variable by a collection of Ids.
Public Member Functions inherited from hyperx.api.IdEntity
	__init__ (self, _api.IdEntity idEntity)

Properties
	AllowMaterials = property
	Returns True if this item supports assigning materials.
	AnalysisMaterial = property
	Get and set analysis material by name.
	AnalysisMaterialType = property
	Get analysis material type.
	AnalysisValue = property
	Get and set analysis value You cannot set an analysis value if your analysis material is a laminate hyperx.api.types.MaterialType.
	IsDependentVariable = property
	Returns True if this design variable is dependent on other design variables.
	Max = property
	Maximum bound for this row.
	Min = property
	Minimum bound for this row.
	Name = property
	Overrides = property
	Collection of overrides by zone for the design variable.
	SizingMaterialType = property
	Get sizing material type.
	StepSize = property
	Step size for this row.
	UseAnalysis = property
	Use Analysis for Sizing while in Detailed Sizing.
	VariableParameter = property
Properties inherited from hyperx.api.IdEntity
	Id = property

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

Constructor & Destructor Documentation

__init__()

hyperx.api.DesignVariable.__init__	(		self,
		_api.DesignVariable	designVariable )

Member Function Documentation

AddMaterials() [1/3]

None hyperx.api.DesignVariable.AddMaterials	(		self,
			item1 = None )

Add sizing materials by material Id.

Add sizing materials by material Name.

AddMaterials() [2/3]

None hyperx.api.DesignVariable.AddMaterials	(		self,
		set[int]	materialIds )

Add sizing materials by material Id.

AddMaterials() [3/3]

None hyperx.api.DesignVariable.AddMaterials	(		self,
		set[str]	materialNames )

Add sizing materials by material Name.

GetAnalysisMaterial()

int | None hyperx.api.DesignVariable.GetAnalysisMaterial

(

self

)

Get the material used for analysis, if it exists.

GetSizingMaterials()

list[int] hyperx.api.DesignVariable.GetSizingMaterials

(

self

)

Get a list of material Ids used for sizing, if they exist.

RemoveAnalysisMaterial()

None hyperx.api.DesignVariable.RemoveAnalysisMaterial

(

self

)

Remove the analysis material assigned to this variable.

RemoveSizingMaterials()

None hyperx.api.DesignVariable.RemoveSizingMaterials	(		self,
		tuple[int]	materialIds = None )

Remove sizing materials assigned to this variable by a collection of Ids.

Parameters

materialIds

If not specified, remove all materials.

Property Documentation

AllowMaterials

hyperx.api.DesignVariable.AllowMaterials = property

static

Returns True if this item supports assigning materials.

AnalysisMaterial

hyperx.api.DesignVariable.AnalysisMaterial = property

static

Get and set analysis material by name.

AnalysisMaterialType

hyperx.api.DesignVariable.AnalysisMaterialType = property

static

Get analysis material type.

AnalysisValue

hyperx.api.DesignVariable.AnalysisValue = property

static

Get and set analysis value You cannot set an analysis value if your analysis material is a laminate hyperx.api.types.MaterialType.

In the case of a laminate, the analysis value is derived from thickness, and setting it will throw an error.

IsDependentVariable

hyperx.api.DesignVariable.IsDependentVariable = property

static

Returns True if this design variable is dependent on other design variables.

Max

hyperx.api.DesignVariable.Max = property

static

Maximum bound for this row.

You cannot set a Max if your hyperx.api.DesignVariable.SizingMaterialType is a laminate hyperx.api.types.MaterialType. In the case of laminates, the Max is determined by the laminate thickness, and setting it will throw an error.

Min

hyperx.api.DesignVariable.Min = property

static

Minimum bound for this row.

You cannot set a Min if your hyperx.api.DesignVariable.SizingMaterialType is a laminate hyperx.api.types.MaterialType. In the case of laminates, the Min is determined by the laminate thickness, and setting it will throw an error.

Name

hyperx.api.DesignVariable.Name = property

static

Overrides

hyperx.api.DesignVariable.Overrides = property

static

Collection of overrides by zone for the design variable.

SizingMaterialType

hyperx.api.DesignVariable.SizingMaterialType = property

static

Get sizing material type.

StepSize

hyperx.api.DesignVariable.StepSize = property

static

Step size for this row.

You cannot set a StepSize if your hyperx.api.DesignVariable.SizingMaterialType is a laminate hyperx.api.types.MaterialType. In the case of laminates, the StepSize is None, and setting it will throw an error.

UseAnalysis

hyperx.api.DesignVariable.UseAnalysis = property

static

Use Analysis for Sizing while in Detailed Sizing.

VariableParameter

hyperx.api.DesignVariable.VariableParameter = property

static

---

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

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