Conx class

Returns

Conx object

Return type

Conx

Example

To create a new connection in model m, at coordinates (20, 40, 10)

var c = new Conx(m, 20, 40, 10);

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a connection.

Returns

No return value

Example

To associate comment c to the connection c:

c.AssociateComment(c);

Blank()

Description

Blanks the connection

Returns

No return value

Example

To blank connection c:

c.Blank();

BlankAll(Model[Model], redraw (optional)[boolean]) [static]

Description

Blanks all of the connections in the model.

Returns

No return value

Example

To blank all of the connections in model m:

Conx.BlankAll(m);

BlankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

Description

Blanks all of the flagged connections in the model.

Returns

No return value

Example

To blank all of the connections in model m flagged with f:

Conx.BlankFlagged(m, f);

Blanked()

Description

Checks if the connection is blanked or not.

Returns

true if blanked, false if not.

Return type

Boolean

Example

To check if connection c is blanked:

if (c.Blanked() ) do_something...

ClearFlag(flag[Flag])

Description

Clears a flag on the connection.

Returns

No return value

Example

To clear flag f for connection c:

c.ClearFlag(f);

Copy(range (optional)[boolean])

Description

Copies the connection. The target include of the copied connection can be set using Options.copy_target_include.

Returns

Conx object

Return type

Conx

Example

To copy connection c into connection z:

var z = c.Copy();

DetachComment(Comment[Comment])

Description

Detaches a comment from a connection.

Returns

No return value

Example

To detach comment c from the connection c:

c.DetachComment(c);

EmptyPatch()

Description

Empties the patch topology/coordinates data.

Returns

No return value.

Example

To empty the patch topology/coordinates data for connection c;

c.EmptyPatch();

Error(message[string], details (optional)[string])

Description

Adds an error for connection. For more details on checking see the Check class.

Returns

No return value

Example

To add an error message "My custom error" for connection c:

c.Error("My custom error");

ExtractColour()

Description

Extracts the actual colour used for connection.
By default in PRIMER many entities such as elements get their colour automatically from the part that they are in. PRIMER cycles through 13 default colours based on the label of the entity. In this case the connection colour property will return the value Colour.PART instead of the actual colour. This method will return the actual colour which is used for drawing the connection.

Returns

colour value (integer)

Return type

Number

Example

To return the colour used for drawing connection c:

var colour = c.ExtractColour();

First(Model[Model]) [static]

Description

Returns the first connection in the model.

Returns

Conx object (or null if there are no connections in the model).

Return type

Conx

Example

To get the first connection in model m:

var c = Conx.First(m);

FirstFreeLabel(Model[Model], layer (optional)[Include number]) [static]

Description

Returns the first free connection label in the model. Also see Conx.LastFreeLabel(), Conx.NextFreeLabel() and Model.FirstFreeItemLabel().

Returns

Conx label.

Return type

Number

Example

To get the first free connection label in model m:

var label = Conx.FirstFreeLabel(m);

FlagAll(Model[Model], flag[Flag]) [static]

Description

Flags all of the connections in the model with a defined flag.

Returns

No return value

Example

To flag all of the connections with flag f in model m:

Conx.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the connection is flagged or not.

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if connection c has flag f set on it:

if (c.Flagged(f) ) do_something...

ForEach(Model[Model], func[function], extra (optional)[any]) [static]

Description

Calls a function for each connection in the model.
Note that ForEach has been designed to make looping over connections as fast as possible and so has some limitations.
Firstly, a single temporary Conx object is created and on each function call it is updated with the current connection data. This means that you should not try to store the Conx object for later use (e.g. in an array) as it is temporary.
Secondly, you cannot create new connections inside a ForEach loop.

Returns

No return value

Example

To call function test for all of the connections in model m:

Conx.ForEach(m, test);
function test(c)
{
// c is Conx object
}

To call function test for all of the connections in model m with optional object:

var data = { x:0, y:0 };
Conx.ForEach(m, test, data);
function test(c, extra)
{
// c is Conx object
// extra is data
}

GetAll(Model[Model], property (optional)[string]) [static]

Description

Returns an array of Conx objects or properties for all of the connections in a model in PRIMER. If the optional property argument is not given then an array of Conx objects is returned. If the property argument is given, that property value for each connection is returned in the array instead of a Conx object

Returns

Array of Conx objects or properties

Return type

Array

Example

To make an array of Conx objects for all of the connections in model m:

var a = Conx.GetAll(m);

To return an array containing the value of property 'foo' (for example 'x' for a node) for each connection in model m:

var a = Conx.GetAll(m, 'foo');

GetComments()

Description

Extracts the comments associated to a connection.

Returns

Array of Comment objects (or null if there are no comments associated to the node).

Return type

Array

Example

To get the array of comments associated to the connection c:

var comm_array = c.GetComments();

GetElements()

Description

Returns the beams/solids that are used in the connection weld.

Returns

An array containing the element IDs (or null if no elements).

Return type

Array

Example

To get the elements for connection c:

var elems = c.GetElements();

GetEntities(type[string])

Description

Returns list of the entities of type that are used in the connection.

Returns

An array containing the item IDs (or null if none).

Return type

Array

Example

To get list of nodes for connection c:

var items = c.GetEntities("NODE");

GetFlagged(Model[Model], flag[Flag], property (optional)[string]) [static]

Description

Returns an array of Conx objects for all of the flagged connections in a model in PRIMER If the optional property argument is not given then an array of Conx objects is returned. If the property argument is given, then that property value for each connection is returned in the array instead of a Conx object

Returns

Array of Conx objects or properties

Return type

Array

Example

To make an array of Conx objects for all of the connections in model m flagged with f:

var c = Conx.GetFlagged(m, f);

To return an array containing the value of property 'foo' (for example 'x' for a node) for all of the connections in model m flagged with f:

var a = Conx.GetFlagged(m, f, 'foo');

GetFromID(Model[Model], number[integer]) [static]

Description

Returns the Conx object for a connection ID.

Returns

Conx object (or null if connection does not exist).

Return type

Conx

Example

To get the Conx object for connection 100 in model m

var c = Conx.GetFromID(m, 100);

GetLayerData(layer[integer])

Description

Returns the data for a layer of the connection.

Returns

An array containing the layer data.

Return type

Array

Example

To get the data for the 3rd layer for connection c:

var l_data = c.GetLayerData(2);

GetLayerShells(layer[integer])

Description

Returns the attached shells for a layer of the connection.

Returns

Array of Shell objects or null if not valid

Return type

Array

Example

To get the attached shells for the 3rd layer for connection c:

var shells = c.GetLayerShells(2);

GetParameter(prop[string])

Description

Checks if a Conx property is a parameter or not. Note that object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. For this function to work the JavaScript interpreter must use the parameter name instead of the value. This can be done by setting the Options.property_parameter_names option to true before calling the function and then resetting it to false afterwards.. This behaviour can also temporarily be switched by using the Conx.ViewParameters() method and 'method chaining' (see the examples below).

Returns

Parameter object if property is a parameter, null if not.

Return type

Parameter

Example

To check if Conx property c.example is a parameter:

Options.property_parameter_names = true;
if (c.GetParameter(c.example) ) do_something...
Options.property_parameter_names = false;

To check if Conx property c.example is a parameter by using the GetParameter method:

if (c.ViewParameters().GetParameter(c.example) ) do_something...

GetPatchCoords(point[integer])

Description

Returns the data for a patch coordinate of an adhesive patch connection.

Returns

An array containing the patch coordinate.

Return type

Array

Example

To get the data for the 3rd patch coordinate for connection c:

var p_data = c.GetPatchCoords(2);

GetPatchTopol(point[integer])

Description

Returns the topology for a patch quad/tria of an adhesive patch connection.

Returns

Array of numbers containing the patch topology information.

Return type

Number

Example

To get the data for the 3rd patch quad/tria for connection c:

var p_data = c.GetPatchTopol(2);

GetPathData(point[integer])

Description

Returns the data for a path point of an adhesive/spotweld line connection.

Returns

An array containing the path data.

Return type

Array

Example

To get the data for the 3rd path point for connection c:

var p_data = c.GetPathData(2);

GetPidData()

Description

Returns an array of Part objects for the connection FE entities. A connection can contain elements with different part ID's between different layers. If one part ID is returned, that part is used for all elements in the connection. Not applicable for bolts.

Returns

Array of Part objects

Return type

Array

Example

To make an array of Part objects for connection c

var arr = c.GetPidData();

GetSettings()

Description

Returns an object of settings stored with the connection.

Returns

Example

To make an Oject containing the stored settings of connection c

var o = Conx.GetSettings();

GetShellThickness(Layer[integer])

Description

Returns an array containing a number of objects equal to the number of solid elements in the connection. Each object contains the corresponding solid element object, and shell element objects and their thicknesses. The argument allows the user to output only shells from all layers, or a particular layer. Note that a carriage return is not added.

Returns

Example

To get the data for connection c layer 1:

var sThkArr = c.GetShellThickness(1); // sThkArr is an array of objects containing shells and shell thicknesses in only layer 1 for each solid element in the connection.
var st0_1 = sThkArr[0].sthk1;         // st0_1 is the shell thickness of the shell attached to node 1 in the first solid element (array index 0) in the sThkArr array.
var sh1_4 = sThkArr[1].shell4;        // sth1_4 is the shell object corresponding to node 1 in the second solid element (array index 1) in the sThkArr array.
var so4   = sThkArr[4].solid;         // so4 is the fifth solid element object (array index 4) in the sThkArr array.

Keyword()

Description

Returns the keyword for this connection (*CONNECTION_START_SPOTWELD etc). Note that a carriage return is not added. See also Conx.KeywordCards()

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for connection c:

var key = c.Keyword();

KeywordCards()

Description

Returns the keyword cards for the connection. Note that a carriage return is not added. See also Conx.Keyword()

Returns

string containing the cards.

Return type

String

Example

To get the cards for connection c:

var cards = c.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last connection in the model.

Returns

Conx object (or null if there are no connections in the model).

Return type

Conx

Example

To get the last connection in model m:

var c = Conx.Last(m);

LastFreeLabel(Model[Model], layer (optional)[Include number]) [static]

Description

Returns the last free connection label in the model. Also see Conx.FirstFreeLabel(), Conx.NextFreeLabel() and see Model.LastFreeItemLabel()

Returns

Conx label.

Return type

Number

Example

To get the last free connection label in model m:

var label = Conx.LastFreeLabel(m);

Next()

Description

Returns the next connection in the model.

Returns

Conx object (or null if there are no more connections in the model).

Return type

Conx

Example

To get the connection in model m after connection c:

var c = c.Next();

NextFreeLabel(Model[Model], layer (optional)[Include number]) [static]

Description

Returns the next free (highest+1) connection label in the model. Also see Conx.FirstFreeLabel(), Conx.LastFreeLabel() and Model.NextFreeItemLabel()

Returns

Conx label.

Return type

Number

Example

To get the next free connection label in model m:

var label = Conx.NextFreeLabel(m);

Pick(prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean], button text (optional)[string]) [static]

Description

Allows the user to pick a connection.

Returns

Conx object (or null if not picked)

Return type

Conx

Example

To pick a connection from model m giving the prompt 'Pick connection from screen':

var c = Conx.Pick('Pick connection from screen', m);

Previous()

Description

Returns the previous connection in the model.

Returns

Conx object (or null if there are no more connections in the model).

Return type

Conx

Example

To get the connection in model m before connection c:

var c = c.Previous();

RealizeAll(Model[Model]) [static]

Description

Realizes all of the connections in the model.

Returns

No return value

Example

To realize all of the connections in model m:

Conx.RealizeAll(m);

RealizeFlagged(Model[Model], flag[Flag]) [static]

Description

Realizes all of the flagged connections in the model.

Returns

No return value

Example

To realize all of the connections in model m flagged with f:

Conx.RealizeFlagged(m, f);

ReloadConnectors() [static]

Description

Reload all modules from primer_library/connectors

Returns

No return value

Example

Conx.ReloadConnectors();

RemovePatchTopol(layer[integer])

Description

Deletes the topology at a particular location for patch type adhesive.

Returns

No return value.

Example

To remove the 3rd topology data for connection c:

c.RemovePatchTopol(2);

RemovePathData(layer[integer])

Description

Deletes a pathc point for a line adhesive connection.

Returns

No return value.

Example

To remove the 3rd point from connection c:

c.RemovePathData(2);

RenumberAll(Model[Model], start[integer]) [static]

Description

Renumbers all of the connections in the model.

Returns

No return value

Example

To renumber all of the connections in model m, from 1000000:

Conx.RenumberAll(m, 1000000);

RenumberFlagged(Model[Model], flag[Flag], start[integer]) [static]

Description

Renumbers all of the flagged connections in the model.

Returns

No return value

Example

To renumber all of the connections in model m flagged with f, from 1000000:

Conx.RenumberFlagged(m, f, 1000000);

Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean]) [static]

Description

Allows the user to select connections using standard PRIMER object menus.

Returns

Number of connections selected or null if menu cancelled

Return type

Number

Example

To select connections from model m, flagging those selected with flag f, giving the prompt 'Select connections':

Conx.Select(f, 'Select connections', m);

To select connections, flagging those selected with flag f but limiting selection to connections flagged with flag l, giving the prompt 'Select connections':

Conx.Select(f, 'Select connections', l);

SetFlag(flag[Flag])

Description

Sets a flag on the connection.

Returns

No return value

Example

To set flag f for connection c:

c.SetFlag(f);

SetLayerData(layer[integer], item1[integer/string], item2 (optional)[integer/string], ... (optional)[integer/string])

Description

Sets the data for a layer of the connection.

Returns

No return value.

Example

To set the data for the 3rd layer for connection c, to be part IDs 10 and 20:

c.SetLayerData(2, 10, 20);

or

var a = new Array(10, 20);
c.SetLayerData(2, a);

SetPatchCoords(point[integer], x[real], y[real], z[real])

Description

Sets a coordinate used by the adhesive patch connection type.

Returns

No return value.

Example

To set the position for the 3rd patch point for connection c, to be (10, 20, 30);

c.SetPatchCoords(2, 10, 20, 30);

SetPatchTopol(point[integer], c1[integer], c2[integer], c3[integer], c4 (optional)[integer])

Description

Sets the topology used by the adhesive patch connection type.

Returns

No return value.

Example

To set the topology for the 3rd patch quad/tria for connection c, to be (1, 4, 3, 6);

c.SetPatchTopol(2, 1, 4, 3, 6);

SetPathData(point[integer], x[real], y[real], z[real])

Description

Sets the data for a path point of the connection.

Returns

No return value.

Example

To set the position for the 3rd path point for connection c, to be (10, 20, 30);

c.SetPathData(2, 10, 20, 30);

SetPidData(item1[integer/string], item2 (optional)[integer/string], ... (optional)[integer/string])

Description

Sets the element part IDs for the connection. A different part can be defined for elements in the connection between different layers. Not applicable for bolts.

Returns

No return value.

Example

To set the part data for c, to be part IDs 10 and 20:

c.SetPidData(10, 20);

or

var a = new Array(10, 20);
c.SetPidData(a);

SetRuleDiameter(diameter[integer]) [static]

Description

Set the diameter for a spotweld ring when running a rule. Note that this method can only be called when running a connection rule script. It will not have any effect if used in a 'normal' script.

Returns

No return value

Example

To set the diameter for a ring to be 10.0:

Conx.SetRuleDiameter(10.0);

SetRuleFEPID(pid[integer]) [static]

Description

Set the PID for spotweld beam/solid elements or adhesive solids when running a rule. Note that this method can only be called when running a connection rule script. It will not have any effect if used in a 'normal' script.

Returns

No return value

Example

To set the PID for a spotweld to be 1000:

Conx.SetRuleFEPID(1000);

SetRulePID(pid[integer]) [static]

Description

Set the PID for a spotweld ring when running a rule. Note that this method can only be called when running a connection rule script. It will not have any effect if used in a 'normal' script.

Returns

No return value

Example

To set the PID for a ring to be 1000:

Conx.SetRulePID(1000);

SetSettings(data[object])

Description

Sets the settings stored on a connection entity. Not applicable for bolts.

Returns

No return value.

Example

To set the various settings for a connection c:

var data = { length_check:true, total_length:1.5, warpage_check:false, angle_tolerance:5.0 };
c.SetSettings(data);

Sketch(redraw (optional)[boolean])

Description

Sketches the connection. The connection will be sketched until you either call Conx.Unsketch(), Conx.UnsketchAll(), Model.UnsketchAll(), or delete the model

Returns

No return value

Example

To sketch connection c:

c.Sketch();

SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

Description

Sketches all of the flagged connections in the model. The connections will be sketched until you either call Conx.Unsketch(), Conx.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

Returns

No return value

Example

To sketch all connections flagged with flag in model m:

Conx.SketchFlagged(m, flag);

Total(Model[Model], exists (optional)[boolean]) [static]

Description

Returns the total number of connections in the model.

Returns

number of connections

Return type

Number

Example

To get the total number of connections in model m:

var total = Conx.Total(m);

Unblank()

Description

Unblanks the connection

Returns

No return value

Example

To unblank connection c:

c.Unblank();

UnblankAll(Model[Model], redraw (optional)[boolean]) [static]

Description

Unblanks all of the connections in the model.

Returns

No return value

Example

To unblank all of the connections in model m:

Conx.UnblankAll(m);

UnblankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

Description

Unblanks all of the flagged connections in the model.

Returns

No return value

Example

To unblank all of the connections in model m flagged with f:

Conx.UnblankFlagged(m, f);

UnflagAll(Model[Model], flag[Flag]) [static]

Description

Unsets a defined flag on all of the connections in the model.

Returns

No return value

Example

To unset the flag f on all the connections in model m:

Conx.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the connection.

Returns

No return value

Example

To unsketch connection c:

c.Unsketch();

UnsketchAll(Model[Model], redraw (optional)[boolean]) [static]

Description

Unsketches all connections.

Returns

No return value

Example

To unsketch all connections in model m:

Conx.UnsketchAll(m);

UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

Description

Unsketches all flagged connections in the model.

Returns

No return value

Example

To unsketch all connections flagged with flag in model m:

Conx.UnsketchAll(m, flag);

UseParentLayer(option[boolean]) [static]

Description

True (default) means put bolt FE into parent layer where possible.

Returns

No return value

Example

To switch off use of parent layer (and use current layer)

Conx.UseParentLayer(false);

UseSPR2Pref(option[boolean]) [static]

Description

True (default) means use the pref settings for C_SPR2 created when rivet realized.

Returns

No return value

Example

To ignore any pref settings and use zero for newly created C_SPR2 cards

Conx.UseSPR2Pref(false);

ViewParameters()

Description

Object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. This function temporarily changes the behaviour so that if a property is a parameter the parameter name is returned instead. This can be used with 'method chaining' (see the example below) to make sure a property argument is correct.

Returns

Conx object.

Return type

Conx

Example

To check if Conx property c.example is a parameter by using the Conx.GetParameter() method:

if (c.ViewParameters().GetParameter(c.example) ) do_something...

Warning(message[string], details (optional)[string])

Description

Adds a warning for connection. For more details on checking see the Check class.

Returns

No return value

Example

To add a warning message "My custom warning" for connection c:

c.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this connection.

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for connection c:

var xrefs = c.Xrefs();

toString()

Description

Creates a string containing the connection data in keyword format. Note that this contains the keyword header and the keyword cards. See also Conx.Keyword() and Conx.KeywordCards().

Returns

string

Return type

String

Example

To get data for connection n in keyword format

var s = c.toString();