XPRMParameter Class

A module or model parameter.

Inheritance Hierarchy

System.Object
   Mosel.XPRMObjectBase
     Mosel.XPRMTypedObject
       Mosel.XPRMTypedIdentifier
         Mosel.XPRMParameter

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

Syntax

C#

public abstract class XPRMParameter : XPRMTypedIdentifier

The XPRMParameter type exposes the following members.

Properties

	Name	Description
	Description	Get parameter description. Module parameters may provide a textual description of their functionality. Has value null if none available.
	IsReadable	Check whether the parameter is readable with getparam. This method applies only to module parameters (model parameters are all readable).
	IsWriteable	Check whether the parameter is writeable with setparam. This property applies only to module parameters (model parameters are all writeable).
	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 (Inherited from XPRMTypedIdentifier.)
	Owner	Used to fetch the XPRM object to which this object belongs (Inherited from XPRMObjectBase.)
	StructCode	(Overrides XPRMTypedObject.StructCode.)
	StructName	(Inherited from XPRMTypedObject.)
	Type	(Inherited from XPRMTypedObject.)
	TypeCode	(Inherited from XPRMTypedObject.)
	TypeName	(Inherited from XPRMTypedObject.)
	Value	Current value. Value of parameters are available only after the model has been executed.

Top

Methods

	Name	Description
	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.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Get current value for the given model. Module parameters may have a different value for each model.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a default string representation of the identifier (Inherited from XPRMTypedObject.)

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.