Class GearSetAPI
Last update: 09.03.2026Namespace: VM.API.Pre.GearTrain
Assembly: VM.API.Pre.GearTrain.dll
This class implements APIs for
public static class GearSetAPI
Inheritance
object ← GearSetAPI
Extension Methods
LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)
Methods
CalculateBeamStiffness(HiddenGearSetRackAndPinionDocument)
Calculate beam stiffness.
[NotNull(new string[] { "document" })]
public static IEnumerable<double> CalculateBeamStiffness(this HiddenGearSetRackAndPinionDocument document)
Parameters
document HiddenGearSetRackAndPinionDocument
The
Returns
IEnumerable<double>
The 6 by 6 stiffness.
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
FileNotFoundException
Will be thrown if 'feDataFilePath' is not found.
CalculateToothStiffness(HiddenGearSetDocumentBase, int)
Calculate tooth stiffness in gear designer.
public static void CalculateToothStiffness(this HiddenGearSetDocumentBase document, int gearIdx)
Parameters
document HiddenGearSetDocumentBase
The
gearIdx int
The gear index.
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentOutOfRangeException
Will be thrown if 'gearIdx' argument is less than 0.
CalculateToothStiffness(GearTrainDocument, Obj, int)
Calculate tooth stiffness in gear train subsystem.
[NotNullObj(new string[] { "gearset" })]
public static void CalculateToothStiffness(this GearTrainDocument document, Obj gearset, int gearIdx)
Parameters
document GearTrainDocument
The
gearset Obj
The gearset. The type is
gearIdx int
The gear index.
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearset' arguments are empty.
ArgumentOutOfRangeException
Will be thrown if 'gearIdx' argument is less than 0.
ArgumentNullException
Will be thrown if type of 'gearset' is not
CalculateToothStiffnessForCycloid(HiddenGearSetCycloidPinDocument, int)
Calculate tooth stiffness for cycloid in gear designer.
public static void CalculateToothStiffnessForCycloid(this HiddenGearSetCycloidPinDocument document, int gearIdx)
Parameters
document HiddenGearSetCycloidPinDocument
The
gearIdx int
The gear index.
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentOutOfRangeException
Will be thrown if 'gearIdx' argument is less than 0.
CalculateToothStiffnessForCycloid(GearTrainDocument, Obj, int)
Calculate tooth stiffness for cycloid in gear train subsystem.
[NotNullObj(new string[] { "gearset" })]
public static void CalculateToothStiffnessForCycloid(this GearTrainDocument document, Obj gearset, int gearIdx)
Parameters
document GearTrainDocument
The
gearset Obj
The gearset. The type is
gearIdx int
The gear index.
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearset' arguments are empty.
ArgumentOutOfRangeException
Will be thrown if 'gearIdx' argument is less than 0.
ArgumentNullException
Will be thrown if type of 'gearset' is not
CalculateToothStiffnessForRackAndPinion(HiddenGearSetRackAndPinionDocument, int)
Calculate tooth stiffness for rack and pinion in gear designer.
public static void CalculateToothStiffnessForRackAndPinion(this HiddenGearSetRackAndPinionDocument document, int gearIdx)
Parameters
document HiddenGearSetRackAndPinionDocument
The
gearIdx int
The gear index.
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentOutOfRangeException
Will be thrown if 'gearIdx' argument is less than 0.
CalculateToothStiffnessForRackAndPinion(GearTrainDocument, Obj, int)
Calculate tooth stiffness for rack and pinion in gear train subsystem.
[NotNullObj(new string[] { "gearset" })]
public static void CalculateToothStiffnessForRackAndPinion(this GearTrainDocument document, Obj gearset, int gearIdx)
Parameters
document GearTrainDocument
The
gearset Obj
The gearset. The type is
gearIdx int
The gear index.
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearset' arguments are empty.
ArgumentOutOfRangeException
Will be thrown if 'gearIdx' argument is less than 0.
ArgumentNullException
Will be thrown if type of 'gearset' is not
CalculateWebStiffnessForEF(HiddenGearSetDocumentBase, string, int, ExpressionValueVariable, ExpressionValueVariable)
Calculate ef web stiffness for EF in gear designer.
[ExistFile(new string[] { "cadDataFilePath" })]
public static (double, IEnumerable<double>, IEnumerable<double>) CalculateWebStiffnessForEF(this HiddenGearSetDocumentBase document, string cadDataFilePath, int gearIdx, ExpressionValueVariable angle, ExpressionValueVariable offset)
Parameters
document HiddenGearSetDocumentBase
The
cadDataFilePath string
The cad data file path.
gearIdx int
The gear index.
angle ExpressionValueVariable
The angle.
offset ExpressionValueVariable
The offset.
Returns
(double, IEnumerable<double>, IEnumerable<double>)
The mass, moment of inertia(Ixx, Ixy, Ixz, Iyy, Iyz, Izz), 6 by 6 stiffness.
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
FileNotFoundException
Will be thrown if 'feDataFilePath' is not found.
ArgumentOutOfRangeException
Will be thrown if 'gearIdx' argument is less than 0.
CalculateWebStiffnessForFE(HiddenGearSetDocumentBase, string, int, ExpressionValueVariable, ExpressionValueVariable)
Calculate fe web stiffness for FE in gear designer.
[ExistFile(new string[] { "feDataFilePath" })]
public static (double, IEnumerable<double>, IEnumerable<double>) CalculateWebStiffnessForFE(this HiddenGearSetDocumentBase document, string feDataFilePath, int gearIdx, ExpressionValueVariable angle, ExpressionValueVariable offset)
Parameters
document HiddenGearSetDocumentBase
The
feDataFilePath string
The fe data file path.
gearIdx int
The gear index.
angle ExpressionValueVariable
The angle.
offset ExpressionValueVariable
The offset.
Returns
(double, IEnumerable<double>, IEnumerable<double>)
The mass, moment of inertia(Ixx, Ixy, Ixz, Iyy, Iyz, Izz), 6 by 6 stiffness.
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
FileNotFoundException
Will be thrown if 'feDataFilePath' is not found.
ArgumentOutOfRangeException
Will be thrown if 'gearIdx' argument is less than 0.
ContactAnalysis(HiddenGearSetDocumentBase, int, ExpressionValueVariable, ExpressionValueVariable, ExpressionValueVariable, bool, ContactAnalysisInputType, ContactAnalysisInputType)
Contact analysis In gearset designer.
[NotNull(new string[] { "document" })]
[GreaterThanOrEqualToZero(new string[] { "nGearPairIndex" })]
public static void ContactAnalysis(this HiddenGearSetDocumentBase document, int nGearPairIndex, ExpressionValueVariable speed, ExpressionValueVariable torque, ExpressionValueVariable ratio, bool openPost = false, PropertyGearSetPlanetary.ContactAnalysisInputType input = ContactAnalysisInputType.SunGear, PropertyGearSetPlanetary.ContactAnalysisInputType output = ContactAnalysisInputType.Carrier)
Parameters
document HiddenGearSetDocumentBase
The
nGearPairIndex int
The gear pair index.
speed ExpressionValueVariable
The speed.
torque ExpressionValueVariable
The torque.
ratio ExpressionValueVariable
The ratio.
openPost bool
The flag for whether opening post processor. The default value is false.
input PropertyGearSetPlanetary.ContactAnalysisInputType
The input type. The default value is SunGear.
output PropertyGearSetPlanetary.ContactAnalysisInputType
The output type. The default value is Carrier.
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentOutOfRangeException
Will be thrown if 'gearIdx' argument is less than 0.
CreateCrossHelicalGearSet(GearTrainDocument, string, HelicalAngleType, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<string>, ExpressionValueVariable?, Color?)
Create
[NotNull(new string[] { "document" })]
public static Obj CreateCrossHelicalGearSet(this GearTrainDocument document, string gearsetName = "", BasicInvolute.HelicalAngleType helicalAngleType = HelicalAngleType.Right, ExpressionValueVariable? module = null, ExpressionValueVariable? pressureAngle = null, ExpressionValueVariable? helixAngle = null, IEnumerable<ExpressionValueVariable> centerDistance = null, IEnumerable<ExpressionValueVariable> numberOfTeeth = null, IEnumerable<ExpressionValueVariable> profileShift = null, IEnumerable<ExpressionValueVariable> faceWidth = null, IEnumerable<string> gearName = null, ExpressionValueVariable? crossAxisAngle = null, Color? color = null)
Parameters
document GearTrainDocument
The document to create the cross helical gearset.
gearsetName string
The name of the gearset. If empty, default name starts with 'CrossHelicalGearSet_' will be generated and used.
helicalAngleType BasicInvolute.HelicalAngleType
The helical angle type. The default value is Right.
module ExpressionValueVariable?
The module. The default value is 3.046.
pressureAngle ExpressionValueVariable?
The pressure angle. The default value is 20.
helixAngle ExpressionValueVariable?
The helix angle. The default value is 10.
centerDistance IEnumerable<ExpressionValueVariable>
The center distance of each gear pair. The default value is 74.
numberOfTeeth IEnumerable<ExpressionValueVariable>
The number of teeth of each gear. The default value is 18, 25.
profileShift IEnumerable<ExpressionValueVariable>
The profile shift of each gear. The default value is 0,0.
faceWidth IEnumerable<ExpressionValueVariable>
The face width of each gear. The default value is 30, 30.
gearName IEnumerable<string>
The gear name of each gear. The default value is Gear1, Gear2.
crossAxisAngle ExpressionValueVariable?
The cross axis angle. The default value is 45.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if length of 'centerDistance' is not 1.
ArgumentException
Will be thrown if length of 'numberOfTeeth' is not 2.
ArgumentException
Will be thrown if length of 'profileShift' is not 2.
ArgumentException
Will be thrown if length of 'faceWidth' is not 2.
ArgumentException
Will be thrown if length of 'gearName' is not 2.
CreateCrossHelicalGearSet(GearTrainDocument, Obj, string, Color?)
Create
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearsetCopy" })]
[MatchTypeObj(new object[] { "gearsetCopy", typeof(GearSetCrossHelical) })]
public static Obj CreateCrossHelicalGearSet(this GearTrainDocument document, Obj gearsetCopy, string gearsetName = "", Color? color = null)
Parameters
document GearTrainDocument
The document to create the cross helical gearset.
gearsetCopy Obj
The cross helical gearset to be copied. The type is
gearsetName string
The name of the gearset. If empty, default name starts with 'CrossHelicalGearSet_' will be generated and used.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearsetCopy' arguments are empty.
ArgumentException
Will be thrown if type of 'gearsetCopy' is not
CreateCrossHelicalGearSetWithKISSsoft(GearTrainDocument, string, string, Color?)
Create
[NotNull(new string[] { "document" })]
[ExistFile(new string[] { "modelFilePath" })]
public static Obj CreateCrossHelicalGearSetWithKISSsoft(this GearTrainDocument document, string modelFilePath, string gearsetName = "", Color? color = null)
Parameters
document GearTrainDocument
The document to create the cross helical gearset.
modelFilePath string
The KISS soft model file path.
gearsetName string
The name of the gearset. If empty, default name starts with 'CrossHelicalGearSet_' will be generated and used.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'modelPath' arguments are empty.
FileNotFoundException
Will be thrown if 'modelPath' is not found.
CreateCustomGearSet(GearTrainDocument, string, int, IEnumerable<string>, Color?)
Create
[NotNull(new string[] { "document" })]
public static Obj CreateCustomGearSet(this GearTrainDocument document, string gearsetName = "", int numberOfGear = 2, IEnumerable<string> gearName = null, Color? color = null)
Parameters
document GearTrainDocument
The document to create the rack and pinion gearset.
gearsetName string
The name of the gearset. If empty, default name starts with 'CustomGearSet_' will be generated and used.
numberOfGear int
The number of gear. The default value is 2.
gearName IEnumerable<string>
The gear name of each gear. The default value is Gear1, Gear2.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if length of 'gearName' is not 'numberOfGear'.
CreateCustomGearSet(GearTrainDocument, Obj, string, Color?)
Create
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearsetCopy" })]
[MatchTypeObj(new object[] { "gearsetCopy", typeof(GearSetCustom) })]
public static Obj CreateCustomGearSet(this GearTrainDocument document, Obj gearsetCopy, string gearsetName = "", Color? color = null)
Parameters
document GearTrainDocument
The document to create the custom gearset.
gearsetCopy Obj
The custom gearset to be copied. The type is
gearsetName string
The name of the gearset. If empty, default name starts with 'CustomGearSet_' will be generated and used.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearsetCopy' arguments are empty.
ArgumentException
Will be thrown if type of 'gearsetCopy' is not
CreateCycloidPinGearSet(GearTrainDocument, string, string, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<string>, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, Color?)
Create
[NotNull(new string[] { "document" })]
[ExistFile(new string[] { "cycloidProfilePath" })]
public static Obj CreateCycloidPinGearSet(this GearTrainDocument document, string cycloidProfilePath, string gearsetName = "", IEnumerable<ExpressionValueVariable> numberOfTeeth = null, IEnumerable<ExpressionValueVariable> faceWidth = null, IEnumerable<string> gearName = null, ExpressionValueVariable? pinDiameterOfGear = null, ExpressionValueVariable? pinPitchOfGear = null, ExpressionValueVariable? eccentricityOfGear = null, Color? color = null)
Parameters
document GearTrainDocument
The document to create the cycloid pin gearset.
cycloidProfilePath string
The cycloid profile path.
gearsetName string
The name of the gearset. If empty, default name starts with 'CycloidPinGearSet_' will be generated and used.
numberOfTeeth IEnumerable<ExpressionValueVariable>
The number of teeth of each gear. The default value is 39, 40.
faceWidth IEnumerable<ExpressionValueVariable>
The face width of each gear. The default value is 10, 10.
gearName IEnumerable<string>
The gear name of each gear. The default value is Cycloid, Pin.
pinDiameterOfGear ExpressionValueVariable?
The pin diameter of gear. The default value is 6.
pinPitchOfGear ExpressionValueVariable?
The pin pitch of gear. The default value is 141.
eccentricityOfGear ExpressionValueVariable?
The eccentricity of gear. The default value is 1.4.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
FileNotFoundException
Will be thrown if 'modelPath' is not found.
ArgumentException
Will be thrown if length of 'numberOfTeeth' is not 2.
ArgumentException
Will be thrown if length of 'profileShift' is not 2.
ArgumentException
Will be thrown if length of 'faceWidth' is not 2.
ArgumentException
Will be thrown if length of 'gearName' is not 2.
CreateCycloidPinGearSet(GearTrainDocument, Obj, string, Color?)
Create
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearsetCopy" })]
[MatchTypeObj(new object[] { "gearsetCopy", typeof(GearSetCycloidPin) })]
public static Obj CreateCycloidPinGearSet(this GearTrainDocument document, Obj gearsetCopy, string gearsetName = "", Color? color = null)
Parameters
document GearTrainDocument
The document to create the cycloid pin gearset.
gearsetCopy Obj
The cycloid pin gearset to be copied. The type is
gearsetName string
The name of the gearset. If empty, default name starts with 'CycloidPinGearSet_' will be generated and used.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearsetCopy' arguments are empty.
ArgumentException
Will be thrown if type of 'gearsetCopy' is not
CreateExternalGearSet(GearTrainDocument, string, GearType, HelicalAngleType, int, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<string>, bool, Color?)
Create
[NotNull(new string[] { "document" })]
[GreaterThanOrEqualToSomeValue("numberOfGear", 2)]
public static Obj CreateExternalGearSet(this GearTrainDocument document, string gearsetName = "", BasicInvolute.GearType gearType = GearType.Helical, BasicInvolute.HelicalAngleType helicalAngleType = HelicalAngleType.Right, int numberOfGear = 2, ExpressionValueVariable? module = null, ExpressionValueVariable? pressureAngle = null, ExpressionValueVariable? helixAngle = null, IEnumerable<ExpressionValueVariable> centerDistance = null, IEnumerable<ExpressionValueVariable> numberOfTeeth = null, IEnumerable<ExpressionValueVariable> profileShift = null, IEnumerable<ExpressionValueVariable> faceWidth = null, IEnumerable<string> gearName = null, bool useAdvanced = false, Color? color = null)
Parameters
document GearTrainDocument
The document to create the external gearset.
gearsetName string
The name of the gearset. If empty, default name starts with 'ExternalGearSet_' will be generated and used.
gearType BasicInvolute.GearType
The gear type. The default value is Helical.
helicalAngleType BasicInvolute.HelicalAngleType
The helical angle type. The default value is Right.
numberOfGear int
The number of gear. The default value is 2.
module ExpressionValueVariable?
The module. The default value is 2.245.
pressureAngle ExpressionValueVariable?
The pressure angle. The default value is 17.
helixAngle ExpressionValueVariable?
The helix angle. The default value is 29.
centerDistance IEnumerable<ExpressionValueVariable>
The center distance of each gear pair. The default value is 75.
numberOfTeeth IEnumerable<ExpressionValueVariable>
The number of teeth of each gear. If the number of gear is 2, the default value is 17, 40.
profileShift IEnumerable<ExpressionValueVariable>
The profile shift of each gear. If the number of gear is 2, the default value is 0.3441, 0.5426.
faceWidth IEnumerable<ExpressionValueVariable>
The face width of each gear. If the number of gear is 2, the default value is 31, 31.
gearName IEnumerable<string>
The gear name of each gear. If the number of gear is 2, the default value is Gear1, Gear2.
useAdvanced bool
The flag that indicates using advanced mode. The default value is false.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentOutOfRangeException
Will be thrown if 'numberOfGear' is less than 2.
ArgumentException
Will be thrown if length of 'centerDistance' is not 'numberOfGear'-1.
ArgumentException
Will be thrown if length of 'numberOfTeeth' is not 'numberOfGear'.
ArgumentException
Will be thrown if length of 'profileShift' is not 'numberOfGear'.
ArgumentException
Will be thrown if length of 'faceWidth' is not 'numberOfGear'.
ArgumentException
Will be thrown if length of 'gearName' is not 'numberOfGear'.
CreateExternalGearSet(GearTrainDocument, Obj, string, Color?)
Create
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearsetCopy" })]
[MatchTypeObj(new object[] { "gearsetCopy", typeof(GearSet) })]
public static Obj CreateExternalGearSet(this GearTrainDocument document, Obj gearsetCopy, string gearsetName = "", Color? color = null)
Parameters
document GearTrainDocument
The document to create the external gearset.
gearsetCopy Obj
The external gearset to be copied. The type is
gearsetName string
The name of the gearset. If empty, default name starts with 'ExternalGearSet_' will be generated and used.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearsetCopy' arguments are empty.
ArgumentException
Will be thrown if type of 'gearsetCopy' is not
CreateExternalGearSetWithKISSsoft(GearTrainDocument, string, string, Color?)
Create
[NotNull(new string[] { "document" })]
[ExistFile(new string[] { "modelFilePath" })]
public static Obj CreateExternalGearSetWithKISSsoft(this GearTrainDocument document, string modelFilePath, string gearsetName = "", Color? color = null)
Parameters
document GearTrainDocument
The document to create the external gearset.
modelFilePath string
The KISS soft model file path.
gearsetName string
The name of the gearset. If empty, default name starts with 'ExternalGearSet_' will be generated and used.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'modelPath' arguments are empty.
FileNotFoundException
Will be thrown if 'modelPath' is not found.
CreateInternalGearSet(GearTrainDocument, string, GearType, HelicalAngleType, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<string>, bool, Color?)
Create
[NotNull(new string[] { "document" })]
public static Obj CreateInternalGearSet(this GearTrainDocument document, string gearsetName = "", BasicInvolute.GearType gearType = GearType.Helical, BasicInvolute.HelicalAngleType helicalAngleType = HelicalAngleType.Right, ExpressionValueVariable? module = null, ExpressionValueVariable? pressureAngle = null, ExpressionValueVariable? helixAngle = null, IEnumerable<ExpressionValueVariable> centerDistance = null, IEnumerable<ExpressionValueVariable> numberOfTeeth = null, IEnumerable<ExpressionValueVariable> profileShift = null, IEnumerable<ExpressionValueVariable> faceWidth = null, IEnumerable<string> gearName = null, bool useAdvanced = false, Color? color = null)
Parameters
document GearTrainDocument
The document to create the internal gearset.
gearsetName string
The name of the gearset. If empty, default name starts with 'InternalGearSet_' will be generated and used.
gearType BasicInvolute.GearType
The gear type. The default value is Helical.
helicalAngleType BasicInvolute.HelicalAngleType
The helical angle type. The default value is Right.
module ExpressionValueVariable?
The module. The default value is 2.245.
pressureAngle ExpressionValueVariable?
The pressure angle. The default value is 17.
helixAngle ExpressionValueVariable?
The helix angle. The default value is 29.
centerDistance IEnumerable<ExpressionValueVariable>
The center distance of each gear pair. The default value is 26.
numberOfTeeth IEnumerable<ExpressionValueVariable>
The number of teeth of each gear. The default value is 17, -40.
profileShift IEnumerable<ExpressionValueVariable>
The profile shift of each gear. The default value is 0.3441, -0.5426.
faceWidth IEnumerable<ExpressionValueVariable>
The face width of each gear. The default value is 31, 31.
gearName IEnumerable<string>
The gear name of each gear. The default value is Pinion, RingGear.
useAdvanced bool
The flag that indicates using advanced mode. The default value is false.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if length of 'centerDistance' is not 1.
ArgumentException
Will be thrown if length of 'numberOfTeeth' is not 2.
ArgumentException
Will be thrown if length of 'profileShift' is not 2.
ArgumentException
Will be thrown if length of 'faceWidth' is not 2.
ArgumentException
Will be thrown if length of 'gearName' is not 2.
CreateInternalGearSet(GearTrainDocument, Obj, string, Color?)
Create
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearsetCopy" })]
[MatchTypeObj(new object[] { "gearsetCopy", typeof(GearSetInternal) })]
public static Obj CreateInternalGearSet(this GearTrainDocument document, Obj gearsetCopy, string gearsetName = "", Color? color = null)
Parameters
document GearTrainDocument
The document to create the internal gearset.
gearsetCopy Obj
The internal gearset to be copied.
gearsetName string
The name of the gearset. If empty, default name starts with 'InternalGearSet_' will be generated and used.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearsetCopy' arguments are empty.
ArgumentException
Will be thrown if type of 'gearsetCopy' is not
CreateInternalGearSetWithKISSsoft(GearTrainDocument, string, string, Color?)
Create
[NotNull(new string[] { "document" })]
[ExistFile(new string[] { "modelFilePath" })]
public static Obj CreateInternalGearSetWithKISSsoft(this GearTrainDocument document, string modelFilePath, string gearsetName = "", Color? color = null)
Parameters
document GearTrainDocument
The document to create the internal gearset.
modelFilePath string
The KISS soft model file path.
gearsetName string
The name of the gearset. If empty, default name starts with 'InternalGearSet_' will be generated and used.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'modelPath' arguments are empty.
FileNotFoundException
Will be thrown if 'modelPath' is not found.
CreatePlanetaryDPGearSet(GearTrainDocument, string, GearType, HelicalAngleType, int, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, DogLegDirectionType, Color?)
Create
[NotNull(new string[] { "document" })]
[GreaterThanOrEqualToSomeValue("numberOfPinionGear", 2)]
public static Obj CreatePlanetaryDPGearSet(this GearTrainDocument document, string gearsetName = "", BasicInvolute.GearType gearType = GearType.Helical, BasicInvolute.HelicalAngleType helicalAngleType = HelicalAngleType.Right, int numberOfPinionGear = 5, ExpressionValueVariable? module = null, ExpressionValueVariable? pressureAngle = null, ExpressionValueVariable? helixAngle = null, IEnumerable<ExpressionValueVariable> centerDistance = null, IEnumerable<ExpressionValueVariable> numberOfTeeth = null, IEnumerable<ExpressionValueVariable> profileShift = null, IEnumerable<ExpressionValueVariable> faceWidth = null, PropertyGearSetPlanetaryDP.DogLegDirectionType dogLegDirectionType = DogLegDirectionType.Right, Color? color = null)
Parameters
document GearTrainDocument
The document to create the double pinion planetary gearset.
gearsetName string
The name of the gearset. If empty, default name starts with 'PlanetaryGearSet_' will be generated and used.
gearType BasicInvolute.GearType
The gear type. The default value is Helical.
helicalAngleType BasicInvolute.HelicalAngleType
The helical angle type. The default value is Right.
numberOfPinionGear int
The number of pinion gear. The default value is 5.
module ExpressionValueVariable?
The module. The default value is 1.5.
pressureAngle ExpressionValueVariable?
The pressure angle. The default value is 20.
helixAngle ExpressionValueVariable?
The helix angle. The default value is 22.
centerDistance IEnumerable<ExpressionValueVariable>
The center distance of each gear pair. If the number of pinion gear is 5, The default value is 49.343, 25.076, 64.712, 0.
numberOfTeeth IEnumerable<ExpressionValueVariable>
The number of teeth of each gear. If the number of pinion gear is 5, the default value is 46, 15, 16, -96.
profileShift IEnumerable<ExpressionValueVariable>
The profile shift of each gear. If the number of pinion gear is 5, the default value is 0, 0, 0, 0.
faceWidth IEnumerable<ExpressionValueVariable>
The face width of each gear. If the number of pinion gear is 5, the default value is 10, 10, 10, 10.
dogLegDirectionType PropertyGearSetPlanetaryDP.DogLegDirectionType
The dog leg direction type. The default value is Right..
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentOutOfRangeException
Will be thrown if 'numberOfPinionGear' is less than 2.
ArgumentException
Will be thrown if length of 'centerDistance' is not 4.
ArgumentException
Will be thrown if length of 'numberOfTeeth' is not 4.
ArgumentException
Will be thrown if length of 'profileShift' is not 4.
ArgumentException
Will be thrown if length of 'faceWidth' is not 4.
CreatePlanetaryDPGearSet(GearTrainDocument, Obj, string, Color?)
Create
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearsetCopy" })]
[MatchTypeObj(new object[] { "gearsetCopy", typeof(GearSetPlanetaryDP) })]
public static Obj CreatePlanetaryDPGearSet(this GearTrainDocument document, Obj gearsetCopy, string gearsetName = "", Color? color = null)
Parameters
document GearTrainDocument
The document to create the double pinion planetary gearset.
gearsetCopy Obj
The double pinion planetary gearset to be copied. The type is
gearsetName string
The name of the gearset. If empty, default name starts with 'PlanetaryGearSet_' will be generated and used.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearsetCopy' arguments are empty.
ArgumentException
Will be thrown if type of 'gearsetCopy' is not
CreatePlanetaryGearSet(GearTrainDocument, string, GearType, HelicalAngleType, int, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, bool, Color?)
Create
[NotNull(new string[] { "document" })]
[GreaterThanOrEqualToSomeValue("numberOfPinionGear", 1)]
public static Obj CreatePlanetaryGearSet(this GearTrainDocument document, string gearsetName = "", BasicInvolute.GearType gearType = GearType.Helical, BasicInvolute.HelicalAngleType helicalAngleType = HelicalAngleType.Right, int numberOfPinionGear = 3, ExpressionValueVariable? module = null, ExpressionValueVariable? pressureAngle = null, ExpressionValueVariable? helixAngle = null, IEnumerable<ExpressionValueVariable> centerDistance = null, IEnumerable<ExpressionValueVariable> numberOfTeeth = null, IEnumerable<ExpressionValueVariable> profileShift = null, IEnumerable<ExpressionValueVariable> faceWidth = null, bool useAdvanced = false, Color? color = null)
Parameters
document GearTrainDocument
The document to create the planetary gearset.
gearsetName string
The name of the gearset. If empty, default name starts with 'PlanetaryGearSet_' will be generated and used.
gearType BasicInvolute.GearType
The gear type. The default value is Helical.
helicalAngleType BasicInvolute.HelicalAngleType
The helical angle type. The default value is Right.
numberOfPinionGear int
The number of pinion gear. The default value is 3.
module ExpressionValueVariable?
The module. The default value is 0.8.
pressureAngle ExpressionValueVariable?
The pressure angle. The default value is 20.
helixAngle ExpressionValueVariable?
The helix angle. The default value is 0.
centerDistance IEnumerable<ExpressionValueVariable>
The center distance of each gear pair. If the number of pinion gear is 3, The default value is 10.6, 10.6, 10.6.
numberOfTeeth IEnumerable<ExpressionValueVariable>
The number of teeth of each gear. If the number of pinion gear is 3, the default value is 11, 14, -40.
profileShift IEnumerable<ExpressionValueVariable>
The profile shift of each gear. If the number of pinion gear is 3, the default value is 0.3125, 0.4055, -0.6725.
faceWidth IEnumerable<ExpressionValueVariable>
The face width of each gear. If the number of pinion gear is 3, the default value is 10, 10, 10.
useAdvanced bool
The flag that indicates using advanced mode. The default value is false.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentOutOfRangeException
Will be thrown if 'numberOfPinionGear' is less than 1.
ArgumentException
Will be thrown if length of 'centerDistance' is not 3.
ArgumentException
Will be thrown if length of 'numberOfTeeth' is not 3.
ArgumentException
Will be thrown if length of 'profileShift' is not 3.
ArgumentException
Will be thrown if length of 'faceWidth' is not 3.
CreatePlanetaryGearSet(GearTrainDocument, Obj, string, Color?)
Create
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearsetCopy" })]
[MatchTypeObj(new object[] { "gearsetCopy", typeof(GearSetPlanetary) })]
public static Obj CreatePlanetaryGearSet(this GearTrainDocument document, Obj gearsetCopy, string gearsetName = "", Color? color = null)
Parameters
document GearTrainDocument
The document to create the planetary gearset.
gearsetCopy Obj
The planetary gearset to be copied. The type is
gearsetName string
The name of the gearset. If empty, default name starts with 'PlanetaryGearSet_' will be generated and used.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearsetCopy' arguments are empty.
ArgumentException
Will be thrown if type of 'gearsetCopy' is not
CreatePlanetaryGearSetWithKISSsoft(GearTrainDocument, string, string, Color?)
Create
[NotNull(new string[] { "document" })]
[ExistFile(new string[] { "modelFilePath" })]
public static Obj CreatePlanetaryGearSetWithKISSsoft(this GearTrainDocument document, string modelFilePath, string gearsetName = "", Color? color = null)
Parameters
document GearTrainDocument
The document to create the planetary gearset.
modelFilePath string
The KISS soft model file path.
gearsetName string
The name of the gearset. If empty, default name starts with 'PlanetaryGearSet_' will be generated and used.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'modelPath' arguments are empty.
FileNotFoundException
Will be thrown if 'modelPath' is not found.
CreateRackAndPinionGearSet(GearTrainDocument, string, GearType, HelicalAngleType, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<string>, bool, ExpressionValueVariable?, BarType, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, Color?)
Create
[NotNull(new string[] { "document" })]
public static Obj CreateRackAndPinionGearSet(this GearTrainDocument document, string gearsetName = "", BasicInvolute.GearType gearType = GearType.Helical, BasicInvolute.HelicalAngleType helicalAngleType = HelicalAngleType.Right, ExpressionValueVariable? module = null, ExpressionValueVariable? pressureAngle = null, ExpressionValueVariable? helixAngle = null, IEnumerable<ExpressionValueVariable> centerDistance = null, IEnumerable<ExpressionValueVariable> numberOfTeeth = null, IEnumerable<ExpressionValueVariable> profileShift = null, IEnumerable<ExpressionValueVariable> faceWidth = null, IEnumerable<string> gearName = null, bool useDifferentHelixAngle = true, ExpressionValueVariable? rackHelixAngle = null, Rack.BarType rackType = BarType.Circular, ExpressionValueVariable? diameterOfRack = null, ExpressionValueVariable? heightOfRack = null, ExpressionValueVariable? sideLength = null, Color? color = null)
Parameters
document GearTrainDocument
The document to create the rack and pinion gearset.
gearsetName string
The name of the gearset. If empty, default name starts with 'RackPSet_' will be generated and used.
gearType BasicInvolute.GearType
The gear type. The default value is Helical.
helicalAngleType BasicInvolute.HelicalAngleType
The helical angle type. The default value is Right.
module ExpressionValueVariable?
The module. The default value is 2.
pressureAngle ExpressionValueVariable?
The pressure angle. The default value is 20.
helixAngle ExpressionValueVariable?
The helix angle. The default value is 15.
centerDistance IEnumerable<ExpressionValueVariable>
The center distance of each gear pair. The default value is 18.5.
numberOfTeeth IEnumerable<ExpressionValueVariable>
The number of teeth of each gear. The default value is 10, 32.
profileShift IEnumerable<ExpressionValueVariable>
The profile shift of each gear. The default value is 0.5, 0.
faceWidth IEnumerable<ExpressionValueVariable>
The face width of each gear. The default value is 49, 49.
gearName IEnumerable<string>
The gear name of each gear. The default value is Pinion, Rack.
useDifferentHelixAngle bool
The flag that indicates using different helix angle. The default value is true.
rackHelixAngle ExpressionValueVariable?
The rack helix angle. The default value is 5.0.
The rack type. The default value is Circular.
diameterOfRack ExpressionValueVariable?
The diameter of rack. The default value is 28.
heightOfRack ExpressionValueVariable?
The height of rack. The default value is 23.
sideLength ExpressionValueVariable?
The side length. The default value is 9.1834.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if length of 'centerDistance' is not 1.
ArgumentException
Will be thrown if length of 'numberOfTeeth' is not 2.
ArgumentException
Will be thrown if length of 'profileShift' is not 2.
ArgumentException
Will be thrown if length of 'faceWidth' is not 2.
ArgumentException
Will be thrown if length of 'gearName' is not 2.
CreateRackAndPinionGearSet(GearTrainDocument, Obj, string, Color?)
Create
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearsetCopy" })]
[MatchTypeObj(new object[] { "gearsetCopy", typeof(GearSetRackAndPinion) })]
public static Obj CreateRackAndPinionGearSet(this GearTrainDocument document, Obj gearsetCopy, string gearsetName = "", Color? color = null)
Parameters
document GearTrainDocument
The document to create the rack and pinion gearset.
gearsetCopy Obj
The rack and pinion gearset to be copied. The type is
gearsetName string
The name of the gearset. If empty, default name starts with 'RackPSet_' will be generated and used.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearsetCopy' arguments are empty.
ArgumentException
Will be thrown if type of 'gearsetCopy' is not
CreateWormAndWormWheelGearSet(GearTrainDocument, string, HelicalAngleType, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<ExpressionValueVariable>, IEnumerable<string>, Color?)
Create
[NotNull(new string[] { "document" })]
public static Obj CreateWormAndWormWheelGearSet(this GearTrainDocument document, string gearsetName = "", BasicInvolute.HelicalAngleType helicalAngleType = HelicalAngleType.Right, ExpressionValueVariable? module = null, ExpressionValueVariable? pressureAngle = null, ExpressionValueVariable? leadAngle = null, IEnumerable<ExpressionValueVariable> centerDistance = null, IEnumerable<ExpressionValueVariable> numberOfTeeth = null, IEnumerable<ExpressionValueVariable> profileShift = null, IEnumerable<ExpressionValueVariable> faceWidth = null, IEnumerable<string> gearName = null, Color? color = null)
Parameters
document GearTrainDocument
The document to create the worm and worm wheel gearset.
gearsetName string
The name of the gearset. If empty, default name starts with 'WormGearSet_' will be generated and used.
helicalAngleType BasicInvolute.HelicalAngleType
The helical angle type. The default value is Right.
module ExpressionValueVariable?
The module. The default value is 0.802183.
pressureAngle ExpressionValueVariable?
The pressure angle. The default value is 14.5.
leadAngle ExpressionValueVariable?
The lead angle. The default value is 30.
centerDistance IEnumerable<ExpressionValueVariable>
The center distance of each gear pair. The default value is 14.2.
numberOfTeeth IEnumerable<ExpressionValueVariable>
The number of teeth of each gear. The default value is 5, 22.
profileShift IEnumerable<ExpressionValueVariable>
The profile shift of each gear. The default value is -0.75, 0.465.
faceWidth IEnumerable<ExpressionValueVariable>
The face width of each gear. The default value is 13, 9.
gearName IEnumerable<string>
The gear name of each gear. The default value is Worm, Wheel.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
ArgumentException
Will be thrown if length of 'centerDistance' is not 1.
ArgumentException
Will be thrown if length of 'numberOfTeeth' is not 2.
ArgumentException
Will be thrown if length of 'profileShift' is not 2.
ArgumentException
Will be thrown if length of 'faceWidth' is not 2.
ArgumentException
Will be thrown if length of 'gearName' is not 2.
CreateWormAndWormWheelGearSet(GearTrainDocument, Obj, string, Color?)
Create
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearsetCopy" })]
[MatchTypeObj(new object[] { "gearsetCopy", typeof(GearSetWormAndWormWheel) })]
public static Obj CreateWormAndWormWheelGearSet(this GearTrainDocument document, Obj gearsetCopy, string gearsetName = "", Color? color = null)
Parameters
document GearTrainDocument
The document to create the worm and worm wheel gearset.
gearsetCopy Obj
The worm and worm wheel gearset to be copied. The type is
gearsetName string
The name of the gearset. If empty, default name starts with 'WormGearSet_' will be generated and used.
color Color?
The color of the gearset.
Returns
The new
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearsetCopy' arguments are empty.
ArgumentException
Will be thrown if type of 'gearsetCopy' is not
MeshingGearSet(GearTrainDocument, Obj)
Meshing gearset in gear train subsystem.
[NotNullObj(new string[] { "gearset" })]
public static bool MeshingGearSet(this GearTrainDocument document, Obj gearset)
Parameters
document GearTrainDocument
The
gearset Obj
The gearset. The type is
Returns
bool
The flag for success.
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearset' arguments are empty.
ArgumentNullException
Will be thrown if type of 'gearset' is not
UpdateGearInEF(HiddenDocumentMeshBase, Obj, int, ExpressionValueVariable, AttachLocationType, Obj, RacewayType)
Update gear in EF shaftset/housing designer.
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearset", "bearing" })]
[GreaterThanOrEqualToZero(new string[] { "gearIdx" })]
public static void UpdateGearInEF(this HiddenDocumentMeshBase document, Obj gearset, int gearIdx, ExpressionValueVariable referenceOffset, AttachLocationType attachLocationType, Obj bearing, RacewayGeometryInfo.RacewayType racewayType)
Parameters
document HiddenDocumentMeshBase
The
gearset Obj
The gearset. The type is
gearIdx int
The gear index.
referenceOffset ExpressionValueVariable
The reference offset.
attachLocationType AttachLocationType
The attach location type.
bearing Obj
The bearing. The type is
racewayType RacewayGeometryInfo.RacewayType
The raceway type.
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearset' or 'bearing' arguments are empty.
ArgumentOutOfRangeException
Will be thrown if 'gearIndex' is less than zero.
UpdateGearInEF(HiddenDocumentMeshBase, Obj, int, Obj)
Update gear in EF shaftset/housing designer.
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearset", "connectable" })]
[GreaterThanOrEqualToZero(new string[] { "gearIdx" })]
public static void UpdateGearInEF(this HiddenDocumentMeshBase document, Obj gearset, int gearIdx, Obj connectable)
Parameters
document HiddenDocumentMeshBase
The
gearset Obj
The gearset. The type is
gearIdx int
The gear index.
connectable Obj
The start rbe. The type is
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'connectable' arguments are empty.
ArgumentOutOfRangeException
Will be thrown if 'gearIndex' is less than zero.
UpdateGearInFE(HiddenDocumentMeshBase, Obj, int, ExpressionValueVariable, AttachLocationType, Obj, RacewayType)
Update gear in FE shaftset/housing designer.
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearset", "bearing" })]
[GreaterThanOrEqualToZero(new string[] { "gearIdx" })]
public static void UpdateGearInFE(this HiddenDocumentMeshBase document, Obj gearset, int gearIdx, ExpressionValueVariable referenceOffset, AttachLocationType attachLocationType, Obj bearing, RacewayGeometryInfo.RacewayType racewayType)
Parameters
document HiddenDocumentMeshBase
The
gearset Obj
The gearset. The type is
gearIdx int
The gear index.
referenceOffset ExpressionValueVariable
The reference offset.
attachLocationType AttachLocationType
The attach location type.
bearing Obj
The bearing. The type is
racewayType RacewayGeometryInfo.RacewayType
The raceway type.
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearset' or 'bearing' arguments are empty.
ArgumentOutOfRangeException
Will be thrown if 'gearIdx' argument is less than 0.
UpdateGearInFE(HiddenDocumentMeshBase, Obj, int, Obj)
Update gear in FE shaftset/housing designer.
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearset", "connectable" })]
[GreaterThanOrEqualToZero(new string[] { "gearIdx" })]
public static void UpdateGearInFE(this HiddenDocumentMeshBase document, Obj gearset, int gearIdx, Obj connectable)
Parameters
document HiddenDocumentMeshBase
The
gearset Obj
The gearset. The type is
gearIdx int
The gear index.
connectable Obj
The start rbe. The type is
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'connectable' arguments are empty.
ArgumentOutOfRangeException
Will be thrown if 'gearIdx' argument is less than 0.
UpdateGearInShaftSet(HiddenShaftSetDocument, Obj, int, ExpressionValueVariable, AttachLocationType, Obj, RacewayType, ClearanceParameters?)
Update gear in simple shaftset designer.
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearset", "bearing" })]
[GreaterThanOrEqualToZero(new string[] { "gearIdx" })]
public static void UpdateGearInShaftSet(this HiddenShaftSetDocument document, Obj gearset, int gearIdx, ExpressionValueVariable referenceOffset, AttachLocationType attachLocationType, Obj bearing, RacewayGeometryInfo.RacewayType racewayType, ClearanceParameters? clearanceParameters = null)
Parameters
document HiddenShaftSetDocument
The
gearset Obj
The gearset. The type is
gearIdx int
The gear index.
referenceOffset ExpressionValueVariable
The reference offset.
attachLocationType AttachLocationType
The attach location type.
bearing Obj
The bearing. The type is
racewayType RacewayGeometryInfo.RacewayType
The raceway type.
clearanceParameters ClearanceParameters?
The clearance parameter. If it is not given, default values will be used.
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearset' or 'bearing' arguments are empty.
ArgumentOutOfRangeException
Will be thrown if 'gearIndex' is less than zero.
UpdateGearInShaftSet(HiddenShaftSetDocument, Obj, int, ClearanceParameters?)
Update gear in simple shaftset designer.
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearset" })]
[GreaterThanOrEqualToZero(new string[] { "gearIdx" })]
public static void UpdateGearInShaftSet(this HiddenShaftSetDocument document, Obj gearset, int gearIdx, ClearanceParameters? clearanceParameters = null)
Parameters
document HiddenShaftSetDocument
The
gearset Obj
The gearset. The type is
gearIdx int
The gear index.
clearanceParameters ClearanceParameters?
The clearance parameter. If it is not given, default values will be used.
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearset' or 'connectable' arguments are empty.
ArgumentOutOfRangeException
Will be thrown if 'gearIndex' is less than zero.
UpdateGearSet(HiddenGearSetDocumentBase)
Update gearset in gearset designer.
[NotNull(new string[] { "document" })]
public static void UpdateGearSet(this HiddenGearSetDocumentBase document)
Parameters
document HiddenGearSetDocumentBase
The
Exceptions
ArgumentNullException
Will be thrown if 'document' argument is empty.
UpdateRackInEF(HiddenDocumentMeshBase, Obj, Obj, Obj, bool, bool, Vector, ExpressionValueVariable)
Update rack in EF shaftset/housing designer.
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearset" })]
[NotZeroMagnitude(new string[] { "zAxis" })]
public static void UpdateRackInEF(this HiddenDocumentMeshBase document, Obj gearset, Obj startConnectable, Obj endConnectable, bool useStart, bool useEnd, Vector zAxis, ExpressionValueVariable initialAngle)
Parameters
document HiddenDocumentMeshBase
The
gearset Obj
The gearset. The type is
startConnectable Obj
The start rbe. The type is
endConnectable Obj
The end rbe. The type is
useStart bool
The flag whether using start rbe.
useEnd bool
The flag whether using end rbe.
zAxis Vector
The z axis.
initialAngle ExpressionValueVariable
The initial angle.
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearset' arguments are empty.
ArgumentException
Will be thrown if the magnitude of 'zAxis' is 0.
ArgumentException
Will be thrown if the 'useStart' is true and 'startConnectable' is empty.
ArgumentException
Will be thrown if the 'useEnd' is true and 'endConnectable' is empty.
UpdateRackInFE(HiddenDocumentMeshBase, Obj, Obj, Obj, bool, bool, Vector, ExpressionValueVariable)
Update rack in FE shaftset/housing designer.
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearset" })]
[NotZeroMagnitude(new string[] { "zAxis" })]
public static void UpdateRackInFE(this HiddenDocumentMeshBase document, Obj gearset, Obj startConnectable, Obj endConnectable, bool useStart, bool useEnd, Vector zAxis, ExpressionValueVariable initialAngle)
Parameters
document HiddenDocumentMeshBase
The
gearset Obj
The gearset. The type is
startConnectable Obj
The start rbe. The type is
endConnectable Obj
The end rbe. The type is
useStart bool
The flag whether using start rbe.
useEnd bool
The flag whether using end rbe.
zAxis Vector
The z axis.
initialAngle ExpressionValueVariable
The initial angle.
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearset' arguments are empty.
ArgumentException
Will be thrown if the magnitude of 'zAxis' is 0.
ArgumentException
Will be thrown if the 'useStart' is true and 'startConnectable' is empty.
ArgumentException
Will be thrown if the 'useEnd' is true and 'endConnectable' is empty.
UpdateRackInShaftSet(HiddenShaftSetDocument, Obj, ExpressionValueVariable)
Update rack in simple shaftset designer.
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearset" })]
public static void UpdateRackInShaftSet(this HiddenShaftSetDocument document, Obj gearset, ExpressionValueVariable initialAngle)
Parameters
document HiddenShaftSetDocument
The
gearset Obj
The gearset. The type is
initialAngle ExpressionValueVariable
The initial angle.
Exceptions
ArgumentNullException
Will be thrown if 'document' or 'gearName' or 'clearanceInfo' arguments are empty.
