Rigidwall class

The Rigidwall class gives you access to rigidwall 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:

Class functions

Member functions

Rigidwall constants

Name Description
Rigidwall.CYLINDER Rigidwall is *RIGIDWALL_GEOMETRIC_CYLINDER.
Rigidwall.FLAT Rigidwall is *RIGIDWALL_GEOMETRIC_FLAT.
Rigidwall.PLANAR Rigidwall is *RIGIDWALL_PLANAR.
Rigidwall.PRISM Rigidwall is *RIGIDWALL_GEOMETRIC_PRISM.
Rigidwall.SPHERE Rigidwall is *RIGIDWALL_GEOMETRIC_SPHERE.

Rigidwall properties

Name Type Description
birth real Birth time.
boxid integer Box for nodes.
d1 real X component of vector defn.
d2 real Y component of vector defn.
d3 real Z component of vector defn.
death real Death time.
decaya real Friction decay const in local A dir.
decayb real Friction decay const in local B dir.
dfrica real Dynamic friction coeff in local A dir.
dfricb real Dynamic friction coeff in local B dir.
display logical DISPLAY flag.
e real Young's modulus of rigidwall (for _DISPLAY option).
exists (read only) logical true if rigidwall exists, false if referred to but not defined.
finite logical Finite flag.
forces logical Forces flag.
fric real Friction coefficient.
heading string Rigidwall heading
id logical true if _ID option is set, false if not
include integer The Include file number that the rigidwall is in.
label integer Rigidwall number.
lcid integer Vel/disp vs time curve number.
lencyl real Length of cylinder.
lenl real Length of L edge.
lenm real Length of M edge.
lenp real Length of prism in -ve N.
mass real Mass of moving wall.
model (read only) integer The Model number that the rigidwall is in.
motion logical Motion flag.
moving logical Moving flag.
n1 integer 1st node for visualisation.
n2 integer 2nd node for visualisation.
n3 integer 3rd node for visualisation.
n4 integer 4th node for visualisation.
node1 integer Node 1 for vector defn.
node2 integer Node 2 for vector defn.
nsegs integer Number of subsections.
nsid integer Constrained node set included in wall.
nsidex integer Constrained node set exempted from wall.
offset real Offset for planar option.
opt integer Motion type.
ortho logical Ortho flag.
pid integer Part ID for display of geometric rigidwall (for _DISPLAY option).
pr real Poisson's ratio of rigidwall (for _DISPLAY option).
radcyl real Radius of cylinder.
radsph real Radius of sphere.
ro real Density of rigidwall (for _DISPLAY option).
rwid integer Rigidwall number (identical to label).
rwksf real Stiffness scaling factor.
sfrica real Static friction coeff in local A dir.
sfricb real Static friction coeff in local B dir.
soft integer No. of cycles to zero relative velocity.
ssid integer Segment set number.
type constant The rigidwall type. Can be Rigidwall.FLAT, Rigidwall.PRISM, Rigidwall.CYLINDER, Rigidwall.SPHERE, Rigidwall.PLANAR,
v0 real Initial velocity.
vx real X component of motion vector.
vy real Y component of motion vector.
vz real Z component of motion vector.
wvel real Velocity at which nodes weld to wall.
xh real Head X coord of outward normal.
xhev real Head X coord of edge I vector.
xt real Tail X coord of outward normal.
yh real Head Y coord of outward normal.
yhev real Head Y coord of edge I vector.
yt real Tail Y coord of outward normal.
zh real Head Z coord of outward normal.
zhev real Head Z coord of edge I vector.
zt real Tail Z coord of outward normal.

Detailed Description

The Rigidwall class allows you to create, modify, edit rigidwall cards. See the documentation below for more details.

Constructor

new Rigidwall(Model[Model], type[constant], nsid (optional)[integer], rwid (optional)[integer], heading (optional)[string])

Description

Create a new Rigidwall object.

Arguments

  • Model (Model)

    Model that Rigidwall will be created in

  • type (constant)

    Specify the type of rigidwall (Can be Rigidwall.FLAT, Rigidwall.PRISM, Rigidwall.CYLINDER, Rigidwall.SPHERE, Rigidwall.PLANAR)

  • nsid (optional) (integer)

    Node set number.

  • rwid (optional) (integer)

    Rigidwall number

  • heading (optional) (string)

    Title for the Rigidwall

    Returns

    Rigidwall object

    Return type

    Rigidwall

    Example

    To create a new rigidwall 200 of type GEOMETRIC_SPHERE in model m using node set 100 having the title "test wall" 

    var r = new Rigidwall(m, Rigidwall.SPHERE, 200, 100, "test wall");

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a rigidwall.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the rigidwall

    Returns

    No return value

    Example

    To associate comment c to the rigidwall r: 

    r.AssociateComment(c);

    Blank()

    Description

    Blanks the rigidwall

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank rigidwall r: 

    r.Blank();

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

    Description

    Blanks all of the rigidwalls in the model.

    Arguments

  • Model (Model)

    Model that all rigidwalls will be blanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To blank all of the rigidwalls in model m: 

    Rigidwall.BlankAll(m);

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

    Description

    Blanks all of the flagged rigidwalls in the model.

    Arguments

  • Model (Model)

    Model that all the flagged rigidwalls will be blanked in

  • flag (Flag)

    Flag set on the rigidwalls that you want to blank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

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

    Rigidwall.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the rigidwall is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if rigidwall r is blanked: 

    if (r.Blanked() ) do_something...

    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 rigidwall r: 

    r.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the rigidwall.

    Arguments

  • flag (Flag)

    Flag to clear on the rigidwall

    Returns

    No return value

    Example

    To clear flag f for rigidwall r: 

    r.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    Rigidwall object

    Return type

    Rigidwall

    Example

    To copy rigidwall r into rigidwall z: 

    var z = r.Copy();

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

    Description

    Starts an interactive editing panel to create a rigidwall

    Arguments

  • Model (Model)

    Model that the rigidwall 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

    Rigidwall object (or null if not made).

    Return type

    Rigidwall

    Example

    To start creating a rigidwall in model m: 

    var r = Rigidwall.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a rigidwall.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the rigidwall

    Returns

    No return value

    Example

    To detach comment c from the rigidwall r: 

    r.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 rigidwall r: 

    r.Edit();

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

    Description

    Adds an error for rigidwall. 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 rigidwall r: 

    r.Error("My custom error");

    FindNodesBehind(flag[Flag])

    Description

    Flags nodes that are behind a rigidwall

    Arguments

  • flag (Flag)

    Flag to be set on nodes behind rigidwall.

    Returns

    Number of nodes found

    Return type

    Number

    Example

    To set flag f on nodes behind rigidwall w: 

    w.FlagNodesBehind(f);

    First(Model[Model]) [static]

    Description

    Returns the first rigidwall in the model.

    Arguments

  • Model (Model)

    Model to get first rigidwall in

    Returns

    Rigidwall object (or null if there are no rigidwalls in the model).

    Return type

    Rigidwall

    Example

    To get the first rigidwall in model m: 

    var r = Rigidwall.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model to get first free rigidwall 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

    Rigidwall label.

    Return type

    Number

    Example

    To get the first free rigidwall label in model m: 

    var label = Rigidwall.FirstFreeLabel(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all rigidwalls will be flagged in

  • flag (Flag)

    Flag to set on the rigidwalls

    Returns

    No return value

    Example

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

    Rigidwall.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the rigidwall is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the rigidwall

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if rigidwall r has flag f set on it: 

    if (r.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all rigidwalls are in

  • func (function)

    Function to call for each rigidwall

  • 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 rigidwalls in model m: 

    Rigidwall.ForEach(m, test);
function test(r)
{
// r is Rigidwall object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get rigidwalls from

  • property (optional) (string)

    Name for property to get for all rigidwalls in the model

    Returns

    Array of Rigidwall objects or properties

    Return type

    Array

    Example

    To make an array of Rigidwall objects for all of the rigidwalls in model m: 

    var a = Rigidwall.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a rigidwall.

    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 rigidwall r: 

    var comm_array = r.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get rigidwalls from

  • flag (Flag)

    Flag set on the rigidwalls that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged rigidwalls in the model

    Returns

    Array of Rigidwall objects or properties

    Return type

    Array

    Example

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

    var r = Rigidwall.GetFlagged(m, f);

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

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

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

    Description

    Returns the Rigidwall object for a rigidwall ID.

    Arguments

  • Model (Model)

    Model to find the rigidwall in

  • number (integer)

    number of the rigidwall you want the Rigidwall object for

    Returns

    Rigidwall object (or null if rigidwall does not exist).

    Return type

    Rigidwall

    Example

    To get the Rigidwall object for rigidwall 100 in model m 

    var r = Rigidwall.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    rigidwall property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if Rigidwall property r.example is a parameter: 

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

    To check if Rigidwall property r.example is a parameter by using the GetParameter method: 

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

    GetRow(row[integer])

    Description

    Returns the data for an NSEGS card row in the rigidwall.

    Arguments

  • row (integer)

    The row you want the data for. Note row indices start at 0.

    Returns

    An array of numbers containing the row variables VL and HEIGHT.

    Return type

    Number

    Example

    To get the data for the 2nd row in rigidwall r: 

    var data = r.GetRow(1);
var vl = data[0];
var height = data[1];

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for Rigidwall pm: 

    var key = r.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for Rigidwall pm: 

    var cards = r.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last rigidwall in the model.

    Arguments

  • Model (Model)

    Model to get last rigidwall in

    Returns

    Rigidwall object (or null if there are no rigidwalls in the model).

    Return type

    Rigidwall

    Example

    To get the last rigidwall in model m: 

    var r = Rigidwall.Last(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model to get last free rigidwall 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

    Rigidwall label.

    Return type

    Number

    Example

    To get the last free rigidwall label in model m: 

    var label = Rigidwall.LastFreeLabel(m);

    Next()

    Description

    Returns the next rigidwall in the model.

    Arguments

    No arguments

    Returns

    Rigidwall object (or null if there are no more rigidwalls in the model).

    Return type

    Rigidwall

    Example

    To get the rigidwall in model m after rigidwall r: 

    var r = r.Next();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get next free rigidwall 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

    Rigidwall label.

    Return type

    Number

    Example

    To get the next free rigidwall label in model m: 

    var label = Rigidwall.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 rigidwall.

    Arguments

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

    If the argument is a Model then only rigidwalls from that model can be picked. If the argument is a Flag then only rigidwalls that are flagged with limit can be selected. If omitted, or null, any rigidwalls from any model can be selected. from any model.

  • modal (optional) (boolean)

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

  • button text (optional) (string)

    By default the window with the prompt will have a button labelled 'Cancel' which if pressed will cancel the pick and return null. If you want to change the text on the button use this argument. If omitted 'Cancel' will be used.

    Returns

    Rigidwall object (or null if not picked)

    Return type

    Rigidwall

    Example

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

    var r = Rigidwall.Pick('Pick rigidwall from screen', m);

    Previous()

    Description

    Returns the previous rigidwall in the model.

    Arguments

    No arguments

    Returns

    Rigidwall object (or null if there are no more rigidwalls in the model).

    Return type

    Rigidwall

    Example

    To get the rigidwall in model m before rigidwall r: 

    var r = r.Previous();

    RemoveRow(row[integer])

    Description

    Removes an NSEGS card row in the *RIGIDWALL.

    Arguments

  • row (integer)

    The row you want to remove the data for. Note that row indices start at 0.

    Returns

    No return value.

    Example

    To remove the second row of data for rigidwall r: 

    r.RemoveRow(1);

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

    Description

    Renumbers all of the rigidwalls in the model.

    Arguments

  • Model (Model)

    Model that all rigidwalls will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Rigidwall.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged rigidwalls in the model.

    Arguments

  • Model (Model)

    Model that all the flagged rigidwalls will be renumbered in

  • flag (Flag)

    Flag set on the rigidwalls that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Rigidwall.RenumberFlagged(m, f, 1000000);

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting rigidwalls

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    Rigidwall.Select(f, 'Select rigidwalls', m);

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

    Rigidwall.Select(f, 'Select rigidwalls', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the rigidwall.

    Arguments

  • flag (Flag)

    Flag to set on the rigidwall

    Returns

    No return value

    Example

    To set flag f for rigidwall r: 

    r.SetFlag(f);

    SetRow(row[integer], data[Array of data])

    Description

    Sets the data for an NSEGS card row in the *RIGIDWALL.

    Arguments

  • row (integer)

    The row you want to set the data for. Note that row indices start at 0.

  • data (Array of data)

    The data you want to set the row to

    Returns

    No return value.

    Example

    To set the second row of data for rigidwall r to be vl 10.0 and height 1.0: 

    var array = [10.0, 1.0];
r.SetRow(1, array);

    To append a new row of data (using the same array of values): 

    r.SetRow(r.nsegs, array);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch rigidwall r: 

    r.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged rigidwalls will be sketched in

  • flag (Flag)

    Flag set on the rigidwalls that you want to sketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the rigidwalls are sketched. If omitted redraw is true. If you want to sketch flagged rigidwalls 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 rigidwalls flagged with flag in model m: 

    Rigidwall.SketchFlagged(m, flag);

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

    Description

    Returns the total number of rigidwalls in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of rigidwalls

    Return type

    Number

    Example

    To get the total number of rigidwalls in model m: 

    var total = Rigidwall.Total(m);

    Unblank()

    Description

    Unblanks the rigidwall

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank rigidwall r: 

    r.Unblank();

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

    Description

    Unblanks all of the rigidwalls in the model.

    Arguments

  • Model (Model)

    Model that all rigidwalls will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To unblank all of the rigidwalls in model m: 

    Rigidwall.UnblankAll(m);

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

    Description

    Unblanks all of the flagged rigidwalls in the model.

    Arguments

  • Model (Model)

    Model that the flagged rigidwalls will be unblanked in

  • flag (Flag)

    Flag set on the rigidwalls that you want to unblank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

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

    Rigidwall.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

    Model that the defined flag for all rigidwalls will be unset in

  • flag (Flag)

    Flag to unset on the rigidwalls

    Returns

    No return value

    Example

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

    Rigidwall.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the rigidwall.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch rigidwall r: 

    r.Unsketch();

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

    Description

    Unsketches all rigidwalls.

    Arguments

  • Model (Model)

    Model that all rigidwalls will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not after the rigidwalls 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 rigidwalls in model m: 

    Rigidwall.UnsketchAll(m);

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

    Description

    Unsketches all flagged rigidwalls in the model.

    Arguments

  • Model (Model)

    Model that all rigidwalls will be unsketched in

  • flag (Flag)

    Flag set on the rigidwalls that you want to unsketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the rigidwalls 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 rigidwalls flagged with flag in model m: 

    Rigidwall.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

    Rigidwall object.

    Return type

    Rigidwall

    Example

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

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

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

    Description

    Adds a warning for rigidwall. 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 rigidwall r: 

    r.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this rigidwall.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for rigidwall r: 

    var xrefs = r.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for Rigidwall pm in keyword format 

    var r = r.toString();