pw:: TRexCondition

pw::TRexCondition create

This action creates a new T-Rex condition object.

Parameters

None

Returns

This action returns a new pw::TRexCondition object.

pw::TRexCondition getByName name

This action gets a T-Rex condition object with the given name.

Parameters

Returns

This action returns a pw::TRexCondition object.

pw::TRexCondition getByEntities register_list

This action returns a list of T-Rex condition objects, one for each input register.

Parameters

Returns

This action retuns a list of pw::TRexCondition objects.

Information

If a given register does not have a T-Rex condition assigned to it, the “Unspecified” T-Rex condition will be returned.  However calling the getRegisters action on the “Unspecified” T-Rex condition will only return the register if it is currently part of an active UnstructuredSolver mode.

pw::TRexCondition getNames

This action gets a list of T-Rex condition names.

Parameters

None

Returns

This action returns the T-Rex condition names as a list of strings.

pw::TRexCondition get/setAutomaticWallSpacing spacing

This attribute is the spacing to automatically apply whenever the type of a T-Rex condition is set to Wall.

Type

This attribute is a float with the range [0, infinity).

Default

The default for this attribute is 0.1.

$tc get/setName name

This attribute is the name of the T-Rex condition.

Type

This attribute is a string.

Default

The default for this attribute is a uniquely generated name.

$tc get/setConditionType type

This attribute is the condition type of the T-Rex condition.

Type

This attribute is a string with values < Off | Wall | Match | AdjacentGrid >.

Default

The default for this attribute is Off.

$tc get/setAdaptation adapt

This attribute is the adaptation type of the T-Rex condition.

Type

This attribute is a string with values < Off | On >.

Default

The default for this attribute is Off.

$tc get/setSpacing spacing

This attribute is the spacing of the T-Rex condition.

Type

This attribute is a float.

Default

The default for this attribute is 0.0.

$tc delete

This action deletes this T-Rex condition.

Parameters

None

Returns

This action returns nothing.

$tc apply register_or_entity_list

This action applies this TRex boundary condition to a set of entities and/or entity registers.  If an entity is specified, the default boundary condition for that entity is set, but no registers that use that entity are affected.  The default boundary condition for an entity is applied when the entity is used in a new higher-level entity.

When applying boundary conditions to an entity, this action only sets the “default” condition for that entity.  The “default” condition is applied to all subsequent uses (registers) of that entity.  In comparison, when a boundary condition is applied to a register, this action sets the condition for both the register and changes the “default” condition for the entity.

Parameters

Returns

This action returns nothing.

$bc getRegisters ?-visibility onoff?

This action returns the registers that this boundary condition has been applied to.

Parameters

Returns

This action returns a list of registers.

Information

If this is the “Unspecified” T-Rex condition, the registers that will be returned are only those registers that are currently part of an active UnstructuredSolver mode.  If this is called during an active solver mode, it will return only the registers that are active in the solver.  This means that is may be an incomplete list of the registers using the boundary condition.

$bc getRegisterCount ?-visibility onoff?

This action returns the number of registers that this boundary condition has been applied to.

Parameters

Returns

This action returns an integer value.

Information

This returns a count of all registers that use the boundary condition.  If this is called while a solver mode is active, it includes both the registers that are active in the solver and registers not active in the solver.  Note that the getRegisters function only returns the former and not the latter.