Class DocumentAnalysis
Last update: 16.07.2025Namespace: VM.Managed.DAFUL
Assembly: VMDFBase.dll
This class is to represent the analysis document.
public abstract class DocumentAnalysis : Document3D, IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IEnableManager, IRelatedDocument, IHistorySupport, ITemplateDocument, ITreatValidObject, IDocumentAnalysis, IDocument3D, IHandledDocument, IDocument, IObject, IEventProvider, IContainer, ILinkContainer, IOwned, IHasID, IDocumentOwner
Inheritance
object ← ObservableObject ← LinkableBase ← LinkContainer ← Container ← Document ← HandledDocument ← Document3D ← DocumentAnalysis
Derived
PartDocument, SubSystemDocument
Implements
IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IEnableManager, IRelatedDocument, IHistorySupport, ITemplateDocument, ITreatValidObject, IDocumentAnalysis, IDocument3D, IHandledDocument, IDocument, IObject, IEventProvider, IContainer, ILinkContainer, IOwned, IHasID, IDocumentOwner
Inherited Members
Document3D.RibbonGalleryIndex,
Document3D.m_lstAssem,
Document3D.m_bReload,
Document3D.m_strVersion,
Document3D.g_dRenderingType,
Document3D.m_dicCategory,
Document3D.m_dicCategoryCollection,
Document3D.IsContainsCategoryName(string),
Document3D.GetNearestUnderCursorObject(),
Document3D.SetSelectFromUnderCursor(ulong),
Document3D.SetSelectFromUnderCursor(ObjectBase),
Document3D.SetUnselectFromUnderCursor(ulong),
Document3D.IsSelectFromUnderCursor(ulong),
Document3D.SetPickFromUnderCursor(ulong),
Document3D.Activate(),
Document3D.CreateAssembly(),
Document3D.StartBasicOp(Document3D.BasicOpType),
Document3D.RefreshAllViews(),
Document3D.InitCategory(),
Document3D.AddAssembly(Assembly),
Document3D.AddNewReference(ObjectBase[], string),
Document3D.AddNewReference(ObjectBase),
Document3D.GetAssembly(),
Document3D.DeleteWithSelectionObjects(ref DestroyType, bool),
Document3D.DeleteWithSelectionObjects(ref DestroyType),
Document3D.DeleteWithSelectionObjects(),
Document3D.DeleteObjectBases(ref DestroyType, IEnumerable
Extension Methods
LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType),
LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType),
LinkPropertyItemCache.GetLinkedObjects
Constructors
DocumentAnalysis(UIntPtr)
Initializes a new instance of the
public DocumentAnalysis(UIntPtr docCore)
Parameters
docCore UIntPtr
The document handle.
Fields
m_bSkipGravity
The flag to skip gravity
protected bool m_bSkipGravity
Field Value
Properties
ActiveSimulationConfiguration
Gets or sets the active simulation configuration.
public Configuration ActiveSimulationConfiguration { get; set; }
Property Value
Configurations
Gets or sets the configurations.
public Configuration[] Configurations { get; set; }
Property Value
CountOfMFLinearStaticSimulationConfigurations
Gets the count of mf linear static simulation configurations.
public int CountOfMFLinearStaticSimulationConfigurations { get; }
Property Value
Gravity
Gets or sets the gravity.
public Gravity Gravity { get; set; }
Property Value
Gravity
IconSize
Sets the size of the icon.
public override double IconSize { set; }
Property Value
IncrementTime
Gets or sets the increment time.
public double IncrementTime { get; set; }
Property Value
SimulationScenarioTypeName
Gets the name of the simulation scenario type.
public virtual string SimulationScenarioTypeName { get; }
Property Value
UseIncrementTime
Gets or sets the use increment time.
public bool UseIncrementTime { get; set; }
Property Value
UseToolkitSubsystem
Determines whether this used toolkit subsystem.
public virtual bool UseToolkitSubsystem { get; }
Property Value
Methods
AddConfiguration(Configuration)
Adds the configuration.
public bool AddConfiguration(Configuration config)
Parameters
config Configuration
The configuration.
Returns
CheckBeforeSave()
Check before save.
protected override void CheckBeforeSave()
ClearConfiguration()
Clears the configuration.
protected void ClearConfiguration()
ClearDocument()
Clears the document.
protected override void ClearDocument()
GetAllArgumentList()
Get all argument list
public override List<keyvaluepair><string string>> GetAllArgumentList()
Returns
ListKeyValuePairstring, string>>
The argument list
GetBodyAndTransformation(ref List)
Get body and transformation information.
public override void GetBodyAndTransformation(ref List<document3d> lstBodyInfo)
Parameters
lstBodyInfo List
The body information.
GetData(XmlNode)
Gets the analysis document information data.
public override void GetData(XmlNode writer)
Parameters
writer XmlNode
The writer.
GetDefaultMaterial()
Gets the default material.
public IMaterial GetDefaultMaterial()
Returns
IMaterial
GetDefaultMaterial(bool)
Gets the default material.
public IMaterial GetDefaultMaterial(bool bAdd)
Parameters
bAdd bool
The [add to document] flag.
Returns
IMaterial
GetEntityRequest()
Gets entity request
public Dictionary<iobjectbase bool> GetEntityRequest()
Returns
GetSimulationConfigurationType()
Gets the type of the simulation configuration.
public virtual string GetSimulationConfigurationType()
Returns
The simulation configuration type.
GetStateFromActiveSimulationScenarioMap(Scenario)
Gets the state from active simulation scenario map.
public bool GetStateFromActiveSimulationScenarioMap(Scenario ss)
Parameters
ss Scenario
The ss.
Returns
InitializeSimParam()
Initializes the simulation parameter.
protected abstract void InitializeSimParam()
IsContainSimulationScenarioInMap(Scenario)
Determines whether [is contain simulation scenario in map] [the specified ss].
public bool IsContainSimulationScenarioInMap(Scenario ss)
Parameters
ss Scenario
The ss.
Returns
IsEnabledImpl(ObjectBase)
Determines whether is enabled [the specified object] [implementation].
protected override bool IsEnabledImpl(ObjectBase ob)
Parameters
ob ObjectBase
The object.
Returns
true if is enabled [the specified object]; otherwise, false.
IsExistDefaultMaterial()
Determines whether [is exist default material].
public bool IsExistDefaultMaterial()
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.
OnPostMakeDocument(DocCreateInfo)
Called when [post make document].
protected override sealed void OnPostMakeDocument(DocCreateInfo info)
Parameters
info DocCreateInfo
The [document create information].
OnPostMakeDocumentImpl(DocCreateAnalysisInfo)
Called when [post make document] [implementation].
protected virtual void OnPostMakeDocumentImpl(DocCreateAnalysisInfo info)
Parameters
info DocCreateAnalysisInfo
The [analysis document create information].
PostCloseDocument()
Called after close document
public override void PostCloseDocument()
PostOpenDocument()
Posts the open document.
public override void PostOpenDocument()
PostOpenDocumentAfterErrCheckEvent()
called after open document
public override void PostOpenDocumentAfterErrCheckEvent()
PostOpenDocumentAfterHookEvent()
Call when post [open document] after hook event.
public override void PostOpenDocumentAfterHookEvent()
ReAssemblyImpl(ObjectBase)
Reassembly [implementation].
protected override bool ReAssemblyImpl(ObjectBase ob)
Parameters
ob ObjectBase
The object.
Returns
true if success; otherwise, false.
RegisterAddon()
Register addon
protected override void RegisterAddon()
RemoveConfiguration(Configuration)
Removes the configuration.
public bool RemoveConfiguration(Configuration config)
Parameters
config Configuration
The configuration.
Returns
SetData(XmlNode)
Sets the analysis document information data.
public override void SetData(XmlNode reader)
Parameters
reader XmlNode
The reader.
SetEnableImpl(ObjectBase, bool)
Sets the enable [implementation].
protected override void SetEnableImpl(ObjectBase ob, bool bEnable)
Parameters
ob ObjectBase
The object.
bEnable bool
if set to true enable.
SetStateFromActiveSimulationScenarioMap(Scenario, bool)
Sets the state from active simulation scenario map.
public void SetStateFromActiveSimulationScenarioMap(Scenario ss, bool bActive)
Parameters
ss Scenario
The ss.
bActive bool
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.