## On this page # Class CouplerBase<TProperty\\> Last update: 16.07.2025 Namespace: [VM.Managed.DAFUL.Constraints](VM.Managed.DAFUL.Constraints.md) Assembly: VMDCP.dll This base class is to represent the coupler base. ```csharp [CanNotOpenWithNewPreprocessor] public abstract class CouplerBase : Entity, 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](https://learn.microsoft.com/dotnet/api/system.object) ← ObservableObject ← LinkableBase ← ObjectBase ← Object<EntityEventCore> ← ContainerObject<EntityEventCore> ← EntityBase ← Entity<TProperty> ← [CouplerBase<TProperty>](VM.Managed.DAFUL.Constraints.CouplerBase-1.md) #### 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)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkProperties_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkPropertiesAndValues_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_) ## Constructors ### CouplerBase() Initializes a new instance of the class. ```csharp public CouplerBase() ``` ### CouplerBase(string) Initializes a new instance of the class. ```csharp public CouplerBase(string strName) ``` #### Parameters `strName` [string](https://learn.microsoft.com/dotnet/api/system.string) Name of the coupler base. ## Fields ### m\_bSkipToUpdateSymmetric ```csharp protected bool m_bSkipToUpdateSymmetric ``` #### Field Value [bool](https://learn.microsoft.com/dotnet/api/system.boolean) ## Properties ### ArgumentType Gets the type of the argument ```csharp public ArgumentTypes ArgumentType { get; } ``` #### Property Value ArgumentTypes ### HasLayerExplicitly Gets a value indicating whether object has a layer explicitly. ```csharp protected override bool HasLayerExplicitly { get; } ``` #### Property Value [bool](https://learn.microsoft.com/dotnet/api/system.boolean) ### Hide Gets or sets a value indicating whether this instance is hide. ```csharp public bool Hide { get; set; } ``` #### Property Value [bool](https://learn.microsoft.com/dotnet/api/system.boolean) ### Joint1 Gets or sets the first joint. ```csharp public ObjectBase Joint1 { get; set; } ``` #### Property Value ObjectBase ### Joint1\_FullName Gets the full name of the first joint. ```csharp public string Joint1_FullName { get; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) ### Joint2 Gets or sets the second joint. ```csharp public ObjectBase Joint2 { get; set; } ``` #### Property Value ObjectBase ### Joint2\_FullName Gets the full name of second joint. ```csharp public string Joint2_FullName { get; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) ### JointType1 Gets or sets the first joint type. ```csharp public CouplerBase.JointType JointType1 { get; set; } ``` #### Property Value [CouplerBase](VM.Managed.DAFUL.Constraints.CouplerBase-1.md)<TProperty>.[JointType](VM.Managed.DAFUL.Constraints.CouplerBase-1.JointType.md) ### JointType2 Gets or sets the second joint type. ```csharp public CouplerBase.JointType JointType2 { get; set; } ``` #### Property Value [CouplerBase](VM.Managed.DAFUL.Constraints.CouplerBase-1.md)<TProperty>.[JointType](VM.Managed.DAFUL.Constraints.CouplerBase-1.JointType.md) ### ReferenceType Gets the type of the array for argument. ```csharp public string ReferenceType { get; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) ## Methods ### Draw(Canvas) Draws the icon. ```csharp public virtual void Draw(Canvas canvas) ``` #### Parameters `canvas` Canvas The canvas has icon information. ### GetChildListImpl() get child list ```csharp protected virtual IEnumerable GetChildListImpl() ``` #### Returns [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1)<ObjectBase> ### GetModelNavigatorInformationImpl(XmlDocument, XmlElement, bool) Gets the object information for model navigator \[implementation\]. ```csharp protected override bool GetModelNavigatorInformationImpl(XmlDocument xmlDom, XmlElement xmlEle, bool bHasChild) ``` #### Parameters `xmlDom` [XmlDocument](https://learn.microsoft.com/dotnet/api/system.xml.xmldocument) The XmlDocument for object. `xmlEle` [XmlElement](https://learn.microsoft.com/dotnet/api/system.xml.xmlelement) The XmlElement for object. `bHasChild` [bool](https://learn.microsoft.com/dotnet/api/system.boolean) if set to `true` \[has child\]. #### Returns [bool](https://learn.microsoft.com/dotnet/api/system.boolean) `true` if success; otherwise, `false`. ### LinkRequestUpdate(object, LinkEventArgs) Request for update the linked object. ```csharp protected override void LinkRequestUpdate(object objNotifier, LinkEventArgs arg) ``` #### Parameters `objNotifier` [object](https://learn.microsoft.com/dotnet/api/system.object) The linked object. `arg` LinkEventArgs The instance containing the event data. ### ReDraw() Redraw. ```csharp public virtual void ReDraw() ``` ### ReadTemplateImpl(XmlReader) Reads the template document \[implementation\]. ```csharp protected override void ReadTemplateImpl(XmlReader reader) ``` #### Parameters `reader` [XmlReader](https://learn.microsoft.com/dotnet/api/system.xml.xmlreader) The reader. ### WriteTemplateImpl(XmlWriter) Writes the template document \[implementation\]. ```csharp protected override void WriteTemplateImpl(XmlWriter writer) ``` #### Parameters `writer` [XmlWriter](https://learn.microsoft.com/dotnet/api/system.xml.xmlwriter) The writer.