Class CouplerBase<TProperty\>
Last update: 16.07.2025Namespace: VM.Managed.DAFUL.Constraints
Assembly: VMDCP.dll
This base class is to represent the coupler base.
[CanNotOpenWithNewPreprocessor]
public abstract class CouplerBase<TProperty> : Entity<TProperty>, IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IHistoryObjectSerializable, IAttributeContainer, IContainer, IEntity, IEntityBase, IObjectBase, IObject, ILinkContainer, IOwned, IHasID, IEventProvider, IHasKeyObject, IHasName, IEnabled, IHasComment, IVisible, IDocumentOwner, INamed, INavigatorItem, IVisible, IMultiChangable, IHasProperty, IGroup, IEnableForSimulationScenario, IDraw, IDrawIcon, IArgument, ITemplateObject, IEntityRelation where TProperty : Property, new()
Type Parameters
TProperty
The type of the property.
Inheritance
object ← ObservableObject ← LinkableBase ← ObjectBase ← Object<EntityEventCore> ← ContainerObject<EntityEventCore> ← EntityBase ← Entity<TProperty> ← CouplerBase<TProperty>
Implements
IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IHistoryObjectSerializable, IAttributeContainer, IContainer, IEntity, IEntityBase, IObjectBase, IObject, ILinkContainer, IOwned, IHasID, IEventProvider, IHasKeyObject, IHasName, IEnabled, IHasComment, IVisible, IDocumentOwner, INamed, INavigatorItem, IVisible, IMultiChangable, IHasProperty, IGroup, IEnableForSimulationScenario, IDraw, IDrawIcon, IArgument, ITemplateObject, IEntityRelation
Inherited Members
Entity<TProperty>.Initialize(Unit.ConvertFactor), Entity<TProperty>.GetUnnamedObjectName(object), Entity<TProperty>.FindLocal(string), Entity<TProperty>.Property, EntityBase.Initialize(Unit.ConvertFactor), EntityBase.SetOldNameWithNewEntity(ObjectBase, ObjectBase), EntityBase.PropertyRequestUpdate(object, LinkEventArgs), EntityBase.OnDeserializationForAttribute(), EntityBase.OnUpdatePropertyImpl(Property, LinkEventArgs), EntityBase.LinkRequestDestroying(object, LinkEventArgs), EntityBase.GetModelNavigatorInformationImpl(XmlDocument, XmlElement, bool), EntityBase.FixUp(ObjectBase), EntityBase.FindLocal(string), EntityBase.WriteTemplateImpl(XmlWriter), EntityBase.ReadTemplateImpl(XmlReader), EntityBase.LinkAddedToDocument(object, AddToDocEventArgs), EntityBase.OnDeserialization(object), EntityBase.Name, EntityBase.FullName, EntityBase.NonSymmetricName, EntityBase.DisplayName, EntityBase.IsEnabled, EntityBase.Comment, EntityBase.HasLayerExplicitly, EntityBase.UntypedProperty, EntityBase.IsFileProperty, EntityBase.Layer, EntityBase.IsVisible, ContainerObject<EntityEventCore>.Find(string), ContainerObject<EntityEventCore>.FindLocal(string), ContainerObject<EntityEventCore>.GetUnnamedObjectName(object), ContainerObject<EntityEventCore>.GetNewEntityName(string), ContainerObject<EntityEventCore>.GetNewEntityName(string, bool, int), ContainerObject<EntityEventCore>.GetNewEntityName(string, bool, int, int), Object<EntityEventCore>.GetKey(), Object<EntityEventCore>.Initialize(Unit.ConvertFactor), Object<EntityEventCore>.SetIconColor(Canvas), Object<EntityEventCore>.OnDeserialization(object), Object<EntityEventCore>.CustomGetObjectData(SerializationInfo, StreamingContext), Object<EntityEventCore>.RollbackEvent(), Object<EntityEventCore>.OnDeserializedCore(object), Object<EntityEventCore>.Key, Object<EntityEventCore>.UntypedEventCore, Object<EntityEventCore>.EventCore, Object<EntityEventCore>.Attributes, ObjectBase.ReplaceEventCore(ObjectEventCore), ObjectBase.SetModifiedCore(ModifiedResult.ModifiedType), ObjectBase.AddPostDeserialize(StreamingContext), ObjectBase.LinkAddedToDocumentCore(IOwned, bool), ObjectBase.SetModified(ModifiedResult.ModifiedType), ObjectBase.SetModified(), ObjectBase.SetModified(ModifiedResult.ModifiedType, IDocument), ObjectBase.DestroyObject(object, LinkEventArgs), ObjectBase.DestroyObject(DestroyEventArgs), ObjectBase.DestroyObject(), ObjectBase.Initialize(Unit.ConvertFactor), ObjectBase.FixUp(ObjectBase), ObjectBase.DoWorkAfterUpdateContents(), ObjectBase.SetOldNameWithNewEntity(ObjectBase, ObjectBase), ObjectBase.SetIconColor(Canvas), ObjectBase.RemoveFromCreatedList(), ObjectBase.PostAddToDocument(), ObjectBase.PostRemoveFromDocument(Document), ObjectBase.GetArgumentList(LinkedList<ObjectBase>), ObjectBase.ResetInvalidEntity(), ObjectBase.OnDeserialization(object), ObjectBase.IsSerializableEvent(Delegate), ObjectBase.CustomGetObjectData(SerializationInfo, StreamingContext), ObjectBase.CheckAndUpdateLink(HashSet<ObjectBase>), ObjectBase.Verify(VerifiedResult), ObjectBase.ConnectProxy(), ObjectBase.RollbackEvent(), ObjectBase.LinkRequestUpdating(object, LinkEventArgs), ObjectBase.LinkRequestUpdate(object, LinkEventArgs), ObjectBase.LinkRequestDestroying(object, LinkEventArgs), ObjectBase.LinkRequestDestroy(object, LinkEventArgs), ObjectBase.LinkAddedToDocument(object, AddToDocEventArgs), ObjectBase.LinkRemovedFromDocument(object, RemoveFromDocEventArgs), ObjectBase.DisposeManagedResources(), ObjectBase.GetDestroyEventExtraData(), ObjectBase.OnLinkReserved(ILink, object, EventArgs), ObjectBase.CreateEntityWhenUpdateContents(Action), ObjectBase.GetObjectByKey(UIntPtr), ObjectBase.FindObjectOnXmlDeserialize(string), ObjectBase.UpdateContents(XmlReader, ObjectBase, string), ObjectBase.UpdateContents(XmlReader, ObjectBase), ObjectBase.UpdateContents(string, string), ObjectBase.UpdateContents(string), ObjectBase.SetFlagWhenXMLFile(string, bool), ObjectBase.IsEqualArray<T>(T[], T[]), ObjectBase.IsEqualList(List<double>, List<double>), ObjectBase.SetContainer(IOwned, bool), ObjectBase.GetTargetListForUpdate(), ObjectBase.SkipUpdateObjectImpl(), ObjectBase.raise_OnUpdating(object, LinkEventArgs), ObjectBase.raise_OnUpdate(object, LinkEventArgs), ObjectBase.raise_OnDestroying(object, LinkEventArgs), ObjectBase.raise_OnDestroy(object, LinkEventArgs), ObjectBase.raise_Destroying(object, Identifier), ObjectBase.raise_OnAdded(object, AddToDocEventArgs), ObjectBase.raise_OnRemoved(object, RemoveFromDocEventArgs), ObjectBase.raise_OnContentsUpdated(object, EventArgs), ObjectBase.Dispose(bool), ObjectBase.SkipModified, ObjectBase.ClearChildInfoBeforeDeserialize, ObjectBase.KeyImpl, ObjectBase.ID, ObjectBase.TopologyEntityTypeName, ObjectBase.ObjectStateForCircularError, ObjectBase.ObjectState, ObjectBase.IsChildExternable, ObjectBase.IsExternable, ObjectBase.Container, ObjectBase.Owner, ObjectBase.Document, ObjectBase.UntypedEventCore, ObjectBase.KernelKey, ObjectBase.Key, ObjectBase.OnContentsUpdated, ObjectBase.OnRemoved, ObjectBase.OnAdded, ObjectBase.Destroying, ObjectBase.OnDestroy, ObjectBase.OnDestroying, ObjectBase.OnUpdate, ObjectBase.OnUpdating, LinkableBase.OnDeserialization(object), ObservableObject.Dispose(), ObservableObject.RaisePropertyChanged(string), ObservableObject.RaisePropertyChanged(string, object, object), ObservableObject.Dispose(bool), ObservableObject.DisposeManagedResources(), ObservableObject.DisposeUnmanagedResources(), ObservableObject.IsDisposed, ObservableObject.TryDisposing, ObservableObject.Disposed, ObservableObject.Disposing, ObservableObject.PropertyChanged
Extension Methods
LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)
Constructors
CouplerBase()
Initializes a new instance of the
public CouplerBase()
CouplerBase(string)
Initializes a new instance of the
public CouplerBase(string strName)
Parameters
strName string
Name of the coupler base.
Fields
m_bSkipToUpdateSymmetric
protected bool m_bSkipToUpdateSymmetric
Field Value
Properties
ArgumentType
Gets the type of the argument
public ArgumentTypes ArgumentType { get; }
Property Value
ArgumentTypes
HasLayerExplicitly
Gets a value indicating whether object has a layer explicitly.
protected override bool HasLayerExplicitly { get; }
Property Value
Hide
Gets or sets a value indicating whether this instance is hide.
public bool Hide { get; set; }
Property Value
Joint1
Gets or sets the first joint.
public ObjectBase Joint1 { get; set; }
Property Value
ObjectBase
Joint1_FullName
Gets the full name of the first joint.
public string Joint1_FullName { get; }
Property Value
Joint2
Gets or sets the second joint.
public ObjectBase Joint2 { get; set; }
Property Value
ObjectBase
Joint2_FullName
Gets the full name of second joint.
public string Joint2_FullName { get; }
Property Value
JointType1
Gets or sets the first joint type.
public CouplerBase<TProperty>.JointType JointType1 { get; set; }
Property Value
CouplerBase<TProperty>.JointType
JointType2
Gets or sets the second joint type.
public CouplerBase<TProperty>.JointType JointType2 { get; set; }
Property Value
CouplerBase<TProperty>.JointType
ReferenceType
Gets the type of the array for argument.
public string ReferenceType { get; }
Property Value
Methods
Draw(Canvas)
Draws the icon.
public virtual void Draw(Canvas canvas)
Parameters
canvas Canvas
The canvas has icon information.
GetChildListImpl()
get child list
protected virtual IEnumerable<ObjectBase> GetChildListImpl()
Returns
IEnumerable<ObjectBase>
GetModelNavigatorInformationImpl(XmlDocument, XmlElement, bool)
Gets the object information for model navigator [implementation].
protected override bool GetModelNavigatorInformationImpl(XmlDocument xmlDom, XmlElement xmlEle, bool bHasChild)
Parameters
xmlDom XmlDocument
The XmlDocument for object.
xmlEle XmlElement
The XmlElement for object.
bHasChild bool
if set to true [has child].
Returns
true if success; otherwise, false.
LinkRequestUpdate(object, LinkEventArgs)
Request for update the linked object.
protected override void LinkRequestUpdate(object objNotifier, LinkEventArgs arg)
Parameters
objNotifier object
The linked object.
arg LinkEventArgs
The
ReDraw()
Redraw.
public virtual void ReDraw()
ReadTemplateImpl(XmlReader)
Reads the template document [implementation].
protected override void ReadTemplateImpl(XmlReader reader)
Parameters
reader XmlReader
The reader.
WriteTemplateImpl(XmlWriter)
Writes the template document [implementation].
protected override void WriteTemplateImpl(XmlWriter writer)
Parameters
writer XmlWriter
The writer.
