SetNode class

The SetNode class gives you access to node sets in D3PLOT. More...

The D3PLOT 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

First(model[Model])
FlagAll(model[Model], flag[Flag])
GetAll(model[Model], property (optional)[string])
GetFlagged(model[Model], flag[Flag], property (optional)[string])
GetFromID(model[Model], label[integer])
GetFromIndex(model[Model], index[integer])
Last(model[Model])
Total(model[Model])
UnflagAll(model[Model], flag[Flag])

Member functions

AllItems()
ClearFlag(flag[Flag])
Flagged(flag[Flag])
Item(index[integer])
Next()
Previous()
SetFlag(flag[Flag])

SetNode properties

Name	Type	Description
include (read only)	integer	The include file number in the model that the node set is in
index (read only)	integer	The internal index for the node set in D3PLOT (starting at 0)
label (read only)	integer	The Ansys LS-DYNA label for the node set
model (read only)	Model	The Model that the node set is in
title (read only)	string	The title for the node set (or null if no title). This is only available if there is a ztf file for the model. If not null will be returned.
total (read only)	integer	The total number of node items in the node set
type (read only)	constant	The type for the node set (will be Type.SET_NODE)

Detailed Description

The SetNode class allows you to view sets in D3PLOT. There are various methods and properties available. This class requires a ztf file to be present for the model. See the documentation below for more details.

Details of functions

AllItems()

Description

Returns all of the node items for the node set in the model

Arguments

No arguments

Returns

array of Node objects

Return type

Array

Example

To get the node items in node set s:

var items = s.AllItems();

ClearFlag(flag[Flag])

Description

Clears a flag on a node set

Arguments

flag (Flag)

Flag (see AllocateFlag) to clear on the node set

Returns

No return value

Example

To clear flag f on node set s:

s.ClearFlag();

First(model[Model]) [static]

Description

Returns the first node set in the model (or null if there are no node sets in the model)

Arguments

model (Model)

Model to get first node set in

Returns

SetNode object

Return type

SetNode

Example

To get the first node set in model m:

var s = SetNode.First(m);

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

Description

Flags all of the node sets in the model with a defined flag

Arguments

model (Model)

Model that all the node sets will be flagged in

flag (Flag)

Flag (see AllocateFlag) to set on the node sets

Returns

No return value

Example

To flag all of the node sets with flag f in model m:

SetNode.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the node set is flagged or not

Arguments

flag (Flag)

Flag (see AllocateFlag) to test on the node set

Returns

true if flagged, false if not

Return type

boolean

Example

To check if node set s has flag f set on it:

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

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

Description

Returns an array of SetNode objects or properties for all of the node sets in the model. If the optional property argument is not given then an array of SetNode objects is returned. If the property argument is given, that property value for each node set is returned in the array instead of a SetNode object

Arguments

model (Model)

Model that all the node sets are in

property (optional) (string)

Name for property to get for all node sets in the model

Returns

Array of SetNode objects or properties

Return type

Array

Example

To get all of the node sets in model m:

var s = SetNode.GetAll(m);

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

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

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

Description

Gets all of the node sets in the model flagged with a defined flag. If the optional property argument is not given then an array of SetNode objects is returned. If the property argument is given, that property value for each node set is returned in the array instead of a SetNode object

Arguments

model (Model)

Model that the flagged node sets are in

flag (Flag)

Flag (see AllocateFlag) set on the node sets to get

property (optional) (string)

Name for property to get for all flagged node sets in the model

Returns

Array of SetNode objects or properties

Return type

Array

Example

To get all of the node sets flagged with flag f in model m:

SetNode.GetFlagged(m, f);

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

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

GetFromID(model[Model], label[integer]) [static]

Description

Returns the SetNode object for node set in model with label (or null if it does not exist)

Arguments

model (Model)

Model to get node set in

label (integer)

The Ansys LS-DYNA label for the node set in the model

Returns

SetNode object

Return type

SetNode

Example

To get the node set in model m with label 1000:

var s = SetNode.GetFromID(m, 1000);

GetFromIndex(model[Model], index[integer]) [static]

Description

Returns the SetNode object for node set in model with index (or null if it does not exist)

Arguments

model (Model)

Model to get node set in

index (integer)

The D3PLOT internal index in the model for node set, starting at 0.

Returns

SetNode object

Return type

SetNode

Example

To get the 51st node set in model m:

var s = SetNode.GetFromIndex(m, 50);

Item(index[integer])

Description

Returns a node item from the node set in the model

Arguments

index (integer)

The index in the node set to get the node from (0 <= index < total)

Returns

Node object

Return type

Node

Example

To get the 10th node in node set s:

var items = s.Item(9);

Last(model[Model]) [static]

Description

Returns the last node set in the model (or null if there are no node sets in the model)

Arguments

model (Model)

Model to get last node set in

Returns

SetNode object

Return type

SetNode

Example

To get the last node set in model m:

var s = SetNode.Last(m);

Next()

Description

Returns the next node set in the model (or null if there is not one)

Arguments

No arguments

Returns

SetNode object

Return type

SetNode

Example

To get the next node set after node set s:

s = s.Next();

Previous()

Description

Returns the previous node set in the model (or null if there is not one)

Arguments

No arguments

Returns

SetNode object

Return type

SetNode

Example

To get the previous node set before node set s:

s = s.Previous();

SetFlag(flag[Flag])

Description

Sets a flag on a node set

Arguments

flag (Flag)

Flag (see AllocateFlag) to set on the node set

Returns

No return value

Example

To set flag f on node set s:

s.SetFlag(f);

Total(model[Model]) [static]

Description

Returns the total number of node sets in the model

Arguments

model (Model)

Model to get total in

Returns

The number of node sets

Return type

integer

Example

To get the number of node sets in model m:

var total = SetNode.Total(m);

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

Description

Unsets a defined flag on all of the node sets in the model

Arguments

model (Model)

Model that the defined flag for all node sets will be unset in

flag (Flag)

Flag (see AllocateFlag) to unset on the node sets

Returns

No return value

Example

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

SetNode.UnflagAll(m, f);