Variables Guide
You also want an ePaper? Increase the reach of your titles
YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.
ARENA VARIABLES USER’S GUIDE<br />
GRPTYP [ ( Entity Number ) ]—Group type. When referencing the representative of a<br />
group formed at a Group module, GrpType returns 1 if it is a temporary group and 2 if<br />
it is a permanent group. If there is no group, a 0 will be returned.<br />
ISG ( Rank )—Grouped entity jobstep attribute. This function returns the specialpurpose<br />
jobstep (Entity.Jobstep or IS) attribute value of the entity at the specified<br />
Rank of the active entity’s group.<br />
MG ( Rank )—Grouped entity station attribute. This function returns the specialpurpose<br />
station (Entity.Station or M) attribute value of the entity at the specified Rank<br />
of the active entity’s group.<br />
NSG ( Rank )—Grouped entity sequence attribute. This function returns the specialpurpose<br />
sequence (Entity.Sequence or NS) attribute value of the entity at the<br />
specified Rank of the active entity’s group.<br />
NG [ ( Entity Number ) ]—Number of grouped entities. NG returns the number of<br />
entities in the group of representative Entity Number. If Entity Number is defaulted,<br />
NG returns the size of the active entity’s group.<br />
SAG ( Attribute Number )—Sum of grouped entity attributes. SAG adds the values of<br />
the specified Attribute Number of all members of the active entity’s group. The data<br />
type of the specified attribute must be numeric. The function NSYM may be used to<br />
translate an attribute name into the desired Attribute Number.<br />
Other entity variables<br />
ATTR ( Attribute Number [, Index 1, Index 2 ] )—Attribute value. ATTR returns the<br />
value of general-purpose attribute Attribute Number with associated indices Index 1<br />
and Index 2. The number of indices specified must match the number defined for the<br />
attribute. This variable is used when the actual Attribute ID to be accessed is stored in<br />
another attribute, a variable, a static, and so on.<br />
Note: The value of ATTR(Attribute Name) is not the same as the value of simply the<br />
Attribute Name. Using the Attribute Name returns the actual attribute value. Function<br />
NSYM may be used to translate an attribute identifier into the desired Attribute<br />
Number.<br />
EntityNumberIsValid ( Entity Number )—Entity Number is Valid. Each entity is given<br />
a unique number when created to act as its record of existence. This variable function<br />
returns a 1 if the argument Entity Number is the number of an entity that currently<br />
exists in the simulation, and 0 otherwise (1 for True, 0 for False).<br />
8