APPENDIX F
SIMPROCESS System Attributes and Methods

Chapter 10 discussed user defined attributes. SIMPROCESS also includes numerous predefined System Attributes and Methods. Each are listed along with a description. Also, there are examples for several of the System Methods.

System Attributes

This section lists all the SIMPROCESS system attributes in a table.

SIMPROCESS System Attributes

Model Elements	Attribute Name1	Get/Set	Attribute Type	Description
System Level2	Model	Get	OBJECT	Reference of the Model being simulated.
	Self	Get	OBJECT	Reference of the Model Element itself.
	Background	Get	BOOLEAN	TRUE if the model is being simulated without the GUI.
	Replication	Get	INTEGER	Current replication number.
Entity Type	Name	Get	STRING	Name of the Entity.
	Priority	Both	INTEGER	Default priority for Entity instances of this type.
	NumberIn	Get	INTEGER	Number of Entity instances of this type currently in the system.
	NumberCreated	Get	INTEGER	Number of Entity instances generated for this type.
	NumberDisposed	Get	INTEGER	Number of disposed Entity instances of this type.
	NumberWaiting	Get	INTEGER	Number of Entity instances of this type waiting for resources
	NumberOnHold	Get	INTEGER	Number of Entity instances of this type holding for condition
	Interrupt	Both	BOOLEAN	Determines whether Entity instances of this type will interrupt the processing of a lower priority Entity.
Entity (instance)	Name	Get	STRING	Name of this Entity.
	Activity	Get	OBJECT	Reference of Activity this Entity instance resides in.
	AcceptTime	Get	REAL	Time Entity enters an Activity or Process.
	ActivityTime	Get	REAL	Total time Entity was in an Activity, whether waiting, on hold, or processing. Does not apply to Processes.
	BatchSize	Get	INTEGER	Number of Entity instances in this Entity's batch.
	CreateTime	Get	REAL	Time the Entity instance was created.
	EndWait	Both	BOOLEAN	TRUE if Entity wait for Resources was interrupted by MaxWait time.
	EnterTime	Get	REAL	Time the Entity instance entered the current Activity.
	HasParent	Get	BOOLEAN	TRUE if the Entity instance was created by a Split Activity.
	LastDelay	Get	REAL	Last processing delay time at an Activity.
	MaxWait	Both	REAL	Maximum time Entity will wait for Resource allocation. Default is 0.0 (unlimited).
	NumberIn	Get	INTEGER	Number of Entity instances of the same type currently in the system.
	NumberCreated	Get	INTEGER	Number of Entity instances of the same type has generated.
	NumberDisposed	Get	INTEGER	Number of Entity instances of the same type has disposed.
	NumberWaiting	Get	INTEGER	Number of Entity instances of the same type waiting for resources
	NumberOnHold	Get	INTEGER	Number of Entity instances of the same type holding for condition
	Parent	Get	OBJECT	Returns the Parent Entity instance of this Entity instance. An Entity instance only has a Parent when it was created by a Split Activity. The original Entity instance entering the Split Activity is the Parent.
	Priority	Both	INTEGER	Priority of this Entity instance.
	ReleaseTime	Get	REAL	Time Entity is released from an Activity or Process.
	SequenceNum	Get	INTEGER	A unique number given to each Entity as it is created.
	Type	Get	OBJECT	Entity Type reference of this Entity instance.
	Interrupt	Both	BOOLEAN	Determines whether this Entity instance will interrupt the processing of a lower priority Entity.
Resource	Name	Get	STRING	Name of the Resource.
	Activity	Get	OBJECT	Reference of Activity currently trying to assign or free this Resource (if any).
	Capacity	Get	REAL	Resource capacity.
	Entity	Get	OBJECT	Reference of current Entity instance being processed by the Activity trying to assign this Resource (if any).
	LastDowntime	Get	REAL	Duration of most recently initiated downtime.
	NumberWaiting	Get	INTEGER	Number of Entities waiting for this Resource.
	StartDowntime	Get	REAL	Time most recently initiated downtime started.
	UnitsBusy	Get	REAL	Number of units of the Resource in busy state.
	UnitsDown	Get	REAL	Number of units of the Resource not available because of the application of a downtime.
	UnitsIdle	Get	REAL	Number of units of the Resource in idle state.
Connector	Name	Get	STRING	Name of the Connector.
	NumberAccepted	Get	INTEGER	Number of Entities so far entered the Connector.
	NumberReleased	Get	INTEGER	Number of Entities exited the Connector.
	NumberIn	Get	INTEGER	Number of Entities currently on the Connector.
	LastDelay	Get	REAL	The value most recently initiated delay.
	NextDelay	Set	REAL	Change the value of the next delay ONLY.
	AllFutureDelays	Set	REAL	Change the value of all future delays henceforth.
Activity's Group I	Name	Get	STRING	Name of the Activity.
	Parent	Get	OBJECT	Reference of this Activity's parent process.
	Entity	Get	OBJECT	Reference of the current Entity.
	Sibling(name: STRING)	Get	OBJECT	It returns the reference to the Activity or process with the specified name in the same hierarchical level.
Activity's Group II	NumberAccepted	Get	INTEGER	Number of Entities so far entered this Activity.
	NumberReleased	Get	INTEGER	Number of Entities exited this Activity.
	NumberIn	Get	INTEGER	Number of Entities currently at this Activity.
Activity's Group III	LastDelay	Get	REAL	The value of the most recently initiated delay.
	NextDelay	Set	REAL	Change the value of the next delay ONLY.
	AllFutureDelays	Set	REAL	Change the value of all future delays henceforth.
Assemble	Group I, II, & III
	ActivatedByNoMatch	Get	BOOLEAN	Checks if the expression is activated by an Entity exiting through the NoMatch Pad.
	ActivatedByTrigger	Get	BOOLEAN	Checks if the expression is activated by an Entity entering from the Trigger Pad.
	AssembleEntityType	Both	OBJECT	Type of Entity to create when an Assemble occurs.
	BatchEntities	Both	BOOLEAN	Value for whether to batch component Entities with assembled Entity.
	NumberWaiting	Get	INTEGER	Number of Entities at this activity waiting for resources.
	NumberOnHold	Get	INTEGER	Number of Entities at this activity holding for condition.
Assign	Group I, II, & III
	NumberWaiting	Get	INTEGER	Number of Entities at this activity waiting for resources
Batch	Group I, II, & III
	BatchEntityType	Both	OBJECT	Type of Entity to create when a Batch occurs.
	MaxBatchSize	Both	INTEGER	Number of Entities to batch.
	MinBatchSize	Both	INTEGER	Number of Entities must be in a batch before it can be released.
	MaxWaitTime	Both	REAL	Time to wait before releasing undersize batch.
	NumberWaiting	Get	INTEGER	Number of Entities at this activity waiting for resources
	NumberOnHold	Get	INTEGER	Number of Entities at this activity holding for condition
Branch	Group I, II, & III
	BranchName	Set	STRING	Name of the Connector to be taken by the next Entity.
	NumberWaiting	Get	INTEGER	Number of Entities at this activity waiting for resources
Clone	Group I, II, & III
	NumOutEntities	Both	INTEGER	Number of Entities to output per Connector.
	NumberWaiting	Get	INTEGER	Number of Entities at this activity waiting for resources
Delay	Group I, II, & III
	NumberWaiting	Get	INTEGER	Number of Entities at this activity waiting for resources
Dispose	Group I & II
	MaxCount	Both	INTEGER	Number of Entities disposed to signal End Simulation event.
	NumberDisposed	Get	INTEGER	Number of Entities so far disposed at this Activity.
Free Resource	Group I & II
Gate	Group I, II, & III
	ActivatedByTrigger	Get	BOOLEAN	Checks if the expression is activated by an Entity entering from the Trigger Pad.
	AutoRelCount	Both	INTEGER	Number of Entities for threshold release. <