Spc class

The Spc class gives you access to define spc 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:

_example
$example
ABC_example

Class functions

BlankAll(Model[Model], redraw (optional)[boolean])
BlankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean])
First(Model[Model])
FirstFreeLabel(Model[Model], layer (optional)[Include number])
FlagAll(Model[Model], flag[Flag])
ForEach(Model[Model], func[function], extra (optional)[any])
GetAll(Model[Model], property (optional)[string])
GetFlagged(Model[Model], flag[Flag], property (optional)[string])
GetFromID(Model[Model], number[integer])
Last(Model[Model])
LastFreeLabel(Model[Model], layer (optional)[Include number])
NextFreeLabel(Model[Model], layer (optional)[Include number])
Pick(prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean], button text (optional)[string])
RenumberAll(Model[Model], start[integer])
RenumberFlagged(Model[Model], flag[Flag], start[integer])
Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean])
SketchFlagged(type[integer], Model[Model], flag[Flag])
Total(Model[Model], exists (optional)[boolean])
UnblankAll(Model[Model], redraw (optional)[boolean])
UnblankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean])
UnflagAll(Model[Model], flag[Flag])
UnsketchAll(Model[Model])
UnsketchFlagged(Model[Model], flag[Flag])

Member functions

AssociateComment(Comment[Comment])
Blank()
Blanked()
ClearFlag(flag[Flag])
Copy(range (optional)[boolean])
DetachComment(Comment[Comment])
Error(message[string], details (optional)[string])
Flagged(flag[Flag])
GetComments()
GetParameter(prop[string])
Keyword()
KeywordCards()
Next()
Previous()
SetFlag(flag[Flag])
Sketch(type[constant], redraw (optional)[boolean])
Unblank()
Unsketch(redraw (optional)[boolean])
ViewParameters()
Warning(message[string], details (optional)[string])
Xrefs()
toString()

Spc constants

Constants for sketching mode

Name	Description
Spc.ROTATIONAL	Sketch rotational degrees of freedom.
Spc.TRANSLATIONAL	Sketch translational degrees of freedom.

Constants for suffix

Name	Description
Spc.NODE	SPC is *BOUNDARY_SPC_NODE.
Spc.SET	SPC is *BOUNDARY_SPC_SET.

Spc properties

Name	Type	Description
cid	integer	Coordinate system ID
dofrx	integer	Rotational constraint in local x direction
dofry	integer	Rotational constraint in local y direction
dofrz	integer	Rotational constraint in local z direction
dofx	integer	Translational constraint in local x direction
dofy	integer	Translational constraint in local y direction
dofz	integer	Translational constraint in local z direction
exists (read only)	logical	true if boundary SPC exists, false if referred to but not defined.
heading	string	Spc heading
id	logical	true if _ID option is set, false if not.
include	integer	The Include file number that the boundary SPC is in.
label	integer	Spc number.
model (read only)	integer	The Model number that the boundary SPC is in.
nid	integer	Node ID or node set ID
type	constant	The Spc type. Can be Spc.NODE or Spc.SET.

Properties for _BIRTH_DEATH option

Name	Type	Description
bd_flag	logical	true if _BIRTH_DEATH option is set, false if not
birth	real	Activation time for constraint
death	real	Deactivation time for constraint

Detailed Description

The Spc class allows you to create, modify, edit and manipulate spc cards. See the documentation below for more details.

Constructor

new Spc(Model[Model], nid[integer], cid[integer], dofx[integer], dofy[integer], dofz[integer], dofrx[integer], dofry[integer], dofrz[integer], type[constant], label (optional)[integer], heading (optional)[string])

Description

Create a new Spc object.

Arguments

Model (Model)

Model that spc will be created in

nid (integer)

Node ID or node set ID

cid (integer)

Coordinate system ID

dofx (integer)

Translational constraint in local x direction

dofy (integer)

Translational constraint in local y direction

dofz (integer)

Translational constraint in local z direction

dofrx (integer)

Rotational constraint in local x direction

dofry (integer)

Rotational constraint in local y direction

dofrz (integer)

Rotational constraint in local z direction

type (constant)

Specify the type of boundary spc (Can be Spc.NODE or Spc.SET)

label (optional) (integer)

Spc number

heading (optional) (string)

Title for the spc

Returns

Spc object

Return type

Spc

Example

To create a new boundary spc in model m with label 200, of type SET

var b = new Spc(m, 200, 0, 1, 0, 0, 1, 0, 0, Spc.SET, 200);

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a boundary SPC.

Arguments

Comment (Comment)

Comment that will be attached to the boundary SPC

Returns

No return value

Example

To associate comment c to the boundary SPC s:

s.AssociateComment(c);

Blank()

Description

Blanks the boundary SPC

Arguments

No arguments

Returns

No return value

Example

To blank boundary SPC s:

s.Blank();

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

Description

Blanks all of the boundary SPCs in the model.

Arguments

Model (Model)

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

Spc.BlankAll(m);

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

Description

Blanks all of the flagged boundary SPCs in the model.

Arguments

Model (Model)

Model that all the flagged boundary SPCs will be blanked in

flag (Flag)

Flag set on the boundary SPCs that you want to blank

redraw (optional) (boolean)

Returns

No return value

Example

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

Spc.BlankFlagged(m, f);

Blanked()

Description

Checks if the boundary SPC is blanked or not.

Arguments

No arguments

Returns

true if blanked, false if not.

Return type

Boolean

Example

To check if boundary SPC s is blanked:

if (s.Blanked() ) do_something...

ClearFlag(flag[Flag])

Description

Clears a flag on the boundary SPC.

Arguments

flag (Flag)

Flag to clear on the boundary SPC

Returns

No return value

Example

To clear flag f for boundary SPC s:

s.ClearFlag(f);

Copy(range (optional)[boolean])

Description

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

Spc object

Return type

Spc

Example

To copy boundary SPC s into boundary SPC z:

var z = s.Copy();

DetachComment(Comment[Comment])

Description

Detaches a comment from a boundary SPC.

Arguments

Comment (Comment)

Comment that will be detached from the boundary SPC

Returns

No return value

Example

To detach comment c from the boundary SPC s:

s.DetachComment(c);

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

Description

Adds an error for boundary SPC. 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 SPC s:

s.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first boundary SPC in the model.

Arguments

Model (Model)

Model to get first boundary SPC in

Returns

Spc object (or null if there are no boundary SPCs in the model).

Return type

Spc

Example

To get the first boundary SPC in model m:

var s = Spc.First(m);

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

Description

Returns the first free boundary SPC label in the model. Also see Spc.LastFreeLabel(), Spc.NextFreeLabel() and Model.FirstFreeItemLabel().

Arguments

Model (Model)

Model to get first free boundary SPC 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

Spc label.

Return type

Number

Example

To get the first free boundary SPC label in model m:

var label = Spc.FirstFreeLabel(m);

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

Description

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

Arguments

Model (Model)

Model that all boundary SPCs will be flagged in

flag (Flag)

Flag to set on the boundary SPCs

Returns

No return value

Example

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

Spc.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the boundary SPC is flagged or not.

Arguments

flag (Flag)

Flag to test on the boundary SPC

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if boundary SPC s has flag f set on it:

if (s.Flagged(f) ) do_something...

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

Description

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

Arguments

Model (Model)

Model that all boundary SPCs are in

func (function)

Function to call for each boundary SPC

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

Spc.ForEach(m, test);
function test(s)
{
// s is Spc object
}

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

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

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

Description

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

Arguments

Model (Model)

Model to get boundary SPCs from

property (optional) (string)

Name for property to get for all boundary SPCs in the model

Returns

Array of Spc objects or properties

Return type

Array

Example

To make an array of Spc objects for all of the boundary SPCs in model m:

var a = Spc.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a boundary SPC.

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 SPC s:

var comm_array = s.GetComments();

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

Description

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

Arguments

Model (Model)

Model to get boundary SPCs from

flag (Flag)

Flag set on the boundary SPCs that you want to retrieve

property (optional) (string)

Name for property to get for all flagged boundary SPCs in the model

Returns

Array of Spc objects or properties

Return type

Array

Example

To make an array of Spc objects for all of the boundary SPCs in model m flagged with f:

var s = Spc.GetFlagged(m, f);

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

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

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

Description

Returns the Spc object for a boundary SPC ID.

Arguments

Model (Model)

Model to find the boundary SPC in

number (integer)

number of the boundary SPC you want the Spc object for

Returns

Spc object (or null if boundary SPC does not exist).

Return type

Spc

Example

To get the Spc object for boundary SPC 100 in model m

var s = Spc.GetFromID(m, 100);

GetParameter(prop[string])

Description

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

Arguments

prop (string)

boundary SPC property to get parameter for

Returns

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

Return type

Parameter

Example

To check if Spc property s.example is a parameter:

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

To check if Spc property s.example is a parameter by using the GetParameter method:

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

Keyword()

Description

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

Arguments

No arguments

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for spc s:

var key = s.Keyword();

KeywordCards()

Description

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

Arguments

No arguments

Returns

string containing the cards.

Return type

String

Example

To get the cards for spc s:

var cards = s.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last boundary SPC in the model.

Arguments

Model (Model)

Model to get last boundary SPC in

Returns

Spc object (or null if there are no boundary SPCs in the model).

Return type

Spc

Example

To get the last boundary SPC in model m:

var s = Spc.Last(m);

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

Description

Returns the last free boundary SPC label in the model. Also see Spc.FirstFreeLabel(), Spc.NextFreeLabel() and see Model.LastFreeItemLabel()

Arguments

Model (Model)

Model to get last free boundary SPC 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

Spc label.

Return type

Number

Example

To get the last free boundary SPC label in model m:

var label = Spc.LastFreeLabel(m);

Next()

Description

Returns the next boundary SPC in the model.

Arguments

No arguments

Returns

Spc object (or null if there are no more boundary SPCs in the model).

Return type

Spc

Example

To get the boundary SPC in model m after boundary SPC s:

var s = s.Next();

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

Description

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

Arguments

Model (Model)

Model to get next free boundary SPC 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

Spc label.

Return type

Number

Example

To get the next free boundary SPC label in model m:

var label = Spc.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 SPC.

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

Spc object (or null if not picked)

Return type

Spc

Example

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

var s = Spc.Pick('Pick boundary SPC from screen', m);

Previous()

Description

Returns the previous boundary SPC in the model.

Arguments

No arguments

Returns

Spc object (or null if there are no more boundary SPCs in the model).

Return type

Spc

Example

To get the boundary SPC in model m before boundary SPC s:

var s = s.Previous();

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

Description

Renumbers all of the boundary SPCs in the model.

Arguments

Model (Model)

Model that all boundary SPCs will be renumbered in

start (integer)

Start point for renumbering

Returns

No return value

Example

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

Spc.RenumberAll(m, 1000000);

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

Description

Renumbers all of the flagged boundary SPCs in the model.

Arguments

Model (Model)

Model that all the flagged boundary SPCs will be renumbered in

flag (Flag)

Flag set on the boundary SPCs that you want to renumber

start (integer)

Start point for renumbering

Returns

No return value

Example

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

Spc.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 SPCs using standard PRIMER object menus.

Arguments

flag (Flag)

Flag to use when selecting boundary SPCs

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

Return type

Number

Example

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

Spc.Select(f, 'Select boundary SPCs', m);

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

Spc.Select(f, 'Select boundary SPCs', l);

SetFlag(flag[Flag])

Description

Sets a flag on the boundary SPC.

Arguments

flag (Flag)

Flag to set on the boundary SPC

Returns

No return value

Example

To set flag f for boundary SPC s:

s.SetFlag(f);

Sketch(type[constant], redraw (optional)[boolean])

Description

Sketches the Boundary SPC. The SPC will be sketched until you do a graphics update or delete the model

Arguments

type (constant)

Type of constraints to be drawn. Can be Spc.TRANSLATIONAL or Spc.ROTATIONAL.

redraw (optional) (boolean)

If set to true (or omitted) the plot will be redrawn each time. If sketching a large number of items, efficiency will be gained by setting the argument to false for all but the last item sketched. The final call will redraw.

Returns

No return value

Example

To sketch SPC s - Translational constraint

s1.Sketch(Spc.TRANSLATIONAL, false);
s2.Sketch(Spc.TRANSLATIONAL, false);
s3.Sketch(Spc.TRANSLATIONAL, true);

SketchFlagged(type[integer], Model[Model], flag[Flag]) [static]

Description

Sketches all the flagged boundary SPCs in the model and update the plot. The SPCs will be sketched until you do a graphics update or delete the model.

Arguments

type (integer)

Type of constraints to be drawn. Can be Spc.TRANSLATIONAL or Spc.ROTATIONAL.

Model (Model)

Model that all the flagged boundary SPCs will be sketched in

flag (Flag)

Flag set on the boundary SPCs that you want to sketch

Returns

No return value

Example

To sketch translational SPCs flagged with f in model m and redraw

Spc.SketchFlagged(Spc.TRANSLATIONAL, m, f);

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

Description

Returns the total number of boundary SPCs in the model.

Arguments

Model (Model)

Model to get total for

exists (optional) (boolean)

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

Returns

number of boundary SPCs

Return type

Number

Example

To get the total number of boundary SPCs in model m:

var total = Spc.Total(m);

Unblank()

Description

Unblanks the boundary SPC

Arguments

No arguments

Returns

No return value

Example

To unblank boundary SPC s:

s.Unblank();

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

Description

Unblanks all of the boundary SPCs in the model.

Arguments

Model (Model)

Model that all boundary SPCs will be unblanked in

redraw (optional) (boolean)

Returns

No return value

Example

To unblank all of the boundary SPCs in model m:

Spc.UnblankAll(m);

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

Description

Unblanks all of the flagged boundary SPCs in the model.

Arguments

Model (Model)

Model that the flagged boundary SPCs will be unblanked in

flag (Flag)

Flag set on the boundary SPCs that you want to unblank

redraw (optional) (boolean)

Returns

No return value

Example

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

Spc.UnblankFlagged(m, f);

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

Description

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

Arguments

Model (Model)

Model that the defined flag for all boundary SPCs will be unset in

flag (Flag)

Flag to unset on the boundary SPCs

Returns

No return value

Example

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

Spc.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the Spc.

Arguments

redraw (optional) (boolean)

If set to true (or omitted) the plot will be redrawn each time. If unsketching a large number of items, efficiency will be gained by setting the argument to false for all but the last item unsketched. The final call will redraw.

Returns

No return value

Example

To unsketch SPC s:

s.Unsketch();

UnsketchAll(Model[Model]) [static]

Description

Unsketches all SPCs.

Arguments

Model (Model)

Model that all SPCs will be unblanked in

Returns

No return value

Example

To unsketch all SPCs in model m and redraw:

SPC.UnsketchAll(m);

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

Description

Unsketches all flagged SPCs.

Arguments

Model (Model)

Model that all SPCs will be unsketched in

flag (Flag)

Flag set on the SPCs that you want to unsketch

Returns

No return value

Example

To unsketch all SPCs in model m which are flagged with f and redraw:

SPC.UnsketchFlagged(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.

Arguments

No arguments

Returns

Spc object.

Return type

Spc

Example

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

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

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

Description

Adds a warning for boundary SPC. 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 SPC s:

s.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this boundary SPC.

Arguments

No arguments

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for boundary SPC s:

var xrefs = s.Xrefs();

toString()

Description

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

Arguments

No arguments

Returns

string

Return type

String

Example

To get data for spc s in keyword format

var str = s.toString();