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)
None	AddMaterials (self, set[str] materialNames)
int	GetAnalysisMaterial (self)
	Get the material used for analysis, if it exists.
list[int]	GetSizingMaterials (self)
	Get a list of materials used for sizing, if they exist.
None	RemoveAnalysisMaterial (self)
	Remove the analysis material assigned to this variable.
None	RemoveSizingMaterials (self, tuple[int] materialIds=None)
Public Member Functions inherited from hyperx.api.IdEntity
	__init__ (self, _api.IdEntity idEntity)

Properties
	AllowMaterials = property
	AnalysisMaterial = property
	AnalysisMaterialType = property
	AnalysisValue = property
	Max = property
	Min = property
	Name = property
	Overrides = property
	SizingMaterialType = property
	StepSize = property
	UseAnalysis = property
	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 )

AddMaterials() [2/3]

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

AddMaterials() [3/3]

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

GetAnalysisMaterial()

int 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 materials 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 )

Property Documentation

AllowMaterials

hyperx.api.DesignVariable.AllowMaterials = property

static

AnalysisMaterial

hyperx.api.DesignVariable.AnalysisMaterial = property

static

AnalysisMaterialType

hyperx.api.DesignVariable.AnalysisMaterialType = property

static

AnalysisValue

hyperx.api.DesignVariable.AnalysisValue = property

static

Max

hyperx.api.DesignVariable.Max = property

static

Min

hyperx.api.DesignVariable.Min = property

static

Name

hyperx.api.DesignVariable.Name = property

static

Overrides

hyperx.api.DesignVariable.Overrides = property

static

SizingMaterialType

hyperx.api.DesignVariable.SizingMaterialType = property

static

StepSize

hyperx.api.DesignVariable.StepSize = property

static

UseAnalysis

hyperx.api.DesignVariable.UseAnalysis = property

static

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