hyperx.api.DesignLoadSubcaseTemperature Class Reference

Inheritance diagram for hyperx.api.DesignLoadSubcaseTemperature:

Public Member Functions
	__init__ (self, _api.DesignLoadSubcaseTemperature designLoadSubcaseTemperature)
types.SimpleStatus	SetChoiceToAnalysis (self)
	Update hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType to hyperx.api.types.TemperatureChoiceType.Analysis.
types.SimpleStatus	SetSubcase (self, DesignLoadSubcase subcase)
	Update hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType to hyperx.api.types.TemperatureChoiceType.Subcase and set hyperx.api.DesignLoadSubcaseTemperature.Subcase to subcase.
types.SimpleStatus	SetTemperatureProfile (self, DesignLoadTemperatureProfile profile)
	Update hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType to hyperx.api.types.TemperatureChoiceType.Profile and set hyperx.api.DesignLoadSubcaseTemperature.TemperatureProfile to profile.
types.SimpleStatus	SetValue (self, float temperature)
	Update hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType to hyperx.api.types.TemperatureChoiceType.Value and set hyperx.api.DesignLoadSubcaseTemperature.Value to temperature.
Public Member Functions inherited from hyperx.api.IdNameEntity
	__init__ (self, _api.IdNameEntity idNameEntity)
Public Member Functions inherited from hyperx.api.IdEntity
	__init__ (self, _api.IdEntity idEntity)

Properties
	HasTemperatureSubcase = property
	If the analysis temperature does not have an associated load set id (i.e.
	Id = property
	IsEditable = property
	Subcase = property
	Selected thermal subcases when hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType is set to hyperx.api.types.TemperatureChoiceType.Subcase.
	TemperatureChoiceType = property
	Get temperature choice type.
	TemperatureChoiceTypes = property
	Available temperature choice types for this temperature.
	TemperatureProfile = property
	Selected temperature profile when hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType is set to hyperx.api.types.TemperatureChoiceType.Profile.
	ThermalSubcases = property
	Available thermal subcases when hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType is set to hyperx.api.types.TemperatureChoiceType.Subcase.
	Value = property
	Get temperature value.
Properties inherited from hyperx.api.IdNameEntity
	Name = property

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

Constructor & Destructor Documentation

__init__()

hyperx.api.DesignLoadSubcaseTemperature.__init__	(		self,
		_api.DesignLoadSubcaseTemperature	designLoadSubcaseTemperature )

Member Function Documentation

SetChoiceToAnalysis()

types.SimpleStatus hyperx.api.DesignLoadSubcaseTemperature.SetChoiceToAnalysis

(

self

)

Update hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType to hyperx.api.types.TemperatureChoiceType.Analysis.

Returns

Status based on whether the operation was allowed.

SetSubcase()

types.SimpleStatus hyperx.api.DesignLoadSubcaseTemperature.SetSubcase	(		self,
		DesignLoadSubcase	subcase )

Update hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType to hyperx.api.types.TemperatureChoiceType.Subcase and set hyperx.api.DesignLoadSubcaseTemperature.Subcase to subcase.

Returns

Status based on whether the operation was allowed.

SetTemperatureProfile()

types.SimpleStatus hyperx.api.DesignLoadSubcaseTemperature.SetTemperatureProfile	(		self,
		DesignLoadTemperatureProfile	profile )

Update hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType to hyperx.api.types.TemperatureChoiceType.Profile and set hyperx.api.DesignLoadSubcaseTemperature.TemperatureProfile to profile.

SetValue()

types.SimpleStatus hyperx.api.DesignLoadSubcaseTemperature.SetValue	(		self,
		float	temperature )

Update hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType to hyperx.api.types.TemperatureChoiceType.Value and set hyperx.api.DesignLoadSubcaseTemperature.Value to temperature.

Returns

Status based on whether the operation was allowed.

Property Documentation

HasTemperatureSubcase

hyperx.api.DesignLoadSubcaseTemperature.HasTemperatureSubcase = property

static

If the analysis temperature does not have an associated load set id (i.e.

the TemperatureChoiceType is equal to Value or Profile), the Id will be set to 0 and this field will be false

Id

hyperx.api.DesignLoadSubcaseTemperature.Id = property

static

IsEditable

hyperx.api.DesignLoadSubcaseTemperature.IsEditable = property

static

Subcase

hyperx.api.DesignLoadSubcaseTemperature.Subcase = property

static

Selected thermal subcases when hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType is set to hyperx.api.types.TemperatureChoiceType.Subcase.

TemperatureChoiceType

hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType = property

static

Get temperature choice type.

TemperatureChoiceTypes

hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceTypes = property

static

Available temperature choice types for this temperature.

TemperatureProfile

hyperx.api.DesignLoadSubcaseTemperature.TemperatureProfile = property

static

Selected temperature profile when hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType is set to hyperx.api.types.TemperatureChoiceType.Profile.

ThermalSubcases

hyperx.api.DesignLoadSubcaseTemperature.ThermalSubcases = property

static

Available thermal subcases when hyperx.api.DesignLoadSubcaseTemperature.TemperatureChoiceType is set to hyperx.api.types.TemperatureChoiceType.Subcase.

Value

hyperx.api.DesignLoadSubcaseTemperature.Value = property

static

Get temperature value.

---

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

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