Include class

Returns

Include object

Return type

Include

Example

To create a new include file /path/to/include.key in model m

var i = new Include(m, "/path/to/include.key");

Details of functions

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

Description

Blanks all of the includes in the model.

Returns

No return value

Example

To blank all of the includes in model m:

Include.BlankAll(m);

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

Description

Blanks all of the flagged include files in the model.

Returns

No return value

Example

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

Include.BlankFlagged(m, f);

ClearFlag(flag[Flag], clear contents (optional)[boolean])

Description

Clears a flag on the include.

Returns

Number of item flags cleared

Return type

Number

Example

To clear flag f for include i:

i.ClearFlag(f);

To clear flag f for include i and all of the items inside the include file, returning the number of item flags cleared in the include file:

var ncleared = i.ClearFlag(f, true);

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

Description

Adds an error for an include file. For more details on checking see the Check class. Note that this function is not supported for the master include file.

Returns

No return value

Example

To add an error message "My custom error" for include i:

i.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first include file in the model.

Returns

Include object (or null if there are no includes in the model).

Return type

Include

Example

To get the first include in model m:

var i = Include.First(m);

FlagAll(Model[Model], flag[Flag], masterInclude (optional)[boolean]) [static]

Description

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

Returns

No return value

Example

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

Include.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the include is flagged or not.

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if include i has flag f set on it:

if (i.Flagged(f) ) do_something...

GetAll(Model[Model], masterInclude (optional)[boolean]) [static]

Description

Returns an array of Include objects for all of the includes in a model in PRIMER

Returns

Array of Include objects

Return type

Array

Example

To make an array of Include objects for all of the includes in model m

var i = Include.GetAll(m);

GetDetailedRange(type argument[string])

Description

Gets detailed min and max label ranges for specified type from the include.

Returns

An array containing the min and max label ranges for the specified type or null if no range defined for this type.

Return type

Array

Example

To get node ranges for include i:

var ranges = i.GetDetailedRange("NODE");
var min = ranges[0];
var max = ranges[1];
      

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

Description

Returns the Include object for an include label.
Note that items that are in the main keyword file will have a layer value of 0 which can be used as the include number argument to this function to return master include file.

Returns

Include object (or null if include does not exist).

Return type

Include

Example

To get the Include object for include 10 in model m

var i = Include.GetFromID(m, 10);

GetLockedLabelData(rangenum[integer])

Description

Returns the locked label data for include files. Also see the n_locked_range property

Returns

An array containing the include name (string can also be "ALL" if range is applicable model-wide), start (min) label (integer), end (max) label (integer), safe range (0 or 1 for false or true), and entity type (string).

Return type

Number

Example

To get the locked label data for the 3rd range for include i:

if (i.n_locked_range >= 3)
{
    var locked_label_data = i.GetLockedLabelData(2);
}

IsEmpty()

Description

Returns true if include is Empty (contains no INSTALLED static/sort/kid/include items).

Returns

logical

Return type

Boolean

Example

To see if include inc is empty

if(inc.Empty())

Keyword()

Description

Returns the keyword for this include (*INCLUDE, *INCLUDE_TRANSFORM). Note that a carriage return is not added. See also Include.KeywordCards(). This function is not supported for the master include file.

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for include i:

var key = i.Keyword();

KeywordCards()

Description

Returns the keyword cards for the include. Note that a carriage return is not added. See also Include.Keyword(). Also note that this function is not supported for the master include file.

Returns

string containing the cards.

Return type

String

Example

To get the cards for include i:

var cards = i.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last include file in the model.

Returns

Include object (or null if there are no includes in the model).

Return type

Include

Example

To get the last include in model m:

var i = Include.Last(m);

MakeCurrentLayer()

Description

Sets this include file to be the current layer so that any newly created items are put in this include file. Also see the Model.layer property.

Returns

No return value

Example

To make include i the current layer:

i.MakeCurrentLayer();

Modified(listing[boolean])

Description

Returns true if include has been modified.

Returns

logical

Return type

Boolean

Example

To see if include inc is modified

if(inc.Modified(false)) ... (no listing output)

Next()

Description

Returns the next include in the model. Note that this function is not supported for the master include file.

Returns

Include object (or null if there are no more includes in the model).

Return type

Include

Example

To get the include in model m after include i:

var i = i.Next();

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

Description

Allows the user to pick an include.

Returns

Include object (or null if not picked)

Return type

Include

Example

To pick an includee from model m giving the prompt 'Pick include from screen':

var i = Include.Pick('Pick include from screen', m);

Previous()

Description

Returns the previous include in the model. Note that this function is not supported for the master include file.

Returns

Include object (or null if there are no more includes in the model).

Return type

Include

Example

To get the include in model m before include i:

var i = i.Previous();

RemoveLockedLabelData(rangenum[integer])

Description

Removes the locked label data for a range in include files. Also see the n_locked_range property

Returns

No return value.

Example

To remove the locked labels for the 3rd range for include i:

i.RemoveLockedLabelData(2);

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

Description

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

Returns

Number of items selected or null if menu cancelled

Return type

Number

Example

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

Include.Select(f, 'Select include', m);

SetDetailedRange(type argument[string], min label[integer], max label[integer])

Description

Sets detailed min and max label ranges for specified type on the include.

Returns

No return value

Example

To set node ranges for include i:

i.SetDetailedRange("NODE", 50000, 60000);

SetFlag(flag[Flag], flag contents (optional)[boolean])

Description

Sets a flag on the include.

Returns

Number of items flagged

Return type

Number

Example

To set flag f for include i:

i.SetFlag(f);

To set flag f for include i and all of the items inside the include file, returning the number of items flagged in the include file:

var nflagged = i.SetFlag(f, true);

SetLockedLabelData(rangenum[integer], min[integer], max[integer], type[string], safe (optional)[boolean], all_includes (optional)[boolean])

Description

Sets the locked label data for a particular range for an include file. Also see the n_locked_range property

Returns

No return value.

Example

To set the locked label data for the 3rd range with min 99, max 199, for nodes for include i:

i.SetLockedLabelData(3, 99, 199, "NODE");

SetTransformOffset(offset[constant], value[integer], check_only (optional)[boolean])

Description

Sets offset values for include transform. This function is required to change the offset values rather than changing the properties directly so that the include can be checked to ensure that the new value does not cause any label clashes with existing items or any negative labels when the transform is unapplied when writing the include. Note that this function is not supported for the master include file.

Returns

logical, true if change successful. false if the change would cause a clash of labels or negative labels, in which case the value is not changed.

Return type

Boolean

Example

To set idpoff for include i to 1000, checking that the change is successful:

var success = i.SetTransformOffset(Include.IDPOFF, 1000);

Total(Model[Model]) [static]

Description

Returns the total number of include files in the model.

Returns

integer

Return type

Number

Example

To get the number of include files in model m:

var t = Include.Total(m);

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

Description

Unblanks all of the includes in the model.

Returns

No return value

Example

To unblank all of the includes in model m:

Include.UnblankAll(m);

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

Description

Unblanks all of the flagged include files in the model.

Returns

No return value

Example

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

Include.UnblankFlagged(m, f);

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

Description

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

Returns

No return value

Example

To unset the flag f on all of the includes in model m:

Include.UnflagAll(m, f);

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

Description

Adds a warning for an include file. For more details on checking see the Check class. Note that this function is not supported for the master include file.

Returns

No return value

Example

To add a warning message "My custom warning" for include i:

i.Warning("My custom warning");

Write(filename[string], options (optional)[object])

Description

Writes an include file. Note that this function is not supported for the master include file.

Returns

No return value

Example

To Write include i to file /data/test/file.key as a compressed gzip in version R10.0

 var output_obj = new Object();
 output_obj.version = "R10.0";
 output_obj.compress = true;
 output_obj.compressMode = Include.INDIVIDUAL_GZIP;
 i.Write("/data/test/file.key", output_obj);

Write(filename[string], path (optional)[constant], separator (optional)[constant], version (optional)[string], large (optional)[boolean])   [deprecated]

This function is deprecated in version 15.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

Writes an include file. Note that this function is not supported for the master include file.

Returns

No return value

Example

To write include file i to file /data/test/file.key

i.Write("/data/test/file.key");

toString()

Description

Creates a string containing the include data in keyword format. Note that this contains the keyword header and the keyword cards. See also Include.Keyword() and Include.KeywordCards(). Also note that this function is not supported for the master include file.

Returns

string

Return type

String

Example

To get data for include i in keyword format

var s = i.toString();