Class GearTrainDocument
Last update: 16.07.2025Namespace: VM.Managed.DAFUL.GearTrain
Assembly: VMDGearTrain.dll
The gear train document
public class GearTrainDocument : SubSystemDocument, IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IEnableManager, IRelatedDocument, IHistorySupport, ITemplateDocument, ITreatValidObject, IInterfaceSupport, IApplyInitialVelocity, IGearTrainDocument, ISubSystemDocument, IDocumentAnalysis, IDocument3D, IHandledDocument, IDocument, IObject, IEventProvider, IContainer, ILinkContainer, IOwned, IHasID, IDocumentOwner
Inheritance
object ← ObservableObject ← LinkableBase ← LinkContainer ← Container ← Document ← HandledDocument ← Document3D ← DocumentAnalysis ← SubSystemDocument ← GearTrainDocument
Implements
IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IEnableManager, IRelatedDocument, IHistorySupport, ITemplateDocument, ITreatValidObject, IInterfaceSupport, IApplyInitialVelocity, IGearTrainDocument, ISubSystemDocument, IDocumentAnalysis, IDocument3D, IHandledDocument, IDocument, IObject, IEventProvider, IContainer, ILinkContainer, IOwned, IHasID, IDocumentOwner
Inherited Members
SubSystemDocument.OnPostMakeDocumentImpl(DocCreateAnalysisInfo),
SubSystemDocument.OnDeserialization(object),
SubSystemDocument.InitializeSimParam(),
SubSystemDocument.CreateAssemblyImpl(),
SubSystemDocument.RenameEntityImpl(string, ObjectBase),
SubSystemDocument.RegisterAddon(),
SubSystemDocument.FindCategory(string),
SubSystemDocument.InitializeCategoryInfo(string),
SubSystemDocument.PossibleToImport(SubSystemDocument, out string, out string),
SubSystemDocument.PossibleDifferentUnit(SubSystemDocument, out string),
SubSystemDocument.PossibleDifferentUnit(out string),
SubSystemDocument.InitializeInterface(),
SubSystemDocument.SaveTemplateBasedXml(XmlWriter),
SubSystemDocument.SaveTemplateBasedXml(XmlWriter, bool),
SubSystemDocument.LoadTemplateBasedXml(XmlReader),
SubSystemDocument.LoadTemplateBasedXml(XmlReader, bool),
SubSystemDocument.HideObjectInReading(),
SubSystemDocument.SkipObjectInWriting(ObjectBase),
SubSystemDocument.CheckMassPropForCADImport(),
SubSystemDocument.ImportCADBody(BuilderImport[]),
SubSystemDocument.ReplaceCADBody(BuilderImport[]),
SubSystemDocument.GetCADBodyNameAttribute(ref List
Extension Methods
LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType),
LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType),
LinkPropertyItemCache.GetLinkedObjects
Constructors
GearTrainDocument(UIntPtr)
Initializes a new instance of the
public GearTrainDocument(UIntPtr docCore)
Parameters
docCore UIntPtr
The document handle.
Properties
AssembledBodyList
Gets or sets the assembled body list.
public override ObjectBase[] AssembledBodyList { get; }
Property Value
ObjectBase[]
AssemblyManager
Gets or sets the assembly manager.
public AssemblyManager AssemblyManager { get; set; }
Property Value
CustomDesignParameterList
Gets or sets the custom design parameter list.
public override ObjectBase[] CustomDesignParameterList { get; }
Property Value
ObjectBase[]
CustomPerformanceIndexList
Gets or sets the custom performance index list.
public override ObjectBase[] CustomPerformanceIndexList { get; }
Property Value
ObjectBase[]
DirectionOfShaft
Gets or sets the direction of shaft.
public DirectionBase DirectionOfShaft { get; set; }
Property Value
DirectionBase
InitialCategories
Gets the initial categories.
protected override List<string> InitialCategories { get; }
Property Value
NodalBodyList
Gets the nodal body list.
public override ObjectBase[] NodalBodyList { get; }
Property Value
ObjectBase[]
SimulationScenarioTypeName
Gets the name of the simulation scenario type.
public override string SimulationScenarioTypeName { get; }
Property Value
SkipUI
Gets or sets the skip UI.
public static bool SkipUI { get; set; }
Property Value
UseToolkitSubsystem
Determines whether this used toolkit subsystem.
public override bool UseToolkitSubsystem { get; }
Property Value
VehicleSimulationDataSet
Vehicle Simulation DataSet
public string VehicleSimulationDataSet { get; set; }
Property Value
VehicleSimulatorProcessId
Vehicle simulator process id
public int VehicleSimulatorProcessId { get; set; }
Property Value
VisibleTarget
Gets or sets the visible target.
public override ObjectBase[] VisibleTarget { get; }
Property Value
ObjectBase[]
Methods
AddParentToDictionary(GeometryInfoBase, IOpenDesignerForGearTrain)
Adds the parent to dictionary.
public bool AddParentToDictionary(GeometryInfoBase geomInfo, IOpenDesignerForGearTrain openDes)
Parameters
geomInfo GeometryInfoBase
The geom information.
openDes IOpenDesignerForGearTrain
The open DES.
Returns
AddParentToDictionary(GeometryInfoBase, IOpenDesignerForGearTrain, GeometryInfoBase)
Adds the parent to dictionary.
public bool AddParentToDictionary(GeometryInfoBase geomInfo, IOpenDesignerForGearTrain openDes, GeometryInfoBase bearingInfo)
Parameters
geomInfo GeometryInfoBase
The geom information.
openDes IOpenDesignerForGearTrain
The open DES.
bearingInfo GeometryInfoBase
The bearing information.
Returns
ClearDocument()
Clears the document.
protected override void ClearDocument()
DeleteWithSelectionObjects()
Deletes the with selection objects.
public override bool DeleteWithSelectionObjects()
Returns
Find(string)
Finds the specified string name.
public override IObjectBase Find(string strName)
Parameters
strName string
Name of the string.
Returns
IObjectBase
FindBodyFromCADBody(ObjectBase)
Finds the body form CAD body.
public override ObjectBase FindBodyFromCADBody(ObjectBase obj)
Parameters
obj ObjectBase
The CAD body.
Returns
ObjectBase
The body such as solid body, assembled body.
FindCategory(string)
Finds the category.
public override string FindCategory(string strType)
Parameters
strType string
The fullname of type.
Returns
The category.
FindLocal(string)
Finds the local.
public override IObjectBase FindLocal(string strName)
Parameters
strName string
Name of the string.
Returns
IObjectBase
FindObjectForSelection(ObjectBase, OperationTypeForSelection)
Finds the object for selecion.
public override ObjectBase FindObjectForSelection(ObjectBase obj, Document3D.OperationTypeForSelection enType)
Parameters
obj ObjectBase
The obj.
enType Document3D.OperationTypeForSelection
Type of the operation for selection.
Returns
ObjectBase
GetAllGear(string, GearGeometryInfo)
Gets all gear.
public List<igearbuilder> GetAllGear(string strExistShaftsetName, GearGeometryInfo addedGearInfo)
Parameters
strExistShaftsetName string
Name of the string exist shaftset.
addedGearInfo GearGeometryInfo
The added gear information.
Returns
ListIGearBuilder>
GetAssemblyInfoForOutputUsub(ref IConnectable)
Gets the assembly information for output usub.
public void GetAssemblyInfoForOutputUsub(ref IConnectable con)
Parameters
con IConnectable
The con.
GetBodies(ref List)
Get Bodies.
protected override void GetBodies(ref List<objectbase> lstBody)
Parameters
lstBody List
The body container.
GetData(XmlNode)
Gets the analysis document information data.
public override void GetData(XmlNode writer)
Parameters
writer XmlNode
The writer.
Exceptions
GetExtraInfoInDictionary(GeometryInfoBase)
Gets the extra information in dictionary.
public GeometryInfoBase GetExtraInfoInDictionary(GeometryInfoBase geomInfo)
Parameters
geomInfo GeometryInfoBase
The geom information.
Returns
GetGearsWithSameAxis(string, VectorBase, VectorBase, GearGeometryInfo)
Gets the gears with same axis.
public List<igearbuilder> GetGearsWithSameAxis(string strExistShaftsetName, VectorBase vecPoint, VectorBase vecAxis, GearGeometryInfo addedGearInfo)
Parameters
strExistShaftsetName string
Name of the string exist shaftset.
vecPoint VectorBase
The vec point.
vecAxis VectorBase
The vec axis.
addedGearInfo GearGeometryInfo
The added gear information.
Returns
ListIGearBuilder>
GetGeometryInfo(IOpenDesignerForGearTrain, GeometryType)
Gets the geometry information.
public GeometryInfoBase[] GetGeometryInfo(IOpenDesignerForGearTrain od, GeometryInfoBase.GeometryType typeGeom)
Parameters
The od.
typeGeom GeometryInfoBase.GeometryType
The type geom.
Returns
GetOMatrixWithReferenceDir(VectorBase)
Gets the o matrix with reference dir.
public OMatrix GetOMatrixWithReferenceDir(VectorBase vecZ)
Parameters
vecZ VectorBase
The vec z.
Returns
OMatrix
GetParentInDictionary(GeometryInfoBase)
Gets the parent in dictionary.
public IOpenDesignerForGearTrain GetParentInDictionary(GeometryInfoBase geomInfo)
Parameters
geomInfo GeometryInfoBase
The geom information.
Returns
GetUnnamedObjectName(object)
Gets the name of the unnamed object.
public override string GetUnnamedObjectName(object obUnnamed)
Parameters
obUnnamed object
The ob unnamed.
Returns
The unnamed object name.
InitializeCategoryInfo(string)
Initializes the category information.
public static void InitializeCategoryInfo(string strCategoryName)
Parameters
strCategoryName string
Name of the string category.
InitializeSimParam()
Initializes the simulation parameter.
protected override void InitializeSimParam()
IsAssmbldPairForBearing(RacewayGeometryInfo)
Determines whether [is assmbld pair for bearing] [the specified information].
public bool IsAssmbldPairForBearing(RacewayGeometryInfo info)
Parameters
info RacewayGeometryInfo
The information.
Returns
IsPairForBearing(GeometryInfoBase)
Determines whether [is pair for bearing] [the specified od].
public bool IsPairForBearing(GeometryInfoBase info)
Parameters
info GeometryInfoBase
The information.
Returns
LinkRequestUpdate(object, LinkEventArgs)
The update event occured from the linked object.
protected override void LinkRequestUpdate(object objNotifier, LinkEventArgs arg)
Parameters
objNotifier object
The linked object.
arg LinkEventArgs
The update event information.
OnDeserialization(object)
Called when [deserialization].
protected override void OnDeserialization(object sender)
Parameters
sender object
The sender.
OnPostMakeDocumentImpl(DocCreateAnalysisInfo)
Called when [post make document] [implementation].
protected override void OnPostMakeDocumentImpl(DocCreateAnalysisInfo info)
Parameters
info DocCreateAnalysisInfo
The [analysis document create information].
PossibleToImport(SubSystemDocument, out string, out string)
Possible to import subsystem.
public override bool PossibleToImport(SubSystemDocument document, out string strDocBase, out string strDocNew)
Parameters
document SubSystemDocument
The document to import.
strDocBase string
The base document type name.
strDocNew string
The new document type name.
Returns
PostCloseDocument()
Called after close document
public override void PostCloseDocument()
PostOpenDocument()
Posts the open document.
public override void PostOpenDocument()
PostOpenDocumentAfterSetFilePath()
Call when post [open document] after set file path.
public override void PostOpenDocumentAfterSetFilePath()
ReAssemblyCore()
Reassembly
protected override bool ReAssemblyCore()
Returns
true if success; otherwise, false.
ReAssemblyHousing(IMeshEntity)
Re-assembly housing.
public void ReAssemblyHousing(IMeshEntity housing)
Parameters
housing IMeshEntity
RemoveParentFromDictionary(GeometryInfoBase, HiddenDocument)
Removes the parent from dictionary.
public bool RemoveParentFromDictionary(GeometryInfoBase geomInfo, HiddenDocument docHidden)
Parameters
geomInfo GeometryInfoBase
The geom information.
docHidden HiddenDocument
The document hidden.
Returns
RemoveParentFromDictionary(IOpenDesignerForGearTrain)
Removes the parent from dictionary.
public void RemoveParentFromDictionary(IOpenDesignerForGearTrain openDes)
Parameters
openDes IOpenDesignerForGearTrain
The open DES.
SetData(XmlNode)
Sets the analysis document information data.
public override void SetData(XmlNode reader)
Parameters
reader XmlNode
The reader.
Exceptions
SkipAddToDSDLWithCategory(string)
Skip [add to DSDL] with category.
public override bool SkipAddToDSDLWithCategory(string strCategory)
Parameters
strCategory string
The category name.
Returns
SkipAddToDSDLWithEntity(ObjectBase)
Skip [add to DSDL] with entity.
public override bool SkipAddToDSDLWithEntity(ObjectBase @object)
Parameters
object ObjectBase
The entity.