Class Coupler

Namespace: VM.Managed.DAFUL.Constraints
Assembly: VMDCP.dll

This class is to represent the coupler.

public class Coupler : CouplerBase<propertycoupler>, 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

Inheritance

object ← ObservableObject ← LinkableBase ← ObjectBase ← Object ← ContainerObject ← EntityBase ← Entity ← CouplerBase ← Coupler

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

CouplerBase.m_bSkipToUpdateSymmetric, CouplerBase.LinkRequestUpdate(object, LinkEventArgs), CouplerBase.GetModelNavigatorInformationImpl(XmlDocument, XmlElement, bool), CouplerBase.Draw(Canvas), CouplerBase.ReDraw(), CouplerBase.WriteTemplateImpl(XmlWriter), CouplerBase.ReadTemplateImpl(XmlReader), CouplerBase.GetChildListImpl(), CouplerBase.Joint1, CouplerBase.Joint1_FullName, CouplerBase.Joint2, CouplerBase.Joint2_FullName, CouplerBase.JointType1, CouplerBase.JointType2, CouplerBase.HasLayerExplicitly, CouplerBase.Hide, CouplerBase.ReferenceType, CouplerBase.ArgumentType, Entity.Initialize(Unit.ConvertFactor), Entity.GetUnnamedObjectName(object), Entity.FindLocal(string), Entity.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.Find(string), ContainerObject.FindLocal(string), ContainerObject.GetUnnamedObjectName(object), ContainerObject.GetNewEntityName(string), ContainerObject.GetNewEntityName(string, bool, int), ContainerObject.GetNewEntityName(string, bool, int, int), Object.GetKey(), Object.Initialize(Unit.ConvertFactor), Object.SetIconColor(Canvas), Object.OnDeserialization(object), Object.CustomGetObjectData(SerializationInfo, StreamingContext), Object.RollbackEvent(), Object.OnDeserializedCore(object), Object.Key, Object.UntypedEventCore, Object.EventCore, Object.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.ResetInvalidEntity(), ObjectBase.OnDeserialization(object), ObjectBase.IsSerializableEvent(Delegate), ObjectBase.CustomGetObjectData(SerializationInfo, StreamingContext), ObjectBase.CheckAndUpdateLink(HashSet), 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[]), ObjectBase.IsEqualList(List, List), 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(object, LinkPropertyType)

Constructors

Coupler()

Initializes a new instance of the class.

public Coupler()

Coupler(string)

Initializes a new instance of the class.

public Coupler(string strName)

Parameters

strName string

Name of the coupler.

Properties

Joint3

Gets or sets the third joint.

public ObjectBase Joint3 { get; set; }

Property Value

ObjectBase

Joint3_FullName

Gets the full name of the third joint.

public string Joint3_FullName { get; }

Property Value

string

JointType3

Gets or sets the third joint type.

public CouplerBase<propertycoupler>.JointType JointType3 { get; set; }

Property Value

CouplerBasePropertyCoupler>.JointType

NumOfJoint

Gets or sets the number of joint.

public int NumOfJoint { get; set; }

Property Value

int

Methods

Draw(Canvas)

Draws the icon.

public override void Draw(Canvas canvas)

Parameters

canvas Canvas

The canvas has icon information.

GetChildListImpl()

get child list

protected override IEnumerable<objectbase> GetChildListImpl()

Returns

IEnumerable

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

bool

true if success; otherwise, false.

Initialize(ConvertFactor)

Initializes member through unit convert factor.

public override void Initialize(Unit.ConvertFactor factor)

Parameters

factor Unit.ConvertFactor

The unit convert factor.

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 instance containing the event data.

ReDraw()

Redraw.

public override 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.