Class SubSystemDocument
Last update: 16.07.2025Namespace: VM.Managed.DAFUL
Assembly: VMDFBase.dll
This class is to represent the document for sub system.
public class SubSystemDocument : DocumentAnalysis, IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IEnableManager, IRelatedDocument, IHistorySupport, ITemplateDocument, ITreatValidObject, ISubSystemDocument, IDocumentAnalysis, IDocument3D, IHandledDocument, IDocument, IObject, IEventProvider, IContainer, ILinkContainer, IOwned, IHasID, IDocumentOwner, IInterfaceSupport, IApplyInitialVelocity
Inheritance
object ← ObservableObject ← LinkableBase ← LinkContainer ← Container ← Document ← HandledDocument ← Document3D ← DocumentAnalysis ← SubSystemDocument
Derived
Implements
IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IEnableManager, IRelatedDocument, IHistorySupport, ITemplateDocument, ITreatValidObject, ISubSystemDocument, IDocumentAnalysis, IDocument3D, IHandledDocument, IDocument, IObject, IEventProvider, IContainer, ILinkContainer, IOwned, IHasID, IDocumentOwner, IInterfaceSupport, IApplyInitialVelocity
Inherited Members
DocumentAnalysis.m_bSkipGravity,
DocumentAnalysis.RegisterAddon(),
DocumentAnalysis.IsContainSimulationScenarioInMap(Scenario),
DocumentAnalysis.GetStateFromActiveSimulationScenarioMap(Scenario),
DocumentAnalysis.SetStateFromActiveSimulationScenarioMap(Scenario, bool),
DocumentAnalysis.AddConfiguration(Configuration),
DocumentAnalysis.RemoveConfiguration(Configuration),
DocumentAnalysis.ClearConfiguration(),
DocumentAnalysis.GetDefaultMaterial(),
DocumentAnalysis.GetDefaultMaterial(bool),
DocumentAnalysis.IsExistDefaultMaterial(),
DocumentAnalysis.LinkRequestUpdate(object, LinkEventArgs),
DocumentAnalysis.GetBodyAndTransformation(ref List
Extension Methods
LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType),
LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType),
LinkPropertyItemCache.GetLinkedObjects
Constructors
SubSystemDocument(UIntPtr)
Initializes a new instance of the
public SubSystemDocument(UIntPtr docCore)
Parameters
docCore UIntPtr
The document handle.
Properties
ApplyInitialVelocityImpl
Whether InitialVelocity is applicable or not
protected virtual bool ApplyInitialVelocityImpl { get; }
Property Value
ChangeNewFilePath
Gets or sets the change new file path.
[Obsolete]
public string ChangeNewFilePath { get; set; }
Property Value
ChangeNewFilePaths
Gets or sets the change new file paths.
public List<string> ChangeNewFilePaths { get; set; }
Property Value
ChangeOldFilePath
Gets or sets the change old file path.
[Obsolete]
public string ChangeOldFilePath { get; set; }
Property Value
ChangeOldFilePaths
Gets or sets the change old file paths.
public List<string> ChangeOldFilePaths { get; set; }
Property Value
DocumentSessionOverride
Gets the document session override.
public override SessionOverride DocumentSessionOverride { get; }
Property Value
SessionOverride
InitialCategories
Gets the initialize categories.
protected override List<string> InitialCategories { get; }
Property Value
InitialVelocityImpl
Gets the initial velocity
protected virtual double InitialVelocityImpl { get; }
Property Value
Interfaces
Gets the interface manager.
protected virtual InterfaceManager Interfaces { get; }
Property Value
InterfaceManager
SetDocumentSessionOverride
Sets the set document session override.
public SessionOverride SetDocumentSessionOverride { set; }
Property Value
SessionOverride
SkipBindInterfaceWhenOpen
Gets the [skip binding interface when open].
protected virtual bool SkipBindInterfaceWhenOpen { get; }
Property Value
TemplateXmlVersion
Gets the version of template XML.
public string TemplateXmlVersion { get; }
Property Value
Methods
CheckMassPropForCADImport()
Check mass property for CAD Import.
public override string CheckMassPropForCADImport()
Returns
ClearDocument()
Clears the document.
protected override void ClearDocument()
CreateAssemblyImpl()
Creates the assembly [implementation].
protected override Assembly CreateAssemblyImpl()
Returns
Assembly
The assembly.
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.
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
GetCADBodyNameAttribute(ref List)
Gets the CAD body name attributes.
public override void GetCADBodyNameAttribute(ref List<string> lstName)
Parameters
The output CAD body name attributes.
GetImportCADBody()
Gets the Import CAD body.
public override List<objectbase> GetImportCADBody()
Returns
GetReferDocument(ref List)
Gets the refer document.
public override void GetReferDocument(ref List<document3d> lstDocument)
Parameters
lstDocument List
The refer document container.
GetReference(ObjectBase, ref List, ref List)
Gets the reference of subsystem.
public override void GetReference(ObjectBase obSub, ref List<reference> lstRef, ref List<objectbase> lstOther)
Parameters
obSub ObjectBase
The sub system object.
lstRef List
The reference container.
lstOther List
The other container for assembled body.
GetRemovedConnectorForChangeAssembly(ChangeAssemblyType, string, string, List)
Re-assemble for change assembly.
public Dictionary<string>> GetRemovedConnectorForChangeAssembly(ChangeAssemblyType assmType, string strTargetName, string oldAssemblyPath, List<string> lstNewAssemblyPath)
Parameters
assmType ChangeAssemblyType
Type of the assembly.
strTargetName string
The target name.
oldAssemblyPath string
The old assembly path.
lstNewAssemblyPath Liststring>
The new assembly path list.
Returns
Dictionarystring, SortedSetstring>>
GetSimulationConfigurationType()
Gets the type of the simulation configuration.
public override string GetSimulationConfigurationType()
Returns
The type of the simulation configuration.
GetTransformationOfGlobal(ObjectBase)
Gets the transformation of global.
public TMatrix GetTransformationOfGlobal(ObjectBase ob)
Parameters
ob ObjectBase
The object.
Returns
TMatrix
GetTransformationOfGlobal(ObjectBase, string)
Gets the transformation of global.
public TMatrix GetTransformationOfGlobal(ObjectBase ob, string strSubsystemName)
Parameters
ob ObjectBase
The object.
strSubsystemName string
The subsystem name.
Returns
TMatrix
HideObjectInReading()
Hides the object in reading.
protected override void HideObjectInReading()
ImportCADBody(BuilderImport[])
Imports the CAD body.
protected override void ImportCADBody(BuilderImport[] arBuild)
Parameters
arBuild BuilderImport[]
The build object array.
InitializeCategoryInfo(string)
Initializes the category information.
public static void InitializeCategoryInfo(string strCategoryName)
Parameters
strCategoryName string
The category name.
InitializeInterface()
Initializes the interface.
protected virtual void InitializeInterface()
InitializeSimParam()
Initializes the simulation parameter.
protected override void InitializeSimParam()
LoadTemplateBasedXml(XmlReader)
Loads the XML for template based document.
protected override void LoadTemplateBasedXml(XmlReader reader)
Parameters
reader XmlReader
The reader.
LoadTemplateBasedXml(XmlReader, bool)
Loads the XML for template based document.
protected void LoadTemplateBasedXml(XmlReader reader, bool bAssembly)
Parameters
reader XmlReader
The reader.
bAssembly bool
if set to true [assembly].
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].
PossibleDifferentUnit(SubSystemDocument, out string)
Possible different unit.
public bool PossibleDifferentUnit(SubSystemDocument document, out string strImportedDoc)
Parameters
document SubSystemDocument
The document to import.
strImportedDoc string
The imported document type name.
Returns
PossibleDifferentUnit(out string)
Possible different unit.
public bool PossibleDifferentUnit(out string strSimulatedDoc)
Parameters
strSimulatedDoc string
The simulated document type name.
Returns
PossibleToImport(SubSystemDocument, out string, out string)
Possible to import subsystem.
public virtual 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
PostOpenDocument()
Posts the open document.
public override void PostOpenDocument()
PostOpenDocumentAfterErrCheckEvent()
Posts the open document after err check event.
public override void PostOpenDocumentAfterErrCheckEvent()
ReAssembleForChangeAssembly(ChangeAssemblyType, string, string, List)
Re-assemble for change assembly.
public void ReAssembleForChangeAssembly(ChangeAssemblyType assmType, string strTargetName, string oldAssemblyPath, List<string> lstNewAssemblyPath)
Parameters
assmType ChangeAssemblyType
Type of the assembly.
strTargetName string
The target name.
oldAssemblyPath string
The old assembly path.
lstNewAssemblyPath Liststring>
The new assembly path list.
ReAssemblyImpl(ObjectBase)
Reassembly [implementation].
protected override bool ReAssemblyImpl(ObjectBase ob)
Parameters
ob ObjectBase
The object.
Returns
true if success; otherwise, false.
ReInitInterfaceForAssembly()
Re initialize interface for assembly.
public override void ReInitInterfaceForAssembly()
RegisterAddon()
Register addon
protected override void RegisterAddon()
RenameEntityImpl(string, ObjectBase)
Rename entity [Implementation].
protected override void RenameEntityImpl(string strOldName, ObjectBase namedObj)
Parameters
strOldName string
The old name.
namedObj ObjectBase
The new object.
ReplaceCADBody(BuilderImport[])
Replaces the CAD body.
public override void ReplaceCADBody(BuilderImport[] arBuilder)
Parameters
arBuilder BuilderImport[]
The builder object array.
SaveTemplateBasedXml(XmlWriter)
Saves the XML for template based document.
protected override void SaveTemplateBasedXml(XmlWriter writer)
Parameters
writer XmlWriter
The writer.
SaveTemplateBasedXml(XmlWriter, bool)
Saves the XML for template based document.
protected void SaveTemplateBasedXml(XmlWriter writer, bool bAssembly)
Parameters
writer XmlWriter
The writer.
bAssembly bool
if set to true [assembly].
SkipDelete(ObjectBase)
Skips the delete.
protected override bool SkipDelete(ObjectBase obj)
Parameters
obj ObjectBase
The obj.
Returns
SkipObjectInWriting(ObjectBase)
Skips the object in writing.
protected override bool SkipObjectInWriting(ObjectBase obj)
Parameters
obj ObjectBase
The obj.
Returns
SkipShowHide(ObjectBase)
Skips the show hide.
protected override bool SkipShowHide(ObjectBase obj)
Parameters
obj ObjectBase
The obj.
Returns
WriteMessageForShowHide()
Writes the message for show hide.
protected override void WriteMessageForShowHide()