HyperX.Scripting.Joint Class Reference

Inheritance diagram for HyperX.Scripting.Joint:

Public Member Functions
override AnalysisResultCol< AnalysisResult >	GetAllResults ()
override AnalysisResult	GetControllingResult ()
override AnalysisResultCol< AnalysisResult >	GetControllingResultsPerCriterion ()
override Margin	GetMinimumMargin ()
Public Member Functions inherited from HyperX.Scripting.ZoneJointEntity
AnalysisResultCol< AnalysisResult >	GetAllResults ()
	Obselete. Use GetControllingResultsPerCriterion instead.
AnalysisResult	GetControllingResult ()
AnalysisResultCol< AnalysisResult >	GetControllingResultsPerCriterion ()
Margin	GetMinimumMargin ()
Public Member Functions inherited from HyperX.Scripting.EntityWithAssignableProperties
PropertyAssignmentStatus	AssignAnalysisProperty (int id)
PropertyAssignmentStatus	AssignDesignProperty (int id)
PropertyAssignmentStatus	AssignLoadProperty (int id)
PropertyAssignmentStatus	AssignProperty (AssignableProperty property)
	Assign a Property to this entity.
Public Member Functions inherited from HyperX.Scripting.IdNameEntityRenameable
void	Rename (string name)

Protected Member Functions
override PropertyAssignmentStatus	AssignAnalysisPropertyToEntity (int id)
override PropertyAssignmentStatus	AssignDesignPropertyToEntity (Design design)
override PropertyAssignmentStatus	AssignLoadPropertyToEntity (int id)
override void	UpdateNameInDatabase (string name)
override bool	ValidateName (string name)
Protected Member Functions inherited from HyperX.Scripting.ZoneJointEntity
Dictionary< int, AnalysisDefinition >	GetAnalyses ()
Dictionary< Guid, AnalysisDefinition >	GetAnalysesByGuid ()
Protected Member Functions inherited from HyperX.Scripting.EntityWithAssignableProperties
PropertyAssignmentStatus	AssignAnalysisPropertyToEntity (int id)
PropertyAssignmentStatus	AssignDesignPropertyToEntity (HS.Types.Design design)
PropertyAssignmentStatus	AssignLoadPropertyToEntity (int id)
Protected Member Functions inherited from HyperX.Scripting.IdNameEntityRenameable
void	UpdateNameInDatabase (string name)
	Rename this entity in the database.
bool	ValidateName (string name)
	Return true if this name is valid to use, false otherwise.

Properties
JointDesignResultCol	JointRangeSizingResults [get]
JointDesignResultCol	JointSelectionSizingResults [get]
Properties inherited from HyperX.Scripting.EntityWithAssignableProperties
AnalysisProperty	AssignedAnalysisProperty [get]
	Get the analysis property assigned to this Entity. Returns null if none is assigned.
DesignProperty	AssignedDesignProperty [get]
	Get the design property assigned to this Entity. Returns null if none is assigned.
LoadProperty	AssignedLoadProperty [get]
	Get the load property assigned to this Entity. Returns null if none is assigned.
Properties inherited from HyperX.Scripting.IdNameEntity
string	Name [get, protected set]
Properties inherited from HyperX.Scripting.IdEntity
int	Id [get]

Additional Inherited Members
Protected Attributes inherited from HyperX.Scripting.EntityWithAssignableProperties
readonly Application	_application

Member Function Documentation

AssignAnalysisPropertyToEntity()

override PropertyAssignmentStatus HyperX.Scripting.Joint.AssignAnalysisPropertyToEntity ( int id )

protected

AssignDesignPropertyToEntity()

override PropertyAssignmentStatus HyperX.Scripting.Joint.AssignDesignPropertyToEntity ( Design design )

protected

AssignLoadPropertyToEntity()

override PropertyAssignmentStatus HyperX.Scripting.Joint.AssignLoadPropertyToEntity ( int id )

protected

GetAllResults()

override AnalysisResultCol< AnalysisResult > HyperX.Scripting.Joint.GetAllResults

(

)

GetControllingResult()

override AnalysisResult HyperX.Scripting.Joint.GetControllingResult

(

)

GetControllingResultsPerCriterion()

override AnalysisResultCol< AnalysisResult > HyperX.Scripting.Joint.GetControllingResultsPerCriterion

(

)

GetMinimumMargin()

override Margin HyperX.Scripting.Joint.GetMinimumMargin

(

)

UpdateNameInDatabase()

override void HyperX.Scripting.Joint.UpdateNameInDatabase ( string name )

protected

ValidateName()

override bool HyperX.Scripting.Joint.ValidateName ( string name )

protected

Property Documentation

JointRangeSizingResults

JointDesignResultCol HyperX.Scripting.Joint.JointRangeSizingResults

get

JointSelectionSizingResults

JointDesignResultCol HyperX.Scripting.Joint.JointSelectionSizingResults

get

---

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

• Joint/Joint.cs