PrescribedFinalGeometry class

The PrescribedFinalGeometry class gives you access to define boundary prescribed final_geometry 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

PrescribedFinalGeometry properties

Name Type Description
bpfgid integer PrescribedFinalGeometry number. Also see the label property which is an alternative name for this.
deathd real Default death time.
exists (read only) logical true if boundary prescribed final geometry exists, false if referred to but not defined.
id integer PrescribedFinalGeometry number. Also see the label property which is an alternative name for this.
include integer The Include file number that the boundary prescribed final geometry is in.
label integer PrescribedFinalGeometry number. Also see the bpfgid property which is an alternative name for this.
lcidf integer Default loadcurve number.
lines (read only) integer Number of lines of nodal data on the card.
model (read only) integer The Model number that the boundary prescribed final geometry is in.

Detailed Description

The PrescribedFinalGeometry class allows you to create, modify, edit and boundary prescribed final_geometry cards. See the documentation below for more details.

Constructor

new PrescribedFinalGeometry(Model[Model], bpfgid[PrescribedFinalGeometry])

Description

Create a new PrescribedFinalGeometry object.

Arguments

  • Model (Model)

    Model that PrescribedFinalGeometry will be created in

  • bpfgid (PrescribedFinalGeometry)

    PrescribedFinalGeometry number.

    Returns

    PrescribedFinalGeometry object

    Return type

    PrescribedFinalGeometry

    Example

    To create a new final geometry 99 in model m 

    var b = new PrescribedFinalGeometry(m, 99);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a boundary prescribed final geometry.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the boundary prescribed final geometry

    Returns

    No return value

    Example

    To associate comment c to the boundary prescribed final geometry b: 

    b.AssociateComment(c);

    Blank()

    Description

    Blanks the boundary prescribed final geometry

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank boundary prescribed final geometry b: 

    b.Blank();

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

    Description

    Blanks all of the boundary prescribed final geometrys in the model.

    Arguments

  • Model (Model)

    Model that all boundary prescribed final geometrys 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 boundary prescribed final geometrys in model m: 

    PrescribedFinalGeometry.BlankAll(m);

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

    Description

    Blanks all of the flagged boundary prescribed final geometrys in the model.

    Arguments

  • Model (Model)

    Model that all the flagged boundary prescribed final geometrys will be blanked in

  • flag (Flag)

    Flag set on the boundary prescribed final geometrys 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 boundary prescribed final geometrys in model m flagged with f: 

    PrescribedFinalGeometry.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the boundary prescribed final geometry is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if boundary prescribed final geometry b is blanked: 

    if (b.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 boundary prescribed final geometry b: 

    b.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the boundary prescribed final geometry.

    Arguments

  • flag (Flag)

    Flag to clear on the boundary prescribed final geometry

    Returns

    No return value

    Example

    To clear flag f for boundary prescribed final geometry b: 

    b.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

    Copies the boundary prescribed final geometry. The target include of the copied boundary prescribed final geometry 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

    PrescribedFinalGeometry object

    Return type

    PrescribedFinalGeometry

    Example

    To copy boundary prescribed final geometry b into boundary prescribed final geometry z: 

    var z = b.Copy();

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

    Description

    Starts an interactive editing panel to create a boundary prescribed final geometry

    Arguments

  • Model (Model)

    Model that the boundary prescribed final geometry 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

    PrescribedFinalGeometry object (or null if not made).

    Return type

    PrescribedFinalGeometry

    Example

    To start creating a boundary prescribed final geometry in model m: 

    var b = PrescribedFinalGeometry.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a boundary prescribed final geometry.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the boundary prescribed final geometry

    Returns

    No return value

    Example

    To detach comment c from the boundary prescribed final geometry b: 

    b.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 boundary prescribed final geometry b: 

    b.Edit();

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

    Description

    Adds an error for boundary prescribed final geometry. 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 boundary prescribed final geometry b: 

    b.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first boundary prescribed final geometry in the model.

    Arguments

  • Model (Model)

    Model to get first boundary prescribed final geometry in

    Returns

    PrescribedFinalGeometry object (or null if there are no boundary prescribed final geometrys in the model).

    Return type

    PrescribedFinalGeometry

    Example

    To get the first boundary prescribed final geometry in model m: 

    var b = PrescribedFinalGeometry.First(m);

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

    Description

    Returns the first free boundary prescribed final geometry label in the model. Also see PrescribedFinalGeometry.LastFreeLabel(), PrescribedFinalGeometry.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

    Model to get first free boundary prescribed final geometry 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

    PrescribedFinalGeometry label.

    Return type

    Number

    Example

    To get the first free boundary prescribed final geometry label in model m: 

    var label = PrescribedFinalGeometry.FirstFreeLabel(m);

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

    Description

    Flags all of the boundary prescribed final geometrys in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all boundary prescribed final geometrys will be flagged in

  • flag (Flag)

    Flag to set on the boundary prescribed final geometrys

    Returns

    No return value

    Example

    To flag all of the boundary prescribed final geometrys with flag f in model m: 

    PrescribedFinalGeometry.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the boundary prescribed final geometry is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the boundary prescribed final geometry

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if boundary prescribed final geometry b has flag f set on it: 

    if (b.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all boundary prescribed final geometrys are in

  • func (function)

    Function to call for each boundary prescribed final geometry

  • 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 boundary prescribed final geometrys in model m: 

    PrescribedFinalGeometry.ForEach(m, test);
function test(b)
{
// b is PrescribedFinalGeometry object
}

    To call function test for all of the boundary prescribed final geometrys in model m with optional object: 

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

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

    Description

    Returns an array of PrescribedFinalGeometry objects or properties for all of the boundary prescribed final geometrys in a model in PRIMER. If the optional property argument is not given then an array of PrescribedFinalGeometry objects is returned. If the property argument is given, that property value for each boundary prescribed final geometry is returned in the array instead of a PrescribedFinalGeometry object

    Arguments

  • Model (Model)

    Model to get boundary prescribed final geometrys from

  • property (optional) (string)

    Name for property to get for all boundary prescribed final geometrys in the model

    Returns

    Array of PrescribedFinalGeometry objects or properties

    Return type

    Array

    Example

    To make an array of PrescribedFinalGeometry objects for all of the boundary prescribed final geometrys in model m: 

    var a = PrescribedFinalGeometry.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a boundary prescribed final geometry.

    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 boundary prescribed final geometry b: 

    var comm_array = b.GetComments();

    GetData(index[integer])

    Description

    Returns data for open-ended cards for a given row number in *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY.

    Arguments

  • index (integer)

    Index of open-ended card you want the data for. Note that indices start at 0, not 1.
    0 <= index < lines

    Returns

    An array containing data (NID, X, Y, Z, LCID, DEATH).

    Return type

    Array

    Example

    To get the data for the 3rd open-ended row for boundary prescribed final geometry b: 

    var data = b.GetData(2);

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

    Description

    Returns an array of PrescribedFinalGeometry objects for all of the flagged boundary prescribed final geometrys in a model in PRIMER If the optional property argument is not given then an array of PrescribedFinalGeometry objects is returned. If the property argument is given, then that property value for each boundary prescribed final geometry is returned in the array instead of a PrescribedFinalGeometry object

    Arguments

  • Model (Model)

    Model to get boundary prescribed final geometrys from

  • flag (Flag)

    Flag set on the boundary prescribed final geometrys that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged boundary prescribed final geometrys in the model

    Returns

    Array of PrescribedFinalGeometry objects or properties

    Return type

    Array

    Example

    To make an array of PrescribedFinalGeometry objects for all of the boundary prescribed final geometrys in model m flagged with f: 

    var b = PrescribedFinalGeometry.GetFlagged(m, f);

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

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

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

    Description

    Returns the PrescribedFinalGeometry object for a boundary prescribed final geometry ID.

    Arguments

  • Model (Model)

    Model to find the boundary prescribed final geometry in

  • number (integer)

    number of the boundary prescribed final geometry you want the PrescribedFinalGeometry object for

    Returns

    PrescribedFinalGeometry object (or null if boundary prescribed final geometry does not exist).

    Return type

    PrescribedFinalGeometry

    Example

    To get the PrescribedFinalGeometry object for boundary prescribed final geometry 100 in model m 

    var b = PrescribedFinalGeometry.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    boundary prescribed final geometry property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if PrescribedFinalGeometry property b.example is a parameter: 

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

    To check if PrescribedFinalGeometry property b.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for PrescribedFinalGeometry bfg: 

    var key = bfg.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for PrescribedFinalGeometry bfg: 

    var cards = bfg.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last boundary prescribed final geometry in the model.

    Arguments

  • Model (Model)

    Model to get last boundary prescribed final geometry in

    Returns

    PrescribedFinalGeometry object (or null if there are no boundary prescribed final geometrys in the model).

    Return type

    PrescribedFinalGeometry

    Example

    To get the last boundary prescribed final geometry in model m: 

    var b = PrescribedFinalGeometry.Last(m);

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

    Description

    Returns the last free boundary prescribed final geometry label in the model. Also see PrescribedFinalGeometry.FirstFreeLabel(), PrescribedFinalGeometry.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get last free boundary prescribed final geometry 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

    PrescribedFinalGeometry label.

    Return type

    Number

    Example

    To get the last free boundary prescribed final geometry label in model m: 

    var label = PrescribedFinalGeometry.LastFreeLabel(m);

    Next()

    Description

    Returns the next boundary prescribed final geometry in the model.

    Arguments

    No arguments

    Returns

    PrescribedFinalGeometry object (or null if there are no more boundary prescribed final geometrys in the model).

    Return type

    PrescribedFinalGeometry

    Example

    To get the boundary prescribed final geometry in model m after boundary prescribed final geometry b: 

    var b = b.Next();

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

    Description

    Returns the next free (highest+1) boundary prescribed final geometry label in the model. Also see PrescribedFinalGeometry.FirstFreeLabel(), PrescribedFinalGeometry.LastFreeLabel() and Model.NextFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get next free boundary prescribed final geometry 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

    PrescribedFinalGeometry label.

    Return type

    Number

    Example

    To get the next free boundary prescribed final geometry label in model m: 

    var label = PrescribedFinalGeometry.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 boundary prescribed final geometry.

    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 boundary prescribed final geometrys from that model can be picked. If the argument is a Flag then only boundary prescribed final geometrys that are flagged with limit can be selected. If omitted, or null, any boundary prescribed final geometrys 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

    PrescribedFinalGeometry object (or null if not picked)

    Return type

    PrescribedFinalGeometry

    Example

    To pick a boundary prescribed final geometry from model m giving the prompt 'Pick boundary prescribed final geometry from screen': 

    var b = PrescribedFinalGeometry.Pick('Pick boundary prescribed final geometry from screen', m);

    Previous()

    Description

    Returns the previous boundary prescribed final geometry in the model.

    Arguments

    No arguments

    Returns

    PrescribedFinalGeometry object (or null if there are no more boundary prescribed final geometrys in the model).

    Return type

    PrescribedFinalGeometry

    Example

    To get the boundary prescribed final geometry in model m before boundary prescribed final geometry b: 

    var b = b.Previous();

    RemoveData(index[Integer])

    Description

    Removes a line of data for a *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY.

    Arguments

  • index (Integer)

    The index of the *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY data to remove. Note that indices start at 0, not 1.
    0 <= index < lines

    Returns

    No return value.

    Example

    To remove row 2 (indices start with 0) of open-ended cards for *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY b: 

    b.RemoveData(1);

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

    Description

    Renumbers all of the boundary prescribed final geometrys in the model.

    Arguments

  • Model (Model)

    Model that all boundary prescribed final geometrys will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the boundary prescribed final geometrys in model m, from 1000000: 

    PrescribedFinalGeometry.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged boundary prescribed final geometrys in the model.

    Arguments

  • Model (Model)

    Model that all the flagged boundary prescribed final geometrys will be renumbered in

  • flag (Flag)

    Flag set on the boundary prescribed final geometrys that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the boundary prescribed final geometrys in model m flagged with f, from 1000000: 

    PrescribedFinalGeometry.RenumberFlagged(m, f, 1000000);

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

    Description

    Allows the user to select boundary prescribed final geometrys using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting boundary prescribed final geometrys

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

    To select boundary prescribed final geometrys from model m, flagging those selected with flag f, giving the prompt 'Select boundary prescribed final geometrys': 

    PrescribedFinalGeometry.Select(f, 'Select boundary prescribed final geometrys', m);

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

    PrescribedFinalGeometry.Select(f, 'Select boundary prescribed final geometrys', l);

    SetData(index[Integer], nid[integer], x[real], y[real], z[real], lcid (optional)[integer], death (optional)[real])

    Description

    Sets a line of data for a *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY.

    Arguments

  • index (Integer)

    The index of the *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY data to set. Note that indices start at 0, not 1.
    0 <= index <= lines

  • nid (integer)

    Node or negative node set number.

  • x (real)

    X coordinates of final geometry.

  • y (real)

    Y coordinates of final geometry.

  • z (real)

    Z coordinates of final geometry.

  • lcid (optional) (integer)

    Loadcurve number.

  • death (optional) (real)

    Death time.

    Returns

    No return value.

    Example

    To set values for row 2 (indices start with 0) of open-ended cards for *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY b with the following specification: nid, x, y, z, lcid, death are 99, 0.1, 0.2, 0.3, 88, 100.0 respectively 

    b.SetData(1, 99, 0.1, 0.2, 0.3, 88, 100.0);

    To append a new line of data (using the same example values): 

    b.SetData(b.lines, 99, 0.1, 0.2, 0.3, 88, 100.0);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the boundary prescribed final geometry.

    Arguments

  • flag (Flag)

    Flag to set on the boundary prescribed final geometry

    Returns

    No return value

    Example

    To set flag f for boundary prescribed final geometry b: 

    b.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the boundary prescribed final geometry. The boundary prescribed final geometry will be sketched until you either call PrescribedFinalGeometry.Unsketch(), PrescribedFinalGeometry.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch boundary prescribed final geometry b: 

    b.Sketch();

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

    Description

    Sketches all of the flagged boundary prescribed final geometrys in the model. The boundary prescribed final geometrys will be sketched until you either call PrescribedFinalGeometry.Unsketch(), PrescribedFinalGeometry.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

    Arguments

  • Model (Model)

    Model that all the flagged boundary prescribed final geometrys will be sketched in

  • flag (Flag)

    Flag set on the boundary prescribed final geometrys that you want to sketch

  • redraw (optional) (boolean)

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

    PrescribedFinalGeometry.SketchFlagged(m, flag);

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

    Description

    Returns the total number of boundary prescribed final geometrys in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of boundary prescribed final geometrys

    Return type

    Number

    Example

    To get the total number of boundary prescribed final geometrys in model m: 

    var total = PrescribedFinalGeometry.Total(m);

    Unblank()

    Description

    Unblanks the boundary prescribed final geometry

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank boundary prescribed final geometry b: 

    b.Unblank();

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

    Description

    Unblanks all of the boundary prescribed final geometrys in the model.

    Arguments

  • Model (Model)

    Model that all boundary prescribed final geometrys 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 boundary prescribed final geometrys in model m: 

    PrescribedFinalGeometry.UnblankAll(m);

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

    Description

    Unblanks all of the flagged boundary prescribed final geometrys in the model.

    Arguments

  • Model (Model)

    Model that the flagged boundary prescribed final geometrys will be unblanked in

  • flag (Flag)

    Flag set on the boundary prescribed final geometrys 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 boundary prescribed final geometrys in model m flagged with f: 

    PrescribedFinalGeometry.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the boundary prescribed final geometrys in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all boundary prescribed final geometrys will be unset in

  • flag (Flag)

    Flag to unset on the boundary prescribed final geometrys

    Returns

    No return value

    Example

    To unset the flag f on all the boundary prescribed final geometrys in model m: 

    PrescribedFinalGeometry.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the boundary prescribed final geometry.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch boundary prescribed final geometry b: 

    b.Unsketch();

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

    Description

    Unsketches all boundary prescribed final geometrys.

    Arguments

  • Model (Model)

    Model that all boundary prescribed final geometrys will be unblanked in

  • redraw (optional) (boolean)

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

    PrescribedFinalGeometry.UnsketchAll(m);

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

    Description

    Unsketches all flagged boundary prescribed final geometrys in the model.

    Arguments

  • Model (Model)

    Model that all boundary prescribed final geometrys will be unsketched in

  • flag (Flag)

    Flag set on the boundary prescribed final geometrys that you want to unsketch

  • redraw (optional) (boolean)

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

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

    PrescribedFinalGeometry object.

    Return type

    PrescribedFinalGeometry

    Example

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

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

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

    Description

    Adds a warning for boundary prescribed final geometry. 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 boundary prescribed final geometry b: 

    b.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this boundary prescribed final geometry.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for boundary prescribed final geometry b: 

    var xrefs = b.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for PrescribedFinalGeometry bfg in keyword format 

    var s = bfg.toString();