XPRMSet Class

A set in Mosel.

Inheritance Hierarchy

SystemObject
   MoselXPRMObjectBase
     MoselXPRMTypedObject
       MoselXPRMValue
         MoselXPRMSet

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

Syntax

C#

Copy

public class XPRMSet : XPRMValue

The XPRMSet type exposes the following members.

Properties

	Name	Description
	FirstIndex	The index of the first element in the set. From the library, set elements are accessed using an index.
	IsDynamic	Check whether the set is dynamic.
	IsEmpty	Check whether the set is empty.
	IsFixed	Check whether the set is fixed. A dynamic set is "fixed" when it is used to index an array: it may be extended by receiving new elements but it cannot be re-assigned or reduced.
	IsInitialised	Check whether the set has been initialised. Objects are initialised during model execution. Trying to access a Mosel object that has not been created will result on an exception. (Overrides XPRMValueIsInitialised.)
	IsRange	Check whether the set is a range set.
	LastIndex	The index of the last element in the set. From the library, set elements are accessed using an index.
	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.)
	Owner	Used to fetch the XPRM object to which this object belongs (Inherited from XPRMObjectBase.)
	Size	Get set size.
	StructCode	(Inherited from XPRMTypedObject.)
	StructName	(Inherited from XPRMTypedObject.)
	Type	(Overrides XPRMTypedObjectType.)
	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.)
	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. (Overrides XPRMValueAsSet.)
	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	(Overrides ObjectEquals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Get	Get the element associated to the given index. Throws an exception if the index corresponds to no element in the set
	GetAsBoolean	Get the element associated to the given index (set of booleans). Throws an exception if this is not a set of booleans.
	GetAsInteger	Get the element associated to the given index (set of integers). Throws an exception if this is not a set of integers.
	GetAsReal	Get the element associated to the given index (set of reals). Throws an exception if this is not a set of reals.
	GetAsString	Get the element associated to the given index (set of strings). Throws an exception if this is not a set of strings .
	GetHashCode	(Overrides ObjectGetHashCode.)
	GetIndex(Boolean)	Get the index of the given element (set of Booleans). Throws an exception if this set does not contain booleans
	GetIndex(Double)	Get the index of the given element (set of reals). Throws an exception if this set does not contain reals.
	GetIndex(Int32)	Get the index of the given element (set of integers). Throws an exception if this set does not contain integers.
	GetIndex(String)	Get the index of the given element (set of strings). Throws an exception if this set does not contain strings.
	GetIndex(XPRMValue)	Get the index of the given element.
	GetType	Gets the type of the current instance. (Inherited from Object.)
	GetValues	Returns an array of XPRMValue objects containing the members of this set
	GetValuesAsIntegers	Returns an array containing the elements of a set of integers. Throws an exception if this is not a set of integers
	GetValuesAsReals	Returns an array containing the elements of a set of floating point numbers. Throws an exception if this is not a set of floating point numbers.
	GetValuesAsStrings	Returns an array containing the elements of a set of strings. Throws an exception if this is not a set of strings .
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Generate a string representation of the content of the set. (Overrides XPRMTypedObjectToString.)

Top

See Also

Reference

Mosel Namespace

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