Class HousingAPI

Namespace: VM.API.Pre.GearTrain
Assembly: VM.API.Pre.GearTrain.dll

This class implements APIs for Housing class.

public static class HousingAPI

Inheritance

object ← HousingAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects(object, LinkPropertyType)

Methods

CreateEFHousing(GearTrainDocument, string)

Create .

[NotNull(new string[] { "document" })]
public static Obj CreateEFHousing(this GearTrainDocument document, string housingName = "")

Parameters

document GearTrainDocument

The document to create the EF housing.

housingName string

The name of the EF housing. If empty, default name starts with 'Housing_' will be generated and used.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document' argument is empty.

CreateFEHousing(GearTrainDocument, string)

Create .

[NotNull(new string[] { "document" })]
public static Obj CreateFEHousing(this GearTrainDocument document, string housingName = "")

Parameters

document GearTrainDocument

The to create the FE housing.

housingName string

The name of the FE housing. If empty, default name starts with 'Housing_' will be generated and used.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document' argument is empty.

UpdateBodyInFE(HiddenDocumentFEBase, BodyAnalysisType)

Update nodal body in fe shaftset/housing designer.

[NotNull(new string[] { "document" })]
public static void UpdateBodyInFE(this HiddenDocumentFEBase document, BodyAnalysisType bodyAnalysisType)

Parameters

document HiddenDocumentFEBase

The to exist nodal body.

bodyAnalysisType BodyAnalysisType

The body analysis type.

Exceptions

ArgumentNullException

Will be thrown if 'document' or 'nodalBody' arguments are empty.

UpdateBodyInMeshFree(HiddenDocumentMeshFreeBase, BodyAnalysisType, MassPropertyType, ExpressionValueVariable?, IEnumerable)

Update assembled body in ef shaftset/housing designer.

[NotNull(new string[] { "document" })]
public static void UpdateBodyInMeshFree(this HiddenDocumentMeshFreeBase document, BodyAnalysisType bodyAnalysisType, SolidBodyProperty.MassPropertyType massPropertyType = MassPropertyType.PreDefined, ExpressionValueVariable? mass = null, IEnumerable<expressionvaluevariable> momentOfInertia = null)

Parameters

document HiddenDocumentMeshFreeBase

The to exist assembled body.

bodyAnalysisType BodyAnalysisType

The body analysis type.

massPropertyType SolidBodyProperty.MassPropertyType

The mass property type. The default value is PreDefined.

mass ExpressionValueVariable?

The mass when 'massPropertyType' is User. The default value is 1.

momentOfInertia IEnumerable

The moment of inertia when 'massPropertyType' is User.

Exceptions

ArgumentNullException

Will be thrown if 'document' or 'assembledBody' arguments are empty.

ArgumentNullException

Will be thrown if 'massPropertyType' is User and 'mass' or 'momentOfInertia' are empty.

ArgumentNullException

Will be thrown if the length of 'momentOfInertia' is not 6.

UpdateDesignerInMesh(HiddenDocumentMeshBase)

Update designer in fe/ef shaftset/housing.

[NotNull(new string[] { "document" })]
public static void UpdateDesignerInMesh(this HiddenDocumentMeshBase document)

Parameters

document HiddenDocumentMeshBase

The to update designer.

Exceptions

ArgumentNullException

Will be thrown if 'document' argument is empty.