NairnFEAMPM Icon

Entity Command

The Entity command lets you define entities to appear in the XML output commands:

Entity (name),(value)

where (name) is the entity name (without the & and semicolon, e.g., maxTime to refer to XML entity &maxTime;) and (value) is its value.

These entities do not have much function when building and running calculations all in NairnFEAMPM, but if you transfer the XML commands to another computer for runs and might then want to directly edit those XML commands, it can be convenient to have entities predefined in the file ready for various uses.

Notes

  1. Once entities are defined, you can use then in selected commands. For example, the MaximumTime Command will accept an entity to set the maximum time. Each command that allows an entity will be documented as accepting them. In commands that directly support entity use, you can provide the name without the leading ampersand (&) and trailing semicolon (;) or with them if enclosed in quotes (e.g., maxTime or "&maxTime;") The commands that accept entities are all commands intended to accept numerical values.
  2. You can also use entities on most commands that expect string arguments such as the Archive Command or in place of any argument that can be a user-defined function. In this usage, you must use the complete entity name including the leading ampersand (&) and trailing semicolon (;) and enclose it in quotes (e.g., "&arch;"). This usage works for many, but not all, commands that accept string arguments. When in doubt, you can test by providing an entity and then checking the resulting XML to verify the entity was inserted as expected. In addition, the entity you provide is inserted without verifying you have actually defined that entity. It is your responsibility to make sure they are defined in an Entity command.