Skip to content

Parameters

Paramaters configure the overall size of the XTS application including the number of objects such as stations or zones needed. Parameters can be viewed and adjusted in GVL\Param.

Note

Mover appears in parameters but is not addressed in this section as it has additional needs when increasing or decreasing its count. Please see Project Customization.

NUM_ Parameters

The provided FB_XTS object includes a set of the objects listed already pre-configured and ready to use.

  • XTS.Mover[]
  • XTS.PositionTrigger[]
  • XTS.Station[]
  • XTS.Zone[]

The size of these arrays is configured with the corresponding NUM_ parameter.

In many XTS applications, especially ones that implement simple station-to-station motion, the provided objects are all that is needed for user code. An simple adjustment of the NUM_ parameter to increase stations, zones or position triggers may be the only parameters that need to be adjusted to fit the application.

MAX_ Parameters

The mediator can manage additional Position Triggers, Stations and Zones outside of those declared in FB_XTS if needed for an application. This can help with code modularity and allows you to create custom objects (as FBs) that contain their own stations, zones and position triggers as needed.

The MAX_ parameters define the absolute maximum number of any of these objects that can be declared. The value selected should be high enough to include the number of objects created by the NUM_ parameter, and any additional objects you will create in user code.

Note

There is no performance penalty for having more MAX_ objects than you actually use. Any objects in the array that have not been configured do not cause additional code to execute. There is a small amount of memory required for extra, unused objects but this often is insignificant in the overall size of the program and memory available on IPCs capable of running XTS.

MAX_ Parameters Example

An example of declaring additional objects that consume space under the MAX_ parameter limits is available in Custom Objects