LoadBody class

The LoadBody class gives you access to *LOAD_BODY 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:

LoadBody properties

Name Type Description
parts Object *LOAD_BODY_PARTS card
rx Object *LOAD_BODY_RX card
ry Object *LOAD_BODY_RY card
rz Object *LOAD_BODY_RZ card
vector Object *LOAD_BODY_VECTOR card
x Object *LOAD_BODY_X card
y Object *LOAD_BODY_Y card
z Object *LOAD_BODY_Z card

Properties for *LOAD_BODY_PARTS

Name Type Description
exists logical true if LoadBody card exists
include integer The Include file number that the LoadBody card is in
psid integer Part set id

Properties for *LOAD_BODY_RX

Name Type Description
cid integer Coordinate system
exists logical true if LoadBody card exists
include integer The Include file number that the LoadBody card is in
lcid integer Load curve ID
lciddr integer Load curve ID for dynamic relaxation
sf real Load curve scale factor
xc real X centre of rotation
yc real Y centre of rotation
zc real Z centre of rotation

Properties for *LOAD_BODY_RY

Name Type Description
cid integer Coordinate system
exists logical true if LoadBody card exists
include integer The Include file number that the LoadBody card is in
lcid integer Load curve ID
lciddr integer Load curve ID for dynamic relaxation
sf real Load curve scale factor
xc real X centre of rotation
yc real Y centre of rotation
zc real Z centre of rotation

Properties for *LOAD_BODY_RZ

Name Type Description
cid integer Coordinate system
exists logical true if LoadBody card exists
include integer The Include file number that the LoadBody card is in
lcid integer Load curve ID
lciddr integer Load curve ID for dynamic relaxation
sf real Load curve scale factor
xc real X centre of rotation
yc real Y centre of rotation
zc real Z centre of rotation

Properties for *LOAD_BODY_VECTOR

Name Type Description
cid integer Coordinate system
exists logical true if LoadBody card exists
include integer The Include file number that the LoadBody card is in
lcid integer Load curve ID
lciddr integer Load curve ID for dynamic relaxation
sf real Load curve scale factor
v1 real X-component of Vector
v2 real Y-component of Vector
v3 real Z-component of Vector
xc real X centre of rotation
yc real Y centre of rotation
zc real Z centre of rotation

Properties for *LOAD_BODY_X

Name Type Description
cid integer Coordinate system
exists logical true if LoadBody card exists
include integer The Include file number that the LoadBody card is in
lcid integer Load curve ID
lciddr integer Load curve ID for dynamic relaxation
sf real Load curve scale factor
xc real X centre of rotation
yc real Y centre of rotation
zc real Z centre of rotation

Properties for *LOAD_BODY_Y

Name Type Description
cid integer Coordinate system
exists logical true if LoadBody card exists
include integer The Include file number that the LoadBody card is in
lcid integer Load curve ID
lciddr integer Load curve ID for dynamic relaxation
sf real Load curve scale factor
xc real X centre of rotation
yc real Y centre of rotation
zc real Z centre of rotation

Properties for *LOAD_BODY_Z

Name Type Description
cid integer Coordinate system
exists logical true if LoadBody card exists
include integer The Include file number that the LoadBody card is in
lcid integer Load curve ID
lciddr integer Load curve ID for dynamic relaxation
sf real Load curve scale factor
xc real X centre of rotation
yc real Y centre of rotation
zc real Z centre of rotation

Detailed Description

The LoadBody class allows you to create, modify, edit and manipulate *LOAD_BODY cards. Unlike other classes there is no constructor and there are no functions. Instead a LoadBody object is available as the loadBody property of a Model object. This object allows you to access all of the *LOAD_BODY cards.
For example, to activate *LOAD_BODY_X in model m and set lcid to 1. 

m.loadBody.x.exists = true;
m.loadBody.x.lcid = 1;

See the properties for more details.