Initializing help system before first use

XPRMProcedure Class

A procedure or function supplied by a module or implemented in a model.
Inheritance Hierarchy
SystemObject
   MoselXPRMObjectBase
     MoselXPRMTypedObject
       MoselXPRMTypedIdentifier
         MoselXPRMProcedure

Namespace:   Mosel
Assembly:  xprmdn (in xprmdn.dll) Version: 4.8.3.0
Syntax
C#
Copy 
public sealed class XPRMProcedure : XPRMTypedIdentifier

The XPRMProcedure type exposes the following members.

Properties
  Name Description
Public property 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.)
Public property Name
Property to get this identifier's name
(Inherited from XPRMTypedIdentifier.)
Public property NbParameters
Number of parameters (arguments) expected by the subroutine.
Public property Owner
Used to fetch the XPRM object to which this object belongs
(Inherited from XPRMObjectBase.)
Public property 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'.
Public property StructCode (Inherited from XPRMTypedObject.)
Public property StructName (Inherited from XPRMTypedObject.)
Public property Type (Inherited from XPRMTypedObject.)
Public property TypeCode (Inherited from XPRMTypedObject.)
Public property TypeName
String representation of return type
(Overrides XPRMTypedObjectTypeName.)
Top
Methods
  Name Description
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public method FindLocation
Find the location of the procedure in the source.
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method GetType
Gets the type of the current instance.
(Inherited from Object.)
Public method 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.
Public method ToString
Returns a string representation of this procedure
(Overrides XPRMTypedObjectToString.)
Top
See Also

Reference

Mosel Namespace
Covered Topics
Parent Topic Mosel

© 2001-2019 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.