XPRMProcedure Class

A procedure or function supplied by a module or implemented in a model. This class is used for both named procedures and procedure-typed variables and values.

Inheritance Hierarchy

System.Object
   Mosel.XPRMObjectBase
     Mosel.XPRMTypedObject
       Mosel.XPRMValue
         Mosel.XPRMProcedure

Namespace:   Mosel
Assembly:  xprmdn (in xprmdn.dll) Version: 6.6.0

Syntax

C#

public class XPRMProcedure : XPRMValue, 
	XPRMIdentifier, XPRMObject, XPRMNamed, XPRMTyped

The XPRMProcedure type exposes the following members.

Properties

	Name	Description
	IsInitialised	Checks whether this value is initialized (Overrides XPRMValue.IsInitialised.)
	Model	Used to fetch the XPRM model to which this object belongs, or else 'null' if there is no model anywhere among this Object's ancestors. (Inherited from XPRMObjectBase.)
	Name	Property to get this identifier's name
	NbParameters	Number of parameters (arguments) expected by the subroutine.
	Owner	Used to fetch the XPRM object to which this object belongs (Inherited from XPRMObjectBase.)
	ParameterTypes	The string of parameter types. This is a text string describing which arguments are expected by the function: it is its signature. This string is composed with the following characters: i - an integer; r - a real; s - a text string; b - a Boolean; v - a decision variable (type mpvar); c - a linear constraint (type linctr); I - a range set; a - an array (of any kind); e - a set (of any type); |xxx| - external type named 'xxx'; !xxx! - the set named 'xxx'; Andx.t - an array indexed by 'ndx' of the type 't'. 'ndx' is a string describing the type of each indexing set. 'ndx' may be omitted, in which case any array of type 't' is a valid parameter; Et - a set of type 't'. For instance, the procedure: proc(n:integer, tab:array(range, set of real, myset) of string, flag:boolean) has the signature 'iAIr!myset!.sb'.
	ReturnType	Numeric type code for return value of the procedure. A combination of TYP_*, STR_* and GRP_* values. For module procedures returned by XPRMModule.Procedures, this may be (int)XPRMVarType.EXTN in which case the type name can be fetched from the ReturnTypeName propery.
	ReturnTypeName	Name of the return type of this procedure
	StructCode	(Inherited from XPRMTypedObject.)
	StructName	(Inherited from XPRMTypedObject.)
	Type	(Inherited from XPRMTypedObject.)
	TypeCode	(Inherited from XPRMTypedObject.)
	TypeName	(Inherited from XPRMTypedObject.)

Top

Methods

	Name	Description
	AsArray	An array type value. This function is defined if the actual object is of a array type. (Inherited from XPRMValue.)
	AsBoolean	A Boolean. This function is defined if the actual object is a Boolean (Inherited from XPRMValue.)
	AsExternal	An external type value. This function is defined if the actual object is of an external type. (Inherited from XPRMValue.)
	AsInteger	An integer. This function is defined if the actual object is an integer. (Inherited from XPRMValue.)
	AsLinCtr	A linear constraint. This function is defined if the actual object is a linear constraint. (Inherited from XPRMValue.)
	AsList	A list type value. This function is defined if the actual object is of a list type. (Inherited from XPRMValue.)
	AsMPVar	A decision variable. This function is defined if the actual object is a decision variable. (Inherited from XPRMValue.)
	AsProblem	A problem. This function is defined if the actual object is a problem. (Inherited from XPRMValue.)
	AsProcedure	A procedure type value. This function is defined if the actual object is of a procedure type. (Overrides XPRMValue.AsProcedure().)
	AsReal	A real. This function is defined if the actual object is a real. (Inherited from XPRMValue.)
	AsRecord	A record type value. This function is defined if the actual object is of a record type. (Inherited from XPRMValue.)
	AsSet	A set type value. This function is defined if the actual object is of a set type. (Inherited from XPRMValue.)
	AsString	A string. This function is defined if the actual object is a string. (Inherited from XPRMValue.)
	AsUnion	A union type value. This function is defined if the actual object is of a union type. (Inherited from XPRMValue.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	FindLocation	Find the location of the procedure in the source.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Next	Get the next overloaded version of the subroutine (model routine only). A subroutine may be defined several times in a model with different sets of arguments. This function gives access to all the defined overloaded versions of a subroutine.
	ToString	Returns a string representation of this procedure (Overrides XPRMTypedObject.ToString().)

Top

See Also

Reference

Mosel Namespace

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.