PrescribedMotion class

Returns

PrescribedMotion object

Return type

PrescribedMotion

Example

To create a new displacement for node 100 in x using loadcurve 10 model m with label 200, of type SET

var b = new PrescribedMotion(m, 100, 1, 2, 10, PrescribedMotion.SET, 200);

Details of functions

AnimationBackward() [static]

Description

Moves backward one frame of a PrescribedMotion animation (pausing animation first if required). Also see the PrescribedMotion.AnimationBegin() method which MUST be called before you start animating and the PrescribedMotion.AnimationFinish() method which MUST be called after you have finished animating.

Returns

No return value

Example

To move backward one frame of an animation:

PrescribedMotion.AnimationBackward();

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

Description

Begins a PrescribedMotion animation. This MUST be called before any of the other Animation methods. Also see the PrescribedMotion.AnimationFinish() method which MUST be called after you have finished animating.

Returns

Example

To begin an animation of the PrescribedMotions in model m flagged with f:

var aprops = PrescribedMotion.AnimationBegin(m, f);

AnimationFinish() [static]

Description

Finishes a PrescribedMotion animation. This MUST be called to finish animating. This will restore nodal coordinates but will not perform a graphics update. Also see the PrescribedMotion.AnimationBegin() method which MUST be called before you start animating.

Returns

No return value

Example

To finish animating:

PrescribedMotion.AnimationFinish();

AnimationForward() [static]

Description

Moves forward one frame of a PrescribedMotion animation (pausing animation first if required). Also see the PrescribedMotion.AnimationBegin() method which MUST be called before you start animating and the PrescribedMotion.AnimationFinish() method which MUST be called after you have finished animating.

Returns

No return value

Example

To move forward one frame of an animation:

PrescribedMotion.AnimationForward();

AnimationGetData() [static]

Description

Returns the animation data (pausing animation first if required). Also see the PrescribedMotion.AnimationBegin() method which MUST be called before you start animating and the PrescribedMotion.AnimationFinish() method which MUST be called after you have finished animating.

Returns

Example

To get the current animation data:

PrescribedMotion.AnimationGetData();

AnimationPause() [static]

Description

Pauses playback of a PrescribedMotion animation. Also see the PrescribedMotion.AnimationBegin() method which MUST be called before you start animating and the PrescribedMotion.AnimationFinish() method which MUST be called after you have finished animating.

Returns

No return value

Example

To pause playback of an animation:

PrescribedMotion.AnimationPause();

AnimationPlay() [static]

Description

Starts playback of a PrescribedMotion animation. Also see the PrescribedMotion.AnimationBegin() method which MUST be called before you start animating and the PrescribedMotion.AnimationFinish() method which MUST be called after you have finished animating.
This method should only be used from a script which implements a user interface so you can actually stop the animation! Don't forget to add a pause/stop button that calls PrescribedMotion.AnimationPause()!

Returns

No return value

Example

To start playback of an animation:

PrescribedMotion.AnimationPlay();

AnimationSetData(data[object]) [static]

Description

Sets the current animation data (pausing animation first if required). Also see the PrescribedMotion.AnimationBegin() method which MUST be called before you start animating and the PrescribedMotion.AnimationFinish() method which MUST be called after you have finished animating.

Returns

No return value

Example

To set the animation frame rate to 10 frames/sec:

data = PrescribedMotion.AnimationGetData();
data.rate = 10;
PrescribedMotion.AnimationSetData(data);

AnimationToEnd() [static]

Description

Moves to the end of a PrescribedMotion animation (pausing animation first if required). Also see the PrescribedMotion.AnimationBegin() method which MUST be called before you start animating and the PrescribedMotion.AnimationFinish() method which MUST be called after you have finished animating.

Returns

No return value

Example

To move to the end of an animation:

PrescribedMotion.AnimationToEnd();

AnimationToStart() [static]

Description

Moves to the start of a PrescribedMotion animation (pausing animation first if required). Also see the PrescribedMotion.AnimationBegin() method which MUST be called before you start animating and the PrescribedMotion.AnimationFinish() method which MUST be called after you have finished animating.

Returns

No return value

Example

To move to the start of an animation:

PrescribedMotion.AnimationToStart();

AnimationToTime() [static]

Description

Moves to a specific time in a PrescribedMotion animation (pausing animation first if required). Also see the PrescribedMotion.AnimationBegin() method which MUST be called before you start animating and the PrescribedMotion.AnimationFinish() method which MUST be called after you have finished animating.

Returns

No return value

Example

To move to time 28.0 in an animation:

PrescribedMotion.AnimationToTime(28.0);

AssociateComment(Comment[Comment])

Description

Associates a comment with a boundary prescribed motion.

Returns

No return value

Example

To associate comment c to the boundary prescribed motion b:

b.AssociateComment(c);

Blank()

Description

Blanks the boundary prescribed motion

Returns

No return value

Example

To blank boundary prescribed motion b:

b.Blank();

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

Description

Blanks all of the boundary prescribed motions in the model.

Returns

No return value

Example

To blank all of the boundary prescribed motions in model m:

PrescribedMotion.BlankAll(m);

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

Description

Blanks all of the flagged boundary prescribed motions in the model.

Returns

No return value

Example

To blank all of the boundary prescribed motions in model m flagged with f:

PrescribedMotion.BlankFlagged(m, f);

Blanked()

Description

Checks if the boundary prescribed motion is blanked or not.

Returns

true if blanked, false if not.

Return type

Boolean

Example

To check if boundary prescribed motion b is blanked:

if (b.Blanked() ) do_something...

ClearFlag(flag[Flag])

Description

Clears a flag on the boundary prescribed motion.

Returns

No return value

Example

To clear flag f for boundary prescribed motion b:

b.ClearFlag(f);

Copy(range (optional)[boolean])

Description

Copies the boundary prescribed motion. The target include of the copied boundary prescribed motion can be set using Options.copy_target_include.

Returns

PrescribedMotion object

Return type

PrescribedMotion

Example

To copy boundary prescribed motion b into boundary prescribed motion z:

var z = b.Copy();

DetachComment(Comment[Comment])

Description

Detaches a comment from a boundary prescribed motion.

Returns

No return value

Example

To detach comment c from the boundary prescribed motion b:

b.DetachComment(c);

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

Description

Adds an error for boundary prescribed motion. For more details on checking see the Check class.

Returns

No return value

Example

To add an error message "My custom error" for boundary prescribed motion b:

b.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first boundary prescribed motion in the model.

Returns

PrescribedMotion object (or null if there are no boundary prescribed motions in the model).

Return type

PrescribedMotion

Example

To get the first boundary prescribed motion in model m:

var b = PrescribedMotion.First(m);

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

Description

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

Returns

PrescribedMotion label.

Return type

Number

Example

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

var label = PrescribedMotion.FirstFreeLabel(m);

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

Description

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

Returns

No return value

Example

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

PrescribedMotion.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the boundary prescribed motion is flagged or not.

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if boundary prescribed motion 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 motion in the model.
Note that ForEach has been designed to make looping over boundary prescribed motions as fast as possible and so has some limitations.
Firstly, a single temporary PrescribedMotion object is created and on each function call it is updated with the current boundary prescribed motion data. This means that you should not try to store the PrescribedMotion object for later use (e.g. in an array) as it is temporary.
Secondly, you cannot create new boundary prescribed motions inside a ForEach loop.

Returns

No return value

Example

To call function test for all of the boundary prescribed motions in model m:

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

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

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

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

Description

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

Returns

Array of PrescribedMotion objects or properties

Return type

Array

Example

To make an array of PrescribedMotion objects for all of the boundary prescribed motions in model m:

var a = PrescribedMotion.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a boundary prescribed motion.

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 motion b:

var comm_array = b.GetComments();

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

Description

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

Returns

Array of PrescribedMotion objects or properties

Return type

Array

Example

To make an array of PrescribedMotion objects for all of the boundary prescribed motions in model m flagged with f:

var b = PrescribedMotion.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 motions in model m flagged with f:

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

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

Description

Returns the PrescribedMotion object for a boundary prescribed motion ID.

Returns

PrescribedMotion object (or null if boundary prescribed motion does not exist).

Return type

PrescribedMotion

Example

To get the PrescribedMotion object for boundary prescribed motion 100 in model m

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

GetParameter(prop[string])

Description

Checks if a PrescribedMotion 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 PrescribedMotion.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 PrescribedMotion 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 PrescribedMotion 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 PrescribedMotion (*BOUNDARY_PRESCRIBED_MOTION_xxxx). Note that a carriage return is not added. See also PrescribedMotion.KeywordCards()

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for PrescribedMotion pm:

var key = pm.Keyword();

KeywordCards()

Description

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

Returns

string containing the cards.

Return type

String

Example

To get the cards for PrescribedMotion pm:

var cards = pm.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last boundary prescribed motion in the model.

Returns

PrescribedMotion object (or null if there are no boundary prescribed motions in the model).

Return type

PrescribedMotion

Example

To get the last boundary prescribed motion in model m:

var b = PrescribedMotion.Last(m);

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

Description

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

Returns

PrescribedMotion label.

Return type

Number

Example

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

var label = PrescribedMotion.LastFreeLabel(m);

Next()

Description

Returns the next boundary prescribed motion in the model.

Returns

PrescribedMotion object (or null if there are no more boundary prescribed motions in the model).

Return type

PrescribedMotion

Example

To get the boundary prescribed motion in model m after boundary prescribed motion b:

var b = b.Next();

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

Description

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

Returns

PrescribedMotion label.

Return type

Number

Example

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

var label = PrescribedMotion.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 motion.

Returns

PrescribedMotion object (or null if not picked)

Return type

PrescribedMotion

Example

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

var b = PrescribedMotion.Pick('Pick boundary prescribed motion from screen', m);

Previous()

Description

Returns the previous boundary prescribed motion in the model.

Returns

PrescribedMotion object (or null if there are no more boundary prescribed motions in the model).

Return type

PrescribedMotion

Example

To get the boundary prescribed motion in model m before boundary prescribed motion b:

var b = b.Previous();

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

Description

Renumbers all of the boundary prescribed motions in the model.

Returns

No return value

Example

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

PrescribedMotion.RenumberAll(m, 1000000);

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

Description

Renumbers all of the flagged boundary prescribed motions in the model.

Returns

No return value

Example

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

PrescribedMotion.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 motions using standard PRIMER object menus.

Returns

Number of boundary prescribed motions selected or null if menu cancelled

Return type

Number

Example

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

PrescribedMotion.Select(f, 'Select boundary prescribed motions', m);

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

PrescribedMotion.Select(f, 'Select boundary prescribed motions', l);

SetFlag(flag[Flag])

Description

Sets a flag on the boundary prescribed motion.

Returns

No return value

Example

To set flag f for boundary prescribed motion b:

b.SetFlag(f);

Sketch(redraw (optional)[boolean])

Description

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

Returns

No return value

Example

To sketch boundary prescribed motion b:

b.Sketch();

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

Description

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

Returns

No return value

Example

To sketch all boundary prescribed motions flagged with flag in model m:

PrescribedMotion.SketchFlagged(m, flag);

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

Description

Returns the total number of boundary prescribed motions in the model.

Returns

number of boundary prescribed motions

Return type

Number

Example

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

var total = PrescribedMotion.Total(m);

Unblank()

Description

Unblanks the boundary prescribed motion

Returns

No return value

Example

To unblank boundary prescribed motion b:

b.Unblank();

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

Description

Unblanks all of the boundary prescribed motions in the model.

Returns

No return value

Example

To unblank all of the boundary prescribed motions in model m:

PrescribedMotion.UnblankAll(m);

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

Description

Unblanks all of the flagged boundary prescribed motions in the model.

Returns

No return value

Example

To unblank all of the boundary prescribed motions in model m flagged with f:

PrescribedMotion.UnblankFlagged(m, f);

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

Description

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

Returns

No return value

Example

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

PrescribedMotion.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the boundary prescribed motion.

Returns

No return value

Example

To unsketch boundary prescribed motion b:

b.Unsketch();

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

Description

Unsketches all boundary prescribed motions.

Returns

No return value

Example

To unsketch all boundary prescribed motions in model m:

PrescribedMotion.UnsketchAll(m);

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

Description

Unsketches all flagged boundary prescribed motions in the model.

Returns

No return value

Example

To unsketch all boundary prescribed motions flagged with flag in model m:

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

Returns

PrescribedMotion object.

Return type

PrescribedMotion

Example

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

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

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

Description

Adds a warning for boundary prescribed motion. For more details on checking see the Check class.

Returns

No return value

Example

To add a warning message "My custom warning" for boundary prescribed motion b:

b.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this boundary prescribed motion.

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for boundary prescribed motion b:

var xrefs = b.Xrefs();

toString()

Description

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

Returns

string

Return type

String

Example

To get data for PrescribedMotion pm in keyword format

var s = pm.toString();