MorphFlow class

The MorphFlow class gives you access to morph flows 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

MorphFlow properties

Name Type Description
exists (read only) logical true if flow exists, false if referred to but not defined.
include integer The Include file number that the flow is in.
max real Maximum value for type set to "CONTINUOUS" or "STEP" when written as design variable for LS-OPT.
min real Minimum value for type set to "CONTINUOUS" or "STEP" when written as design variable for LS-OPT.
model (read only) integer The Model number that the flow is in.
name string Name of the morph flow. If the flow is used for applying LS-OPT variables, this should match the variable name in the listing file written by LS-OPT.
npoints (read only) integer Number of morph points referenced by the flow.
nvals (read only) integer Number of values in the list when type is set to "DISCRETE".
step real Step size for type set to "STEP" when written as design variable for LS-OPT.
type string Range type for the morph flow. This should be "CONTINUOUS", "STEP" or "DISCRETE" and may be used for LS-OPT when writing design variable files from morph flows.

Detailed Description

The MorphFlow class allows you to create, modify and manipulate morph flows. See the documentation below for more details.

Constructor

new MorphFlow(Model[Model], name[string])

Description

Create a new MorphFlow object.

Arguments

  • Model (Model)

    Model that morph flow will be created in

  • name (string)

    MorphFlow name

    Returns

    MorphFlow object

    Return type

    MorphFlow

    Example

    To create a new (empty) morph flow in model m with name 'depth' 

    var f = new MorphFlow(m, "depth");

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a flow.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the flow

    Returns

    No return value

    Example

    To associate comment c to the flow flow: 

    flow.AssociateComment(c);

    Blank()

    Description

    Blanks the flow

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank flow flow: 

    flow.Blank();

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

    Description

    Blanks all of the flows in the model.

    Arguments

  • Model (Model)

    Model that all flows 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 flows in model m: 

    MorphFlow.BlankAll(m);

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

    Description

    Blanks all of the flagged flows in the model.

    Arguments

  • Model (Model)

    Model that all the flagged flows will be blanked in

  • flag (Flag)

    Flag set on the flows 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 flows in model m flagged with f: 

    MorphFlow.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the flow is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if flow flow is blanked: 

    if (flow.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 flow flow: 

    flow.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the flow.

    Arguments

  • flag (Flag)

    Flag to clear on the flow

    Returns

    No return value

    Example

    To clear flag f for flow flow: 

    flow.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    MorphFlow object

    Return type

    MorphFlow

    Example

    To copy flow flow into flow z: 

    var z = flow.Copy();

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

    Description

    Starts an interactive editing panel to create a flow

    Arguments

  • Model (Model)

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

    MorphFlow object (or null if not made).

    Return type

    MorphFlow

    Example

    To start creating a flow in model m: 

    var flow = MorphFlow.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a flow.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the flow

    Returns

    No return value

    Example

    To detach comment c from the flow flow: 

    flow.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 flow flow: 

    flow.Edit();

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

    Description

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

    flow.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first flow in the model.

    Arguments

  • Model (Model)

    Model to get first flow in

    Returns

    MorphFlow object (or null if there are no flows in the model).

    Return type

    MorphFlow

    Example

    To get the first flow in model m: 

    var flow = MorphFlow.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all flows will be flagged in

  • flag (Flag)

    Flag to set on the flows

    Returns

    No return value

    Example

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

    MorphFlow.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the flow is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the flow

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if flow flow has flag f set on it: 

    if (flow.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all flows are in

  • func (function)

    Function to call for each flow

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

    MorphFlow.ForEach(m, test);
function test(flow)
{
// flow is MorphFlow object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get flows from

  • property (optional) (string)

    Name for property to get for all flows in the model

    Returns

    Array of MorphFlow objects or properties

    Return type

    Array

    Example

    To make an array of MorphFlow objects for all of the flows in model m: 

    var a = MorphFlow.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a flow.

    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 flow flow: 

    var comm_array = flow.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get flows from

  • flag (Flag)

    Flag set on the flows that you want to retrieve

  • property (optional) (string)

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

    Returns

    Array of MorphFlow objects or properties

    Return type

    Array

    Example

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

    var flow = MorphFlow.GetFlagged(m, f);

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

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

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

    Description

    Returns the MorphFlow object for a flow ID.

    Arguments

  • Model (Model)

    Model to find the flow in

  • number (integer)

    number of the flow you want the MorphFlow object for

    Returns

    MorphFlow object (or null if flow does not exist).

    Return type

    MorphFlow

    Example

    To get the MorphFlow object for flow 100 in model m 

    var flow = MorphFlow.GetFromID(m, 100);

    GetFromName(Model[Model], morph flow name[string]) [static]

    Description

    Returns the stored MorphFlow object for a morph flow name. WARNING: This assumes that there is at most one morph flow with a given name. Otherwise this function only returns the first occurrence.

    Arguments

  • Model (Model)

    Model to find the morph flow in

  • morph flow name (string)

    name of the morph flow you want the MorphFlow object for

    Returns

    MorphFlow object (or null if morph flow does not exist).

    Return type

    MorphFlow

    Example

    To get the MorphFlow object for flow "depth" in model m 

    var f = MorphFlow.GetFromName(m, "depth");

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    flow property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if MorphFlow property flow.example is a parameter: 

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

    To check if MorphFlow property flow.example is a parameter by using the GetParameter method: 

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

    GetRow(row[integer])

    Description

    Returns the data for a row in the morph flow.

    Arguments

  • row (integer)

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

    Returns

    An array of numbers containing the morph point ID at index 0 and the vector components at indices 1, 2, 3.

    Return type

    Number

    Example

    To get the data for the 2nd row in morph flow f: 

    var data = f.GetRow(1);
var point_id = data[0];
var dx = data[1];
var dy = data[2];
var dz = data[3];

    GetValue(index[integer])

    Description

    Get the value at given index on the morph flow with type "DISCRETE".

    Arguments

  • index (integer)

    The index where you are extracting the value. Note row indices start at 0.

    Returns

    real

    Return type

    Number

    Example

    To get the 2nd value for morph flow f with type "DISCRETE": 

    var value = f.GetValue(1);

    To get the last value on the list of values on f: 

    var value = f.GetValue(f.nvals - 1);

    Keyword()

    Description

    Returns the keyword for this morph flow (*MORPH_FLOW). Note that a carriage return is not added. See also MorphFlow.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for morph flow f: 

    var key = f.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for morph flow f: 

    var cards = f.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last flow in the model.

    Arguments

  • Model (Model)

    Model to get last flow in

    Returns

    MorphFlow object (or null if there are no flows in the model).

    Return type

    MorphFlow

    Example

    To get the last flow in model m: 

    var flow = MorphFlow.Last(m);

    Next()

    Description

    Returns the next flow in the model.

    Arguments

    No arguments

    Returns

    MorphFlow object (or null if there are no more flows in the model).

    Return type

    MorphFlow

    Example

    To get the flow in model m after flow flow: 

    var flow = flow.Next();

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

    Description

    Allows the user to pick a flow.

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

    MorphFlow object (or null if not picked)

    Return type

    MorphFlow

    Example

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

    var flow = MorphFlow.Pick('Pick flow from screen', m);

    Previous()

    Description

    Returns the previous flow in the model.

    Arguments

    No arguments

    Returns

    MorphFlow object (or null if there are no more flows in the model).

    Return type

    MorphFlow

    Example

    To get the flow in model m before flow flow: 

    var flow = flow.Previous();

    RemoveRow(row[integer])

    Description

    Removes the data (a morph point ID and its three vector components) for a row in *MORPH_FLOW.

    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 morph flow f: 

    f.RemoveRow(1);

    RemoveValue(index[integer])

    Description

    Removes the value at given index in *MORPH_FLOW with type "DISCRETE".

    Arguments

  • index (integer)

    The index where you are removing the value. Note that indices start at 0.

    Returns

    No return value.

    Example

    To remove the second value for morph flow f: 

    f.RemoveValue(1);

    To remove the last value for f: 

    f.RemoveValue(f.nvals - 1);

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting flows

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    MorphFlow.Select(f, 'Select flows', m);

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

    MorphFlow.Select(f, 'Select flows', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the flow.

    Arguments

  • flag (Flag)

    Flag to set on the flow

    Returns

    No return value

    Example

    To set flag f for flow flow: 

    flow.SetFlag(f);

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

    Description

    Sets the data for a row in *MORPH_FLOW.

    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. It should be of length 4 having the morph point ID at index 0, and the vector components at indices 1, 2, 3.

    Returns

    No return value.

    Example

    To set the second point of the morph flow f to be morph point 11 with unit vector in X-direction: 

    var array = [11, 1.0, 0.0, 0.0];
f.SetRow(1, array);

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

    f.SetRow(f.npoints, array);

    SetValue(index[integer], value[real])

    Description

    Sets the value at given index in a *MORPH_FLOW with type "DISCRETE".

    Arguments

  • index (integer)

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

  • value (real)

    The new value to insert into the list.

    Returns

    No return value.

    Example

    To set the second value morph flow f to 20.0: 

    f.SetValue(1, 20.0);

    To append the value 20.0 to the end of the list: 

    f.SetValue(f.nvals, 20.0);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch flow flow: 

    flow.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged flows will be sketched in

  • flag (Flag)

    Flag set on the flows that you want to sketch

  • redraw (optional) (boolean)

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

    MorphFlow.SketchFlagged(m, flag);

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

    Description

    Returns the total number of flows in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of flows

    Return type

    Number

    Example

    To get the total number of flows in model m: 

    var total = MorphFlow.Total(m);

    Unblank()

    Description

    Unblanks the flow

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank flow flow: 

    flow.Unblank();

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

    Description

    Unblanks all of the flows in the model.

    Arguments

  • Model (Model)

    Model that all flows 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 flows in model m: 

    MorphFlow.UnblankAll(m);

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

    Description

    Unblanks all of the flagged flows in the model.

    Arguments

  • Model (Model)

    Model that the flagged flows will be unblanked in

  • flag (Flag)

    Flag set on the flows 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 flows in model m flagged with f: 

    MorphFlow.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the flows

    Returns

    No return value

    Example

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

    MorphFlow.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the flow.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch flow flow: 

    flow.Unsketch();

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

    Description

    Unsketches all flows.

    Arguments

  • Model (Model)

    Model that all flows will be unblanked in

  • redraw (optional) (boolean)

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

    MorphFlow.UnsketchAll(m);

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

    Description

    Unsketches all flagged flows in the model.

    Arguments

  • Model (Model)

    Model that all flows will be unsketched in

  • flag (Flag)

    Flag set on the flows that you want to unsketch

  • redraw (optional) (boolean)

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

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

    MorphFlow object.

    Return type

    MorphFlow

    Example

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

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

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

    Description

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

    flow.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this flow.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for flow flow: 

    var xrefs = flow.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for morph flow f in keyword format 

    var s = f.toString();