Class Reference | Ansys Developer Portal

Namespace: VM.Managed
Assembly: VMAppCore.dll

This class is to represent the reference.

public class Reference : Object<ObjectEventCore>, IObservableObject, IDisposableObject, ILinkable, IObjectBase, IObject, ILinkContainer, IOwned, IHasID, IEventProvider, IHasKeyObject, ILinkContainerEvent, IVerifiable, IHistoryObjectSerializable, IAttributeContainer, IReferencable, INamed, INavigatorItem, IVisible, IReferenceAutoContactable, IAutoContactable, IBody

Inheritance

object ← ObservableObject ← LinkableBase ← ObjectBase ← Object<ObjectEventCore> ← Reference

Derived

Implements

IObservableObject, IDisposableObject, ILinkable, IObjectBase, IObject, ILinkContainer, IOwned, IHasID, IEventProvider, IHasKeyObject, ILinkContainerEvent, IVerifiable, IHistoryObjectSerializable, IAttributeContainer, IReferencable, INamed, INavigatorItem, IVisible, IReferenceAutoContactable, IAutoContactable, IBody

Inherited Members

Object<ObjectEventCore>.GetKey(), Object<ObjectEventCore>.Initialize(Unit.ConvertFactor), Object<ObjectEventCore>.SetIconColor(Canvas), Object<ObjectEventCore>.OnDeserialization(object), Object<ObjectEventCore>.CustomGetObjectData(SerializationInfo, StreamingContext), Object<ObjectEventCore>.RollbackEvent(), Object<ObjectEventCore>.OnDeserializedCore(object), Object<ObjectEventCore>.Key, Object<ObjectEventCore>.UntypedEventCore, Object<ObjectEventCore>.EventCore, Object<ObjectEventCore>.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

Reference(ObjectBase)

Initializes a new instance of the class.

public Reference(ObjectBase obj)

Parameters

obj ObjectBase

The object for reference.

Reference(SerializationInfo, StreamingContext)

Initializes a new instance of the class.

protected Reference(SerializationInfo info, StreamingContext context)

Parameters

info SerializationInfo

Serialization info.

context StreamingContext

context.

Properties

ClearChildInfoBeforeDeserialize

Before deserialize, info of child clear.

protected override bool ClearChildInfoBeforeDeserialize { get; }

Property Value

FullName

Gets the full name.

public virtual string FullName { get; }

Property Value

FullTransformation

Gets the full transformation info. of reference.

public TMatrix FullTransformation { get; }

Property Value

FullTransformationInKernel

Gets the full transformation info. of reference.

public TMatrix FullTransformationInKernel { get; }

Property Value

IsVisible

Gets or sets a value indicating whether object is visible.

public bool IsVisible { get; set; }

Property Value

Layer

Gets or sets the layer of reference.

virtual Layer Layer { get; set; }

Property Value

Name

Gets or sets the name.

public virtual string Name { get; set; }

Property Value

NonSymmetricName

Gets the name of the non symmetric.

public virtual string NonSymmetricName { get; }

Property Value

Object

Gets or sets the object of reference.

public ObjectBase Object { get; set; }

Property Value

OwnerInstance

Gets the owner instance of reference.

public Instance OwnerInstance { get; }

Property Value

Prototype

Gets the prototype of reference.

public ObjectBase Prototype { get; }

Property Value

Transformation

Gets the transformation info. of reference.

public TMatrix Transformation { get; }

Property Value

Methods

GetContactables()

Get contactable objects.

public virtual ObjectBase[] GetContactables()

Returns

The contactable objects.

GetFullTransform(Unit)

Gets the info. of full transform.

protected TMatrix GetFullTransform(Unit unitToConvert)

Parameters

unitToConvert Unit

The unit to convert.

Returns

The transform.

GetModelNavigatorInformationImpl(XmlDocument, XmlElement, bool)

Gets the object information for model navigator [implementation].

protected virtual bool GetModelNavigatorInformationImpl(XmlDocument xmlDom, XmlElement xmlRootEle, bool bHasChild)

Parameters

xmlDom XmlDocument

The XmlDocument for object.

xmlRootEle XmlElement

The XmlElement for object.

bHasChild bool

if set to true [has child].

Returns

true if success; otherwise, false.

GetTotalSubSystemName(Document3D, ObjectBase)

Gets the subsystem name of total.

protected string GetTotalSubSystemName(Document3D doc, ObjectBase obObject)

Parameters

doc Document3D

The document.

obObject ObjectBase

The object.

Returns

The subsystem name.

GetTotalSubSystemNameCore(Document3D, Document3D, ref Stack<string>, ref ValueType)

protected void GetTotalSubSystemNameCore(Document3D docSS, Document3D docOriginal, ref Stack<string> stackName, ref ValueType bFind)

Parameters

docSS Document3D

docOriginal Document3D

stackName Stack<string>

bFind ValueType

GetTransform(Unit)

Gets the info. of transform.

protected TMatrix GetTransform(Unit unitToConvert)

Parameters

unitToConvert Unit

The unit to convert.

Returns

The transform.

IsAutoContactable()

Determines whether the specified auto contactable.

public virtual bool IsAutoContactable()

Returns

true if the specified auto contactable; otherwise, false.

IsOwner(Reference)

Determines whether the specified owner.

public virtual bool IsOwner(Reference A_0)

Parameters

A_0 Reference

Returns

true if the specified owner; otherwise, false.

LinkAddedToDocument(object, AddToDocEventArgs)

Add linked object to a document.

public override void LinkAddedToDocument(object objNotifier, AddToDocEventArgs arg)

Parameters

objNotifier object

The linked object.

arg AddToDocEventArgs

The instance containing the event data.

LinkRequestDestroy(object, LinkEventArgs)

Request for destroy the linked object.

protected override void LinkRequestDestroy(object obNotifier, LinkEventArgs arg)

Parameters

obNotifier object

The linked object.

arg LinkEventArgs

The instance containing the event data.

LinkRequestUpdate(object, LinkEventArgs)

Request for update the linked object.

protected override void LinkRequestUpdate(object obNotifier, LinkEventArgs arg)

Parameters

obNotifier object

The linked object.

arg LinkEventArgs

The instance containing the event data.

SetModified(ModifiedType)

Called when object modified.

public override void SetModified(ModifiedResult.ModifiedType type)

Parameters

type ModifiedResult.ModifiedType

The modifed type.

SetModified()

Called when object modified.

public override void SetModified()

Home

Connect with Ansys