ConnectionProperties class

The ConnectionProperties class gives you access to *DEFINE_CONNECTION_PROPERTIES keyword in PRIMER. More...

The PRIMER JavaScript API provides many class constants, properties and methods. For Arup to be able to extend and enhance the API in the future any constant, property or method names beginning with a lowercase or uppercase letter are reserved.
If you need to add your own properties or methods to one of the existing classes then to avoid any potential future conflict you should ensure that the name begins with either an underscore (_) or a dollar sign ($) or the name is prefixed with your own unique identifier.
For example if company 'ABC' need to add a property called 'example' then to avoid any potential future conflict use one of:

_example
$example
ABC_example

Class functions

Create(Model[Model], modal (optional)[boolean])
First(Model[Model])
FirstFreeLabel(Model[Model], layer (optional)[Include number])
FlagAll(Model[Model], flag[Flag])
ForEach(Model[Model], func[function], extra (optional)[any])
GetAll(Model[Model], property (optional)[string])
GetFlagged(Model[Model], flag[Flag], property (optional)[string])
GetFromID(Model[Model], number[integer])
Last(Model[Model])
LastFreeLabel(Model[Model], layer (optional)[Include number])
NextFreeLabel(Model[Model], layer (optional)[Include number])
RenumberAll(Model[Model], start[integer])
RenumberFlagged(Model[Model], flag[Flag], start[integer])
Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean])
Total(Model[Model], exists (optional)[boolean])
UnflagAll(Model[Model], flag[Flag])

Member functions

AddMaterialDataLine()
AssociateComment(Comment[Comment])
Browse(modal (optional)[boolean])
ClearFlag(flag[Flag])
Copy(range (optional)[boolean])
DetachComment(Comment[Comment])
Edit(modal (optional)[boolean])
Error(message[string], details (optional)[string])
Flagged(flag[Flag])
GetComments()
GetMaterialDataLine(row[integer])
GetParameter(prop[string])
Keyword()
KeywordCards()
Next()
Previous()
RemoveMaterialDataLine(row[integer])
SetFlag(flag[Flag])
SetMaterialDataLine(row[integer], mid[integer], sigy (optional)[real], etan (optional)[real], dg_pr (optional)[real], rank (optional)[real], sn (optional)[real], sb (optional)[real], ss (optional)[real], exsn (optional)[real], exsb (optional)[real], exss (optional)[real], lcsn (optional)[integer], lcsb (optional)[integer], lcss (optional)[integer], gfad (optional)[real], sclmrr (optional)[real])
ViewParameters()
Warning(message[string], details (optional)[string])
Xrefs()
toString()

ConnectionProperties properties

Name	Type	Description
add	integer	To _ADD case's parent definition
areaeq	integer	Area equation number.
con_id	integer	*DEFINE_CONNECTION_PROPERTIES id.
d_dg_pr	real	Default damage parameter.
d_dg_prf	integer	Default damage parameter(function if proprul == 2).
d_etan	real	Default tangent modulus.
d_etanf	integer	Default tangent modulus(function if proprul == 2).
d_exsb	real	Default bending stress exponent.
d_exsbf	integer	Default bending stress exponent(function if proprul == 2).
d_exsn	real	Default normal stress exponent.
d_exsnf	integer	Default normal stress exponent(function if proprul == 2).
d_exss	real	Default shear stress exponent.
d_exssf	integer	Default shear stress exponent(function if proprul == 2).
d_gfad	real	Default fading energy.
d_gfadf	integer	Default fading energy(function if proprul == 2).
d_lcsb	integer	Default LC of bending stress scale factor wrt strain rate.
d_lcsn	integer	Default LC of normal stress scale factor wrt strain rate.
d_lcss	integer	Default LC of shear stress scale factor wrt strain rate.
d_rank	real	Default rank value.
d_sb	real	Default bending strength.
d_sbf	integer	Default bending strength(function if proprul == 2).
d_sclmrr	real	Default scaling factor for torsional moment in failure function.
d_sigy	real	Default yield stress.
d_sigyf	integer	Default yield stress(function if proprul == 2).
d_sn	real	Default normal strength.
d_snf	integer	Default normal strength(function if proprul == 2).
d_ss	real	Default shear strength.
d_ssf	integer	Default shear strength(function if proprul == 2).
dg_typ	integer	Damage type.
exists (read only)	logical	true if *DEFINE_CONNECTION_PROPERTIES exists, false if referred to but not defined.
heading	string	The title of the *DEFINE_CONNECTION_PROPERTIES or the empty string if _TITLE is not set
include	integer	The Include file number that the *DEFINE_CONNECTION_PROPERTIES is in.
moarfl	integer	Modelled area flag.
model (read only)	integer	The Model number that the *DEFINE_CONNECTION_PROPERTIES is in.
proprul	integer	Property rule number.

Detailed Description

The ConnectionProperties class allows you to create, modify, edit and manipulate *DEFINE_CONNECTION_PROPERTIES. See the documentation below for more details.

Constructor

new ConnectionProperties(Model[Model], con_id[integer], heading (optional)[string])

Description

Create a new *DEFINE_CONNECTION_PROPERTIES object.

Arguments

Model (Model)

Model that *DEFINE_CONNECTION_PROPERTIES will be created in

con_id (integer)

*DEFINE_CONNECTION_PROPERTIES id.

heading (optional) (string)

Title for the *DEFINE_CONNECTION_PROPERTIES

Returns

ConnectionProperties object

Return type

ConnectionProperties

Example

To create a new *DEFINE_CONNECTION_PROPERTIES in model m with label 100:

var c = new ConnectionProperties(m, 100);

Details of functions

AddMaterialDataLine()

Description

Allows user to add material data line in *DEFINE_CONNECTION_PROPERTIES.

Arguments

No arguments

Returns

No return value

Example

To Add Material data line in *DEFINE_CONNECTION_PROPERTIES c:

c.AddMaterialDataLine();

AssociateComment(Comment[Comment])

Description

Associates a comment with a *DEFINE_CONNECTION_PROPERTIES.

Arguments

Comment (Comment)

Comment that will be attached to the *DEFINE_CONNECTION_PROPERTIES

Returns

No return value

Example

To associate comment c to the *DEFINE_CONNECTION_PROPERTIES c:

c.AssociateComment(c);

Browse(modal (optional)[boolean])

Description

Starts an edit panel in Browse mode.

Arguments

modal (optional) (boolean)

If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

Returns

no return value

Example

To Browse *DEFINE_CONNECTION_PROPERTIES c:

c.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the *DEFINE_CONNECTION_PROPERTIES.

Arguments

flag (Flag)

Flag to clear on the *DEFINE_CONNECTION_PROPERTIES

Returns

No return value

Example

To clear flag f for *DEFINE_CONNECTION_PROPERTIES c:

c.ClearFlag(f);

Copy(range (optional)[boolean])

Description

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

Arguments

range (optional) (boolean)

If you want to keep the copied item in the range specified for the current include. Default value is false. To set current include, use Include.MakeCurrentLayer().

Returns

ConnectionProperties object

Return type

ConnectionProperties

Example

To copy *DEFINE_CONNECTION_PROPERTIES c into *DEFINE_CONNECTION_PROPERTIES z:

var z = c.Copy();

Create(Model[Model], modal (optional)[boolean]) [static]

Description

Starts an interactive editing panel to create a *DEFINE_CONNECTION_PROPERTIES

Arguments

Model (Model)

Model that the *DEFINE_CONNECTION_PROPERTIES will be created in.

modal (optional) (boolean)

If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

Returns

ConnectionProperties object (or null if not made).

Return type

ConnectionProperties

Example

To start creating a *DEFINE_CONNECTION_PROPERTIES in model m:

var c = ConnectionProperties.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a *DEFINE_CONNECTION_PROPERTIES.

Arguments

Comment (Comment)

Comment that will be detached from the *DEFINE_CONNECTION_PROPERTIES

Returns

No return value

Example

To detach comment c from the *DEFINE_CONNECTION_PROPERTIES c:

c.DetachComment(c);

Edit(modal (optional)[boolean])

Description

Starts an interactive editing panel.

Arguments

modal (optional) (boolean)

If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

Returns

no return value

Example

To Edit *DEFINE_CONNECTION_PROPERTIES c:

c.Edit();

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

Description

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

Arguments

message (string)

The error message to give

details (optional) (string)

An optional detailed error message

Returns

No return value

Example

To add an error message "My custom error" for *DEFINE_CONNECTION_PROPERTIES c:

c.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first *DEFINE_CONNECTION_PROPERTIES in the model.

Arguments

Model (Model)

Model to get first *DEFINE_CONNECTION_PROPERTIES in

Returns

ConnectionProperties object (or null if there are no *DEFINE_CONNECTION_PROPERTIESs in the model).

Return type

ConnectionProperties

Example

To get the first *DEFINE_CONNECTION_PROPERTIES in model m:

var c = ConnectionProperties.First(m);

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

Description

Returns the first free *DEFINE_CONNECTION_PROPERTIES label in the model. Also see ConnectionProperties.LastFreeLabel(), ConnectionProperties.NextFreeLabel() and Model.FirstFreeItemLabel().

Arguments

Model (Model)

Model to get first free *DEFINE_CONNECTION_PROPERTIES label in

layer (optional) (Include number)

Include file (0 for the main file) to search for labels in (Equivalent to First free in layer in editing panels). If omitted the whole model will be used (Equivalent to First free in editing panels).

Returns

ConnectionProperties label.

Return type

Number

Example

To get the first free *DEFINE_CONNECTION_PROPERTIES label in model m:

var label = ConnectionProperties.FirstFreeLabel(m);

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

Description

Flags all of the *DEFINE_CONNECTION_PROPERTIESs in the model with a defined flag.

Arguments

Model (Model)

Model that all *DEFINE_CONNECTION_PROPERTIESs will be flagged in

flag (Flag)

Flag to set on the *DEFINE_CONNECTION_PROPERTIESs

Returns

No return value

Example

To flag all of the *DEFINE_CONNECTION_PROPERTIESs with flag f in model m:

ConnectionProperties.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the *DEFINE_CONNECTION_PROPERTIES is flagged or not.

Arguments

flag (Flag)

Flag to test on the *DEFINE_CONNECTION_PROPERTIES

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if *DEFINE_CONNECTION_PROPERTIES 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 *DEFINE_CONNECTION_PROPERTIES in the model.
Note that ForEach has been designed to make looping over *DEFINE_CONNECTION_PROPERTIESs as fast as possible and so has some limitations.
Firstly, a single temporary ConnectionProperties object is created and on each function call it is updated with the current *DEFINE_CONNECTION_PROPERTIES data. This means that you should not try to store the ConnectionProperties object for later use (e.g. in an array) as it is temporary.
Secondly, you cannot create new *DEFINE_CONNECTION_PROPERTIESs inside a ForEach loop.

Arguments

Model (Model)

Model that all *DEFINE_CONNECTION_PROPERTIESs are in

func (function)

Function to call for each *DEFINE_CONNECTION_PROPERTIES

extra (optional) (any)

An optional extra object/array/string etc that will appended to arguments when calling the function

Returns

No return value

Example

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

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

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

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

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

Description

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

Arguments

Model (Model)

Model to get *DEFINE_CONNECTION_PROPERTIESs from

property (optional) (string)

Name for property to get for all *DEFINE_CONNECTION_PROPERTIESs in the model

Returns

Array of ConnectionProperties objects or properties

Return type

Array

Example

To make an array of ConnectionProperties objects for all of the *DEFINE_CONNECTION_PROPERTIESs in model m:

var a = ConnectionProperties.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a *DEFINE_CONNECTION_PROPERTIES.

Arguments

No arguments

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 *DEFINE_CONNECTION_PROPERTIES c:

var comm_array = c.GetComments();

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

Description

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

Arguments

Model (Model)

Model to get *DEFINE_CONNECTION_PROPERTIESs from

flag (Flag)

Flag set on the *DEFINE_CONNECTION_PROPERTIESs that you want to retrieve

property (optional) (string)

Name for property to get for all flagged *DEFINE_CONNECTION_PROPERTIESs in the model

Returns

Array of ConnectionProperties objects or properties

Return type

Array

Example

To make an array of ConnectionProperties objects for all of the *DEFINE_CONNECTION_PROPERTIESs in model m flagged with f:

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

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

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

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

Description

Returns the ConnectionProperties object for a *DEFINE_CONNECTION_PROPERTIES ID.

Arguments

Model (Model)

Model to find the *DEFINE_CONNECTION_PROPERTIES in

number (integer)

number of the *DEFINE_CONNECTION_PROPERTIES you want the ConnectionProperties object for

Returns

ConnectionProperties object (or null if *DEFINE_CONNECTION_PROPERTIES does not exist).

Return type

ConnectionProperties

Example

To get the ConnectionProperties object for *DEFINE_CONNECTION_PROPERTIES 100 in model m

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

GetMaterialDataLine(row[integer])

Description

Returns the material data at given row in *DEFINE_CONNECTION_PROPERTIES.

Arguments

row (integer)

Material data row number, eg. for first material data, row = 0

Returns

Array of numbers containing the material id, sigy, e_tan etc. .

Return type

Number

Example

To get material data at first row, row = 0 in *DEFINE_CONNECTION_PROPERTIES c:

c.GetMaterialData(0);

GetParameter(prop[string])

Description

Checks if a ConnectionProperties 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 ConnectionProperties.ViewParameters() method and 'method chaining' (see the examples below).

Arguments

prop (string)

*DEFINE_CONNECTION_PROPERTIES property to get parameter for

Returns

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

Return type

Parameter

Example

To check if ConnectionProperties 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 ConnectionProperties property c.example is a parameter by using the GetParameter method:

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

Keyword()

Description

Returns the keyword for this *DEFINE_CONNECTION_PROPERTIES Note that a carriage return is not added. See also ConnectionProperties.KeywordCards()

Arguments

No arguments

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for ConnectionProperties c:

var key = c.Keyword();

KeywordCards()

Description

Returns the keyword cards for the *DEFINE_CONNECTION_PROPERTIES. Note that a carriage return is not added. See also ConnectionProperties.Keyword()

Arguments

No arguments

Returns

string containing the cards.

Return type

String

Example

To get the cards for connection_properties c:

var cards = c.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last *DEFINE_CONNECTION_PROPERTIES in the model.

Arguments

Model (Model)

Model to get last *DEFINE_CONNECTION_PROPERTIES in

Returns

ConnectionProperties object (or null if there are no *DEFINE_CONNECTION_PROPERTIESs in the model).

Return type

ConnectionProperties

Example

To get the last *DEFINE_CONNECTION_PROPERTIES in model m:

var c = ConnectionProperties.Last(m);

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

Description

Returns the last free *DEFINE_CONNECTION_PROPERTIES label in the model. Also see ConnectionProperties.FirstFreeLabel(), ConnectionProperties.NextFreeLabel() and see Model.LastFreeItemLabel()

Arguments

Model (Model)

Model to get last free *DEFINE_CONNECTION_PROPERTIES label in

layer (optional) (Include number)

Include file (0 for the main file) to search for labels in (Equivalent to Highest free in layer in editing panels). If omitted the whole model will be used.

Returns

ConnectionProperties label.

Return type

Number

Example

To get the last free *DEFINE_CONNECTION_PROPERTIES label in model m:

var label = ConnectionProperties.LastFreeLabel(m);

Next()

Description

Returns the next *DEFINE_CONNECTION_PROPERTIES in the model.

Arguments

No arguments

Returns

ConnectionProperties object (or null if there are no more *DEFINE_CONNECTION_PROPERTIESs in the model).

Return type

ConnectionProperties

Example

To get the *DEFINE_CONNECTION_PROPERTIES in model m after *DEFINE_CONNECTION_PROPERTIES c:

var c = c.Next();

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

Description

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

Arguments

Model (Model)

Model to get next free *DEFINE_CONNECTION_PROPERTIES label in

layer (optional) (Include number)

Include file (0 for the main file) to search for labels in (Equivalent to Highest+1 in layer in editing panels). If omitted the whole model will be used (Equivalent to Highest+1 in editing panels).

Returns

ConnectionProperties label.

Return type

Number

Example

To get the next free *DEFINE_CONNECTION_PROPERTIES label in model m:

var label = ConnectionProperties.NextFreeLabel(m);

Previous()

Description

Returns the previous *DEFINE_CONNECTION_PROPERTIES in the model.

Arguments

No arguments

Returns

ConnectionProperties object (or null if there are no more *DEFINE_CONNECTION_PROPERTIESs in the model).

Return type

ConnectionProperties

Example

To get the *DEFINE_CONNECTION_PROPERTIES in model m before *DEFINE_CONNECTION_PROPERTIES c:

var c = c.Previous();

RemoveMaterialDataLine(row[integer])

Description

Allows user to remove material data line in *DEFINE_CONNECTION_PROPERTIES.

Arguments

row (integer)

Material data row number, eg. for first material data, row = 0

Returns

No return value

Example

To remove first material data line in *DEFINE_CONNECTION_PROPERTIES c:

c.RemoveMaterialDataLine(0);

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

Description

Renumbers all of the *DEFINE_CONNECTION_PROPERTIESs in the model.

Arguments

Model (Model)

Model that all *DEFINE_CONNECTION_PROPERTIESs will be renumbered in

start (integer)

Start point for renumbering

Returns

No return value

Example

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

ConnectionProperties.RenumberAll(m, 1000000);

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

Description

Renumbers all of the flagged *DEFINE_CONNECTION_PROPERTIESs in the model.

Arguments

Model (Model)

Model that all the flagged *DEFINE_CONNECTION_PROPERTIESs will be renumbered in

flag (Flag)

Flag set on the *DEFINE_CONNECTION_PROPERTIESs that you want to renumber

start (integer)

Start point for renumbering

Returns

No return value

Example

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

ConnectionProperties.RenumberFlagged(m, f, 1000000);

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

Description

Allows the user to select *DEFINE_CONNECTION_PROPERTIESs using standard PRIMER object menus.

Arguments

flag (Flag)

Flag to use when selecting *DEFINE_CONNECTION_PROPERTIESs

prompt (string)

Text to display as a prompt to the user

limit (optional) (Model or Flag)

If the argument is a Model then only *DEFINE_CONNECTION_PROPERTIESs from that model can be selected. If the argument is a Flag then only *DEFINE_CONNECTION_PROPERTIESs that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any *DEFINE_CONNECTION_PROPERTIESs can be selected. from any model.

modal (optional) (boolean)

If selection is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the selection will be modal.

Returns

Number of *DEFINE_CONNECTION_PROPERTIESs selected or null if menu cancelled

Return type

Number

Example

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

ConnectionProperties.Select(f, 'Select *DEFINE_CONNECTION_PROPERTIESs', m);

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

ConnectionProperties.Select(f, 'Select *DEFINE_CONNECTION_PROPERTIESs', l);

SetFlag(flag[Flag])

Description

Sets a flag on the *DEFINE_CONNECTION_PROPERTIES.

Arguments

flag (Flag)

Flag to set on the *DEFINE_CONNECTION_PROPERTIES

Returns

No return value

Example

To set flag f for *DEFINE_CONNECTION_PROPERTIES c:

c.SetFlag(f);

SetMaterialDataLine(row[integer], mid[integer], sigy (optional)[real], etan (optional)[real], dg_pr (optional)[real], rank (optional)[real], sn (optional)[real], sb (optional)[real], ss (optional)[real], exsn (optional)[real], exsb (optional)[real], exss (optional)[real], lcsn (optional)[integer], lcsb (optional)[integer], lcss (optional)[integer], gfad (optional)[real], sclmrr (optional)[real])

Description

Allows user to set fields for material data line at given row in *DEFINE_CONNECTION_PROPERTIES.

Arguments

row (integer)

Material data row number, eg. for first material data, row = 0

mid (integer)

Material ID

sigy (optional) (real)

Default yield stress

etan (optional) (real)

Default tangent modulus

dg_pr (optional) (real)

Default damage parameter

rank (optional) (real)

Default rank value

sn (optional) (real)

Default normal strength

sb (optional) (real)

Default bending strength

ss (optional) (real)

Default shear strength

exsn (optional) (real)

Default normal stress exponent

exsb (optional) (real)

Default bending stress exponent

exss (optional) (real)

Default shear stress exponent

lcsn (optional) (integer)

Default LC of normal stress scale factor wrt strain rate

lcsb (optional) (integer)

Default LC of bending stress scale factor wrt strain rate

lcss (optional) (integer)

Default LC of shear stress scale factor wrt strain rate

gfad (optional) (real)

Default fading energy

sclmrr (optional) (real)

Default scaling factor for torsional moment in failure function

Returns

No return value

Example

To set material data at first row ( row = 0) to mat 111 in *DEFINE_CONNECTION_PROPERTIES c:

c.SetMaterialData(0,111);

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

Description

Returns the total number of *DEFINE_CONNECTION_PROPERTIESs in the model.

Arguments

Model (Model)

Model to get total for

exists (optional) (boolean)

true if only existing *DEFINE_CONNECTION_PROPERTIESs should be counted. If false or omitted referenced but undefined *DEFINE_CONNECTION_PROPERTIESs will also be included in the total.

Returns

number of *DEFINE_CONNECTION_PROPERTIESs

Return type

Number

Example

To get the total number of *DEFINE_CONNECTION_PROPERTIESs in model m:

var total = ConnectionProperties.Total(m);

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

Description

Unsets a defined flag on all of the *DEFINE_CONNECTION_PROPERTIESs in the model.

Arguments

Model (Model)

Model that the defined flag for all *DEFINE_CONNECTION_PROPERTIESs will be unset in

flag (Flag)

Flag to unset on the *DEFINE_CONNECTION_PROPERTIESs

Returns

No return value

Example

To unset the flag f on all the *DEFINE_CONNECTION_PROPERTIESs in model m:

ConnectionProperties.UnflagAll(m, f);

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.

Arguments

No arguments

Returns

ConnectionProperties object.

Return type

ConnectionProperties

Example

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

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

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

Description

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

Arguments

message (string)

The warning message to give

details (optional) (string)

An optional detailed warning message

Returns

No return value

Example

To add a warning message "My custom warning" for *DEFINE_CONNECTION_PROPERTIES c:

c.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this *DEFINE_CONNECTION_PROPERTIES.

Arguments

No arguments

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for *DEFINE_CONNECTION_PROPERTIES c:

var xrefs = c.Xrefs();

toString()

Description

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

Arguments

No arguments

Returns

string

Return type

String

Example

To get data for connection_properties c in keyword format

var str = c.toString();