Curve class

Returns

Curve object

Return type

Curve

Example

To create a new curve in model m with label 200

var l = new Curve(Curve.CURVE, m, 200);

To create a new curve function in model m with label 200 and function '0.5*lc9*vm(22)**3' (example from keyword manual)

var l = new Curve(Curve.CURVE_FUNCTION, m, 200, 0, "0.5*lc9*vm(22)**3");

To create a new function in model m with label 200 and function 'x(t)=1000*sin(100*t)' and title 'x-velo' (example from keyword manual)

var l = new Curve(Curve.FUNCTION, m, 200, "x(t)=1000*sin(100*t)", "x-velo");

To create a new curve function in model m with label 200' (example from keyword manual)

var l = new Curve(Curve.CURVE_SMOOTH, m, 200);

new Curve(Load curve type[constant], Model[Model], lcid[integer], sidr (optional)[integer], sfa (optional)[real], sfo (optional)[real], offa (optional)[real], offo (optional)[real], dattyp (optional)[integer], heading (optional)[string], lcint (optional)[integer])   [deprecated]

This function is deprecated in version 21.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Create a new Curve object.

Returns

Curve object

Return type

Curve

Example

To create a new curve in model m with label 200

var l = new Curve(Curve.CURVE, m, 200);

new Curve(Load curve type[constant], Model[Model], lcid[integer], sidr (optional)[integer], function (optional)[string], heading (optional)[string])   [deprecated]

This function is deprecated in version 21.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Create a new Curve *DEFINE_CURVE_FUNCTION object.

Returns

Curve object

Return type

Curve

Example

To create a new curve function in model m with label 200 and function '0.5*lc9*vm(22)**3' (example from keyword manual)

var l = new Curve(Curve.CURVE_FUNCTION, m, 200, 0, "0.5*lc9*vm(22)**3");

new Curve(Load curve type[constant], Model[Model], lcid[integer], function (optional)[string], heading (optional)[string])   [deprecated]

This function is deprecated in version 21.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Create a new Curve *DEFINE_FUNCTION object.

Returns

Curve object

Return type

Curve

Example

To create a new function in model m with label 200 and function 'x(t)=1000*sin(100*t)' and title 'x-velo' (example from keyword manual)

var l = new Curve(Curve.FUNCTION, m, 200, "x(t)=1000*sin(100*t)", "x-velo");

new Curve(Load curve type[constant], Model[Model], lcid[integer], sidr (optional)[integer], dist (optional)[real], tstart (optional)[real], tend (optional)[real], trise (optional)[real], vmax (optional)[real], heading (optional)[string])   [deprecated]

This function is deprecated in version 21.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Create a new Curve *DEFINE_CURVE_SMOOTH object.

Returns

Curve object

Return type

Curve

Example

To create a new curve function in model m with label 200' (example from keyword manual)

var l = new Curve(Curve.CURVE_SMOOTH, m, 200);

Details of functions

AddPoint(xvalue[real], yvalue[real])

Description

Adds a point to a load curve.

Returns

No return value.

Example

To add a point with values of x=3 and y=5 to curve l:

l.AddPoint(3, 5);

AddTableEntry(value[real], load curve[integer])

Description

Adds an entry line to a table.

Returns

No return value.

Example

To add an entry with a value of 3 for load curve 1000:

l.AddTableEntry(3, 1000);

AssociateComment(Comment[Comment])

Description

Associates a comment with a curve.

Returns

No return value

Example

To associate comment c to the curve c:

c.AssociateComment(c);

Browse(modal (optional)[boolean])

Description

Starts an edit panel in Browse mode.

Returns

no return value

Example

To Browse curve c:

c.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the curve.

Returns

No return value

Example

To clear flag f for curve c:

c.ClearFlag(f);

Copy(range (optional)[boolean])

Description

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

Returns

Curve object

Return type

Curve

Example

To copy curve c into curve z:

var z = c.Copy();

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

Description

Starts an interactive editing panel to create a curve.

Returns

Curve object (or null if not made)

Return type

Curve

Example

To start creating a curve in model m:

var l = Curve.Create(m);

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

Description

Starts an interactive editing panel to create a table.

Returns

Curve object (or null if not made)

Return type

Curve

Example

To start creating a table in model m:

var l = Curve.CreateTable(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a curve.

Returns

No return value

Example

To detach comment c from the curve c:

c.DetachComment(c);

Edit(modal (optional)[boolean])

Description

Starts an interactive editing panel.

Returns

no return value

Example

To Edit curve c:

c.Edit();

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

Description

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

Returns

No return value

Example

To add an error message "My custom error" for curve c:

c.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first curve in the model.

Returns

Curve object (or null if there are no curves in the model).

Return type

Curve

Example

To get the first curve in model m:

var c = Curve.First(m);

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

Description

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

Returns

Curve label.

Return type

Number

Example

To get the first free curve label in model m:

var label = Curve.FirstFreeLabel(m);

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

Description

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

Returns

No return value

Example

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

Curve.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the curve is flagged or not.

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if curve c has flag f set on it:

if (c.Flagged(f) ) do_something...

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

Description

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

Returns

No return value

Example

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

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

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

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

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

Description

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

Returns

Array of Curve objects or properties

Return type

Array

Example

To make an array of Curve objects for all of the curves in model m:

var a = Curve.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a curve.

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 curve c:

var comm_array = c.GetComments();

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

Description

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

Returns

Array of Curve objects or properties

Return type

Array

Example

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

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

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

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

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

Description

Returns the Curve object for a curve ID.

Returns

Curve object (or null if curve does not exist).

Return type

Curve

Example

To get the Curve object for curve 100 in model m

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

GetParameter(prop[string])

Description

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

Returns

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

Return type

Parameter

Example

To check if Curve property c.example is a parameter:

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

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

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

GetPoint(row[integer])

Description

Returns x and y data for a point in a curve

Returns

An array containing the x coordinate and the y coordinate.

Return type

Array

Example

To get the curve data for the 3rd point for curve l:

if (l.npoints >= 3)
{
    var point_data = l.GetPoint(2);
}

GetTableEntry(row[integer])

Description

Returns the value and curve label for a row in a table

Returns

An array containing the value and the load curve label.

Return type

Array

Example

To get the data for the 3rd point for table t:

if (t.npoints >= 3)
{
    var row_data = t.GetTableEntry(2);
}

InsertPoint(ipt[integer], xvalue[real], yvalue[real], position[integer])

Description

Inserts point values before or after a specified row of data on a load curve.

Returns

No return value.

Example

To insert the values after the 3rd row to x=3, y=5 for curve l:

l.InsertPoint(2, 3, 5, Curve.AFTER);

InsertTableEntry(ipt[integer], value[real], lcid[integer], position[integer])

Description

Inserts a table row before or after a specified row of data on a table.

Returns

No return value.

Example

To insert the values after the 3rd row to value=3, lcur=5 for table t:

t.InsertTableEntry(2, 3, 5, Curve.AFTER);

Keyword()

Description

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

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for curve l:

var key = l.Keyword();

KeywordCards()

Description

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

Returns

string containing the cards.

Return type

String

Example

To get the cards for curve l:

var cards = l.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last curve in the model.

Returns

Curve object (or null if there are no curves in the model).

Return type

Curve

Example

To get the last curve in model m:

var c = Curve.Last(m);

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

Description

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

Returns

Curve label.

Return type

Number

Example

To get the last free curve label in model m:

var label = Curve.LastFreeLabel(m);

Next()

Description

Returns the next curve in the model.

Returns

Curve object (or null if there are no more curves in the model).

Return type

Curve

Example

To get the curve in model m after curve c:

var c = c.Next();

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

Description

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

Returns

Curve label.

Return type

Number

Example

To get the next free curve label in model m:

var label = Curve.NextFreeLabel(m);

Previous()

Description

Returns the previous curve in the model.

Returns

Curve object (or null if there are no more curves in the model).

Return type

Curve

Example

To get the curve in model m before curve c:

var c = c.Previous();

RemovePoint(row[integer])

Description

Removes a row of data from a curve

Returns

No return value.

Example

To remove the curve data for the 3rd point for curve l:

if (l.npoints >= 3)
{
    var point_data = l.RemovePoint(2);
}

RemoveTableEntry(ipt[integer])

Description

Removes the value and loadcurve values for a specified row of data on a load curve.

Returns

No return value.

Example

To remove an entry at row 4:

t.RemoveTableEntry(4);

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

Description

Renumbers all of the curves in the model.

Returns

No return value

Example

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

Curve.RenumberAll(m, 1000000);

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

Description

Renumbers all of the flagged curves in the model.

Returns

No return value

Example

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

Curve.RenumberFlagged(m, f, 1000000);

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

Description

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

Returns

Number of curves selected or null if menu cancelled

Return type

Number

Example

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

Curve.Select(f, 'Select curves', m);

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

Curve.Select(f, 'Select curves', l);

SetFlag(flag[Flag])

Description

Sets a flag on the curve.

Returns

No return value

Example

To set flag f for curve c:

c.SetFlag(f);

SetPoint(ipt[integer], xvalue[real], yvalue[real])

Description

Sets the x and y values for a specified row of data on a load curve.

Returns

No return value.

Example

To set the values for the 3rd row to x=3, y=5 for curve l:

l.SetPoint(2, 3, 5);

SetTableEntry(ipt[integer], value[real], load curve[integer])

Description

Sets the value and loadcurve values for a specified row of data on a load curve.

Returns

No return value.

Example

To add an entry with a value of 3 for load curve 1000 at row 4:

t.SetTableEntry(4, 3, 1000);

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

Description

Returns the total number of curves in the model.

Returns

number of curves

Return type

Number

Example

To get the total number of curves in model m:

var total = Curve.Total(m);

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

Description

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

Returns

No return value

Example

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

Curve.UnflagAll(m, f);

ViewParameters()

Description

Object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. This function temporarily changes the behaviour so that if a property is a parameter the parameter name is returned instead. This can be used with 'method chaining' (see the example below) to make sure a property argument is correct.

Returns

Curve object.

Return type

Curve

Example

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

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

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

Description

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

Returns

No return value

Example

To add a warning message "My custom warning" for curve c:

c.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this curve.

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for curve c:

var xrefs = c.Xrefs();

toString()

Description

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

Returns

string

Return type

String

Example

To get data for curve l in keyword format

var l = d.toString();