IGAMass class

The IGAMass class gives you access to IGA mass cards 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])
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])
Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean])
SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean])
Total(Model[Model], exists (optional)[boolean])
UnflagAll(Model[Model], flag[Flag])
UnsketchAll(Model[Model], redraw (optional)[boolean])
UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean])

Member functions

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()
GetParameter(prop[string])
Keyword()
KeywordCards()
Next()
Previous()
SetFlag(flag[Flag])
Sketch(redraw (optional)[boolean])
Unsketch(redraw (optional)[boolean])
ViewParameters()
Warning(message[string], details (optional)[string])
Xrefs()
toString()

IGAMass constants

Name	Description
IGAMass.EDGE_UVW	EDGE is *IGA_MASS_EDGE_UVW.
IGAMass.FACE_XYZ	FACE is *IGA_MASS_FACE_XYZ.
IGAMass.POINT_UVW	POINT is *IGA_MASS_POINT_UVW.
IGAMass.SET_EDGE_UVW	S_EDGE is *IGA_MASS_SET_EDGE_UVW.
IGAMass.SET_FACE_XYZ	S_FACE is *IGA_MASS_SET_FACE_XYZ.
IGAMass.SET_POINT_UVW	S_POINT is *IGA_MASS_SET_POINT_UVW.

IGAMass properties

Name	Type	Description
dmass	real	Uniformly distributed mass added to IGA entity.
exists (read only)	logical	true if IGA Mass exists, false if referred to but not defined.
id	integer	ID of IGA entity depending on the choice of keyword option. Can be IGA_POINT_UVW, IGA_EDGE_UVW, IGA_FACE_XYZ, SET_IGA_POINT_UVW, SET_IGA_EDGE_UVW or SET_IGA_FACE_XYZ.
include	integer	The Include file number that the IGA Mass is in.
label (read only)	integer	IGAMass number. Only used in PRIMER.
model (read only)	integer	The Model number that the IGA Mass is in.
option	constant	IGA mass option. Can be IGAMass.POINT_UVW, IGAMass.EDGE_UVW, IGAMass.FACE_XYZ, IGAMass.SET_POINT_UVW, IGAMass.SET_EDGE_UVW or IGAMass.SET_FACE_XYZ.
tmass	real	Mass added to IGA entity.

Detailed Description

The IGAMass class allows you to create, modify, edit and manipulate IGA mass cards. See the documentation below for more details.

Constructor

new IGAMass(Model[Model], details[object])

Description

Create a new IGAMass object.

Arguments

Model (Model)

Model that IGA mass will be created in

details (object)

Details for creating the IGAMass

Object has the following properties:

Name	Type	Description
dmass (optional)	real	Uniformly distributed mass added to IGA entity.
id	integer	ID of IGA entity depending on the choice of keyword option. Can be IGA_POINT_UVW, IGA_EDGE_UVW, IGA_FACE_XYZ, SET_IGA_POINT_UVW, SET_IGA_EDGE_UVW or SET_IGA_FACE_XYZ.
option	constant	IGA Face XYZ option. Can be IGAMass.POINT_UVW, IGAMass.EDGE_UVW, IGAMass.FACE_XYZ, IGAMass.SET_POINT_UVW, IGAMass.SET_EDGE_UVW or IGAMass.SET_FACE_XYZ.
tmass (optional)	real	Mass added to IGA entity.

Returns

IGAMass object

Return type

IGAMass

Example

To create a new IGA mass in model m using option POINT with id 10:

var igma = new IGAMass(m, {option:IGAMass.POINT_UVW, id:10});

To create a new IGA mass in model m using option S_EDGE with id 21, tmass 22.5 and dmass 23.5:

var igma = new IGAMass(m, {option:IGAMass.SET_EDGE_UVW, id:21, tmass: 22.5, dmass:23.5});

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a IGA Mass.

Arguments

Comment (Comment)

Comment that will be attached to the IGA Mass

Returns

No return value

Example

To associate comment c to the IGA Mass igma:

igma.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 IGA Mass igma:

igma.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the IGA Mass.

Arguments

flag (Flag)

Flag to clear on the IGA Mass

Returns

No return value

Example

To clear flag f for IGA Mass igma:

igma.ClearFlag(f);

Copy(range (optional)[boolean])

Description

Copies the IGA Mass. The target include of the copied IGA Mass 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

IGAMass object

Return type

IGAMass

Example

To copy IGA Mass igma into IGA Mass z:

var z = igma.Copy();

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

Description

Starts an interactive editing panel to create a IGA Mass

Arguments

Model (Model)

Model that the IGA Mass 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

IGAMass object (or null if not made).

Return type

IGAMass

Example

To start creating a IGA Mass in model m:

var igma = IGAMass.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a IGA Mass.

Arguments

Comment (Comment)

Comment that will be detached from the IGA Mass

Returns

No return value

Example

To detach comment c from the IGA Mass igma:

igma.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 IGA Mass igma:

igma.Edit();

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

Description

Adds an error for IGA Mass. 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 IGA Mass igma:

igma.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first IGA Mass in the model.

Arguments

Model (Model)

Model to get first IGA Mass in

Returns

IGAMass object (or null if there are no IGA Masss in the model).

Return type

IGAMass

Example

To get the first IGA Mass in model m:

var igma = IGAMass.First(m);

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

Description

Flags all of the IGA Masss in the model with a defined flag.

Arguments

Model (Model)

Model that all IGA Masss will be flagged in

flag (Flag)

Flag to set on the IGA Masss

Returns

No return value

Example

To flag all of the IGA Masss with flag f in model m:

IGAMass.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the IGA Mass is flagged or not.

Arguments

flag (Flag)

Flag to test on the IGA Mass

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if IGA Mass igma has flag f set on it:

if (igma.Flagged(f) ) do_something...

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

Description

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

Arguments

Model (Model)

Model that all IGA Masss are in

func (function)

Function to call for each IGA Mass

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 IGA Masss in model m:

IGAMass.ForEach(m, test);
function test(igma)
{
// igma is IGAMass object
}

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

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

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

Description

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

Arguments

Model (Model)

Model to get IGA Masss from

property (optional) (string)

Name for property to get for all IGA Masss in the model

Returns

Array of IGAMass objects or properties

Return type

Array

Example

To make an array of IGAMass objects for all of the IGA Masss in model m:

var a = IGAMass.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a IGA Mass.

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 IGA Mass igma:

var comm_array = igma.GetComments();

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

Description

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

Arguments

Model (Model)

Model to get IGA Masss from

flag (Flag)

Flag set on the IGA Masss that you want to retrieve

property (optional) (string)

Name for property to get for all flagged IGA Masss in the model

Returns

Array of IGAMass objects or properties

Return type

Array

Example

To make an array of IGAMass objects for all of the IGA Masss in model m flagged with f:

var igma = IGAMass.GetFlagged(m, f);

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

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

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

Description

Returns the IGAMass object for a IGA Mass ID.

Arguments

Model (Model)

Model to find the IGA Mass in

number (integer)

number of the IGA Mass you want the IGAMass object for

Returns

IGAMass object (or null if IGA Mass does not exist).

Return type

IGAMass

Example

To get the IGAMass object for IGA Mass 100 in model m

var igma = IGAMass.GetFromID(m, 100);

GetParameter(prop[string])

Description

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

Arguments

prop (string)

IGA Mass property to get parameter for

Returns

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

Return type

Parameter

Example

To check if IGAMass property igma.example is a parameter:

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

To check if IGAMass property igma.example is a parameter by using the GetParameter method:

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

Keyword()

Description

Returns the keyword for this IGA mass (*IGA_MASS). Note that a carriage return is not added. See also IGAMass.KeywordCards()

Arguments

No arguments

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for IGA mass igma:

var key = igma.Keyword();

KeywordCards()

Description

Returns the keyword cards for the IGA mass. Note that a carriage return is not added. See also IGAMass.Keyword()

Arguments

No arguments

Returns

string containing the cards.

Return type

String

Example

To get the cards for IGA mass igma:

var cards = igma.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last IGA Mass in the model.

Arguments

Model (Model)

Model to get last IGA Mass in

Returns

IGAMass object (or null if there are no IGA Masss in the model).

Return type

IGAMass

Example

To get the last IGA Mass in model m:

var igma = IGAMass.Last(m);

Next()

Description

Returns the next IGA Mass in the model.

Arguments

No arguments

Returns

IGAMass object (or null if there are no more IGA Masss in the model).

Return type

IGAMass

Example

To get the IGA Mass in model m after IGA Mass igma:

var igma = igma.Next();

Previous()

Description

Returns the previous IGA Mass in the model.

Arguments

No arguments

Returns

IGAMass object (or null if there are no more IGA Masss in the model).

Return type

IGAMass

Example

To get the IGA Mass in model m before IGA Mass igma:

var igma = igma.Previous();

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

Description

Allows the user to select IGA Masss using standard PRIMER object menus.

Arguments

flag (Flag)

Flag to use when selecting IGA Masss

prompt (string)

Text to display as a prompt to the user

limit (optional) (Model or Flag)

If the argument is a Model then only IGA Masss from that model can be selected. If the argument is a Flag then only IGA Masss that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any IGA Masss 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 IGA Masss selected or null if menu cancelled

Return type

Number

Example

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

IGAMass.Select(f, 'Select IGA Masss', m);

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

IGAMass.Select(f, 'Select IGA Masss', l);

SetFlag(flag[Flag])

Description

Sets a flag on the IGA Mass.

Arguments

flag (Flag)

Flag to set on the IGA Mass

Returns

No return value

Example

To set flag f for IGA Mass igma:

igma.SetFlag(f);

Sketch(redraw (optional)[boolean])

Description

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

Arguments

redraw (optional) (boolean)

If model should be redrawn or not after the IGA Mass is sketched. If omitted redraw is true. If you want to sketch several IGA Masss and only redraw after the last one then use false for redraw and call View.Redraw().

Returns

No return value

Example

To sketch IGA Mass igma:

igma.Sketch();

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

Description

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

Arguments

Model (Model)

Model that all the flagged IGA Masss will be sketched in

flag (Flag)

Flag set on the IGA Masss that you want to sketch

redraw (optional) (boolean)

If model should be redrawn or not after the IGA Masss are sketched. If omitted redraw is true. If you want to sketch flagged IGA Masss several times and only redraw after the last one then use false for redraw and call View.Redraw().

Returns

No return value

Example

To sketch all IGA Masss flagged with flag in model m:

IGAMass.SketchFlagged(m, flag);

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

Description

Returns the total number of IGA Masss in the model.

Arguments

Model (Model)

Model to get total for

exists (optional) (boolean)

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

Returns

number of IGA Masss

Return type

Number

Example

To get the total number of IGA Masss in model m:

var total = IGAMass.Total(m);

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

Description

Unsets a defined flag on all of the IGA Masss in the model.

Arguments

Model (Model)

Model that the defined flag for all IGA Masss will be unset in

flag (Flag)

Flag to unset on the IGA Masss

Returns

No return value

Example

To unset the flag f on all the IGA Masss in model m:

IGAMass.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the IGA Mass.

Arguments

redraw (optional) (boolean)

If model should be redrawn or not after the IGA Mass is unsketched. If omitted redraw is true. If you want to unsketch several IGA Masss and only redraw after the last one then use false for redraw and call View.Redraw().

Returns

No return value

Example

To unsketch IGA Mass igma:

igma.Unsketch();

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

Description

Unsketches all IGA Masss.

Arguments

Model (Model)

Model that all IGA Masss will be unblanked in

redraw (optional) (boolean)

If model should be redrawn or not after the IGA Masss are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw().

Returns

No return value

Example

To unsketch all IGA Masss in model m:

IGAMass.UnsketchAll(m);

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

Description

Unsketches all flagged IGA Masss in the model.

Arguments

Model (Model)

Model that all IGA Masss will be unsketched in

flag (Flag)

Flag set on the IGA Masss that you want to unsketch

redraw (optional) (boolean)

Returns

No return value

Example

To unsketch all IGA Masss flagged with flag in model m:

IGAMass.UnsketchAll(m, flag);

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

IGAMass object.

Return type

IGAMass

Example

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

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

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

Description

Adds a warning for IGA Mass. 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 IGA Mass igma:

igma.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this IGA Mass.

Arguments

No arguments

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for IGA Mass igma:

var xrefs = igma.Xrefs();

toString()

Description

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

Arguments

No arguments

Returns

string

Return type

String

Example

To get data for IGA mass igma in keyword format

var s = igma.toString();