Class Function
Last update: 16.07.2025Namespace: VM.Managed.DAFUL
Assembly: VMDSB.dll
This class is to represent the function.
public class Function : SubEntity, IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IHistoryObjectSerializable, IAttributeContainer, ISubEntity, IEntityBase, IObjectBase, IObject, ILinkContainer, IOwned, IHasID, IEventProvider, IHasKeyObject, IHasName, IEnabled, IHasComment, INamed, INavigatorItem, IInterface, ITemplateObject, IArgument, IReportable, IDuplicate, IPostDeserialized
Inheritance
object ← ObservableObject ← LinkableBase ← ObjectBase ← Object<ObjectEventCore> ← SubEntity ← Function
Implements
IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IHistoryObjectSerializable, IAttributeContainer, ISubEntity, IEntityBase, IObjectBase, IObject, ILinkContainer, IOwned, IHasID, IEventProvider, IHasKeyObject, IHasName, IEnabled, IHasComment, INamed, INavigatorItem, IInterface, ITemplateObject, IArgument, IReportable, IDuplicate, IPostDeserialized
Inherited Members
SubEntity.Initialize(Unit.ConvertFactor), SubEntity.GetModelNavigatorInformationImpl(XmlDocument, XmlElement, bool), SubEntity.FixUp(ObjectBase), SubEntity.WriteTemplateImpl(XmlWriter), SubEntity.ReadTemplateImpl(XmlReader), SubEntity.Name, SubEntity.FullName, SubEntity.NonSymmetricName, SubEntity.DisplayName, SubEntity.IsEnabled, SubEntity.Comment, 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
Function()
Initializes a new instance of the
[Obsolete]
public Function()
Function(ExpressionTypes)
Initializes a new instance of the
public Function(ExpressionTypes expressionTypes)
Parameters
expressionTypes ExpressionTypes
The function expression type.
Function(string)
Initializes a new instance of the
[Obsolete]
public Function(string strName)
Parameters
strName string
Name of the function.
Function(string, ExpressionTypes)
Initializes a new instance of the
public Function(string strName, ExpressionTypes expressionTypes)
Parameters
strName string
Name of the function.
expressionTypes ExpressionTypes
The function expression type.
Properties
ArgumentList
Gets or sets the argument list.
public ArgumentListGeneral ArgumentList { get; set; }
Property Value
ArgumentType
Gets the type of the argument
public ArgumentTypes ArgumentType { get; }
Property Value
ArgumentTypes
Expression
Gets or sets the expression.
public string Expression { get; set; }
Property Value
FunctionExpressionType
public ExpressionTypes FunctionExpressionType { get; set; }
Property Value
ExpressionTypes
IsInterface
Gets or sets a value indicating whether this instance is interface.
public bool IsInterface { get; set; }
Property Value
IsPerformanceIndex
Gets or sets a value indicating whether this instance is the peformance index.
public bool IsPerformanceIndex { get; set; }
Property Value
PredefinedKeywords
public static IEnumerable<string> PredefinedKeywords { get; }
Property Value
PythonInterpreterPath
The path to the python interpreter(python.exe)
public static string PythonInterpreterPath { get; set; }
Property Value
ReferenceType
Gets the type of the array for argument.
public string ReferenceType { get; }
Property Value
SolverModulePath
The path to the console solver directory
public static string SolverModulePath { get; set; }
Property Value
Methods
ContainsReservedArgument()
Determines whether [contains] [the reserved arg].
public bool ContainsReservedArgument()
Returns
true if [contains] [the reserved arg]; otherwise, false.
CreateSimplePythonFunction(string)
public static Function CreateSimplePythonFunction(string strName)
Parameters
strName string
Returns
Initialize(ConvertFactor)
Initializes member through unit convert factor.
public override void Initialize(Unit.ConvertFactor factor)
Parameters
factor Unit.ConvertFactor
The unit convert factor.
LinkAddedToDocumentCore(IOwned, bool)
protected override void LinkAddedToDocumentCore(IOwned owner, bool bBackup)
Parameters
owner IOwned
bBackup bool
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
ReadTemplateImpl(XmlReader)
Reads the template document [implementation].
protected override void ReadTemplateImpl(XmlReader reader)
Parameters
reader XmlReader
The reader.
RefineExpression(ExpressionParser)
public void RefineExpression(ExpressionParser parser = null)
Parameters
parser ExpressionParser
VerifyExpression(string, string)
public bool VerifyExpression(string strPathPythonExe = null, string strPathSolverDir = null)
Parameters
strPathPythonExe string
strPathSolverDir string
Returns
WriteTemplateImpl(XmlWriter)
Writes the template document [implementation].
protected override void WriteTemplateImpl(XmlWriter writer)
Parameters
writer XmlWriter
The writer.