hyperx.api.ZoneOverride Class Reference

Inheritance diagram for hyperx.api.ZoneOverride:

Public Member Functions
	__init__ (self, _api.ZoneOverride zoneOverride)
Public Member Functions inherited from hyperx.api.IdEntity
	__init__ (self, _api.IdEntity idEntity)

Properties
	AllowMaterials = property
	AnalysisMaterial = property
	Get and set the analysis material by name.
	AnalysisMaterialType = property
	AnalysisValue = property
	Get and set analysis value.
	ConceptId = property
	The hyperx.api.ZoneDesignProperty.ConceptId associated with this override.
	DesignId = property
	The hyperx.api.DesignVariable Id associated with this override.
	FamilyId = property
	The hyperx.api.types.BeamPanelFamily Id associated with this override.
	InputMode = property
	MaxBound = property
	Maximum sizing bound for this override.
	MaxPlies = property
	Ply-based sizing max bound for this override.
	MinBound = property
	Minimum sizing bound for this override.
	MinPlies = property
	Ply-based sizing min bound for this override.
	PlyStepSize = property
	Ply-based sizing step size for this override.
	ProjectId = property
	SizingMaterials = property
	Collection of hyperx.api.SizingMaterial candidates.
	StepSize = property
	Sizing step size for this override.
	VariableId = property
	The hyperx.api.DesignVariable Id associated with this override.
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.ZoneOverride.__init__	(		self,
		_api.ZoneOverride	zoneOverride )

Property Documentation

AllowMaterials

hyperx.api.ZoneOverride.AllowMaterials = property

static

AnalysisMaterial

hyperx.api.ZoneOverride.AnalysisMaterial = property

static

Get and set the analysis material by name.

Exceptions

Exception

If no analysis material is set when trying to get the `hyperx.api.ZoneOverride.AnalysisMaterial`

AnalysisMaterialType

hyperx.api.ZoneOverride.AnalysisMaterialType = property

static

AnalysisValue

hyperx.api.ZoneOverride.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 None, and setting it will throw an error.

ConceptId

hyperx.api.ZoneOverride.ConceptId = property

static

The hyperx.api.ZoneDesignProperty.ConceptId associated with this override.

DesignId

hyperx.api.ZoneOverride.DesignId = property

static

The hyperx.api.DesignVariable Id associated with this override.

FamilyId

hyperx.api.ZoneOverride.FamilyId = property

static

The hyperx.api.types.BeamPanelFamily Id associated with this override.

InputMode

hyperx.api.ZoneOverride.InputMode = property

static

MaxBound

hyperx.api.ZoneOverride.MaxBound = property

static

Maximum sizing bound for this override.

You cannot set a hyperx.api.ZoneOverride.MaxBound if your override sizing materials are laminate hyperx.api.types.MaterialType. In the case of laminates, the hyperx.api.ZoneOverride.MaxBound is None, and setting it will throw an error.

MaxPlies

hyperx.api.ZoneOverride.MaxPlies = property

static

Ply-based sizing max bound for this override.

Applicable to Effective Laminate sizing where the sizing dimension is plies.

MinBound

hyperx.api.ZoneOverride.MinBound = property

static

Minimum sizing bound for this override.

You cannot set a hyperx.api.ZoneOverride.MinBound if your override sizing materials are laminate hyperx.api.types.MaterialType.

Exceptions

InvalidOperationException

In the case of laminates, the `hyperx.api.ZoneOverride.MinBound` is `None`, and setting it will throw an error.

MinPlies

hyperx.api.ZoneOverride.MinPlies = property

static

Ply-based sizing min bound for this override.

Applicable to Effective Laminate sizing where the sizing dimension is plies.

PlyStepSize

hyperx.api.ZoneOverride.PlyStepSize = property

static

Ply-based sizing step size for this override.

Applicable to Effective Laminate sizing where the sizing dimension is plies.

ProjectId

hyperx.api.ZoneOverride.ProjectId = property

static

SizingMaterials

hyperx.api.ZoneOverride.SizingMaterials = property

static

Collection of hyperx.api.SizingMaterial candidates.

StepSize

hyperx.api.ZoneOverride.StepSize = property

static

Sizing step size for this override.

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

VariableId

hyperx.api.ZoneOverride.VariableId = property

static

The hyperx.api.DesignVariable Id associated with this override.

---

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

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