title	Member

Member

Classes

Member

Functions

setDistributionAtStart()

Support function for section distributions (private), more info can be find there

setDistributionAtEnd()

Support function for section distributions (private), more info can be find there

setResultBeamObjects(member, param1_to_set, param2_to_set, value) ⇒

Sets result beam objects

createBaseMember(no, nodes_or_line, type, section_start, comment, params) ⇒

Creates member (private)

Member

Kind: global class

• Member
  • new Member(no, nodes_or_line, comment, params)
  • .GetNo() ⇒
  • .GetMember() ⇒
  • .Beam(no, nodes_or_line, section_start, comment, params) ⇒
  • .Rigid(no, nodes_or_line, comment, params) ⇒
  • .Truss(no, nodes_or_line, section_start, comment, params) ⇒
  • .TrussOnlyN(no, nodes_or_line, section_start, comment, params) ⇒
  • .Tension(no, nodes_or_line, section_start, comment, params) ⇒
  • .Compression(no, nodes_or_line, section_start, comment, params) ⇒
  • .Buckling(no, nodes_or_line, section_start, comment, params) ⇒
  • .Cable(no, nodes_or_line, section_start, comment, params) ⇒
  • .ResultBeam(no, nodes_or_line, section_start, result_beam_integrate_stresses_and_forces, result_beam_parameters, included_objects, excluded_objects, comment, params) ⇒
  • .DefinableStiffness(no, nodes_or_line, definable_stiffness, comment, params) ⇒
  • .CouplingRigidRigid(no, nodes_or_line, comment, params) ⇒
  • .CouplingRigidHinge(no, nodes_or_line, comment, params) ⇒
  • .CouplingHingeRigid(no, nodes_or_line, comment, params) ⇒
  • .CouplingHingeHinge(no, nodes_or_line, comment, params) ⇒
  • .Rib(nodes_or_line, no, section_start, rib_alignment, surface_assignment_autodetect, align_axes, flange_dimensions, surfaces, comment, params) ⇒
  • .NodesOnMember(values)
  • .Hinges(member_start_hinge, member_end_hinge)
  • .Eccentricities(member_start_eccentricity, member_end_eccentricity)
  • .Supports(member_support)
  • .Nonlinearity(member_nonlinearity)
  • .ResultIntermediatePoints(member_result_intermediate_point)
  • .EndModifications(member_start, member_end)
  • .SectionDistributionUniform()
  • .SectionDistributionLinear(section_start, section_end, section_alignment)
  • .SectionDistributionTaperedAtBothSides(section_start, section_internal, section_end, reference_type, section_distance_from_start, section_distance_from_end, section_alignment)
  • .SectionDistributionTaperedAtStart(section_start, section_end, reference_type, section_distance_from_start, section_alignment)
  • .SectionDistributionTaperedAtEnd(section_start, section_end, reference_type, section_distance_from_end, section_alignment)
  • .SectionDistributionSaddle(section_start, section_internal, section_end, reference_type, section_distance_from_start, section_alignment)
  • .SectionDistributionOffsetAtBothSides(section_start, section_internal, section_end, reference_type, section_offset_from_start, section_offset_from_end, section_alignment)
  • .SectionDistributionOffsetAtStart(section_start, section_end, reference_type, section_offset_from_start, section_alignment)
  • .SectionDistributionOffsetAtEnd(reference_type, section_offset_from_end, section_alignment)

new Member(no, nodes_or_line, comment, params)

Creates member

Returns: Created member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.GetNo() ⇒

Kind: instance method of Member
Returns: Member's number

member.GetMember() ⇒

Kind: instance method of Member
Returns: Member object

member.Beam(no, nodes_or_line, section_start, comment, params) ⇒

Creates beam member

Kind: instance method of Member
Returns: Created member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
section_start	Number	Section start. Section end is same as section start by default. To set section end specify distribution type.
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.Rigid(no, nodes_or_line, comment, params) ⇒

Creates rigid member

Kind: instance method of Member
Returns: Created member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.Truss(no, nodes_or_line, section_start, comment, params) ⇒

Creates truss member

Kind: instance method of Member
Returns: Created member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
section_start	Number	Section start. Section end is same as section start by default. To set section end specify distribution type.
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.TrussOnlyN(no, nodes_or_line, section_start, comment, params) ⇒

Creates truss (only N) member

Kind: instance method of Member
Returns: Created member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
section_start	Number	Section start. Section end is same as section start by default. To set section end specify distribution type.
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.Tension(no, nodes_or_line, section_start, comment, params) ⇒

Creates tension member

Kind: instance method of Member
Returns: Created member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
section_start	Number	Section start. Section end is same as section start by default. To set section end specify distribution type.
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.Compression(no, nodes_or_line, section_start, comment, params) ⇒

Creates compression member

Kind: instance method of Member
Returns: Created member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
section_start	Number	Section start. Section end is same as section start by default. To set section end specify distribution type.
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.Buckling(no, nodes_or_line, section_start, comment, params) ⇒

Creates buckling member

Kind: instance method of Member
Returns: Created member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
section_start	Number	Section start. Section end is same as section start by default. To set section end specify distribution type.
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.Cable(no, nodes_or_line, section_start, comment, params) ⇒

Creates cable member

Kind: instance method of Member
Returns: Created member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
section_start	Number	Section start. Section end is same as section start by default. To set section end specify distribution type.
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.ResultBeam(no, nodes_or_line, section_start, result_beam_integrate_stresses_and_forces, result_beam_parameters, included_objects, excluded_objects, comment, params) ⇒

Create result beam member

Kind: instance method of Member
Returns: Created member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
section_start	Number	Section start. Section end is same as section start by default. To set section end specify distribution type.
result_beam_integrate_stresses_and_forces	String	Stresses and forces type, can be undefined: INTEGRATE_WITHIN_CUBOID_QUADRATIC INTEGRATE_WITHIN_CUBOID_GENERAL INTEGRATE_WITHIN_CYLINDER INTEGRATE_FROM_LISTED_OBJECT
result_beam_parameters	Array	Result beam parameters, can be undefined 1 - [Yz] 2 - [Y+, Y-, Z+, Z-] 3 - [R] 4 - undefined
included_objects	Array	Included surfaces, members and solids, can be undefined ([true, [1, 2], true]: true = all objects, array of indexes = only specified objects)
excluded_objects	Array	Excluded surfaces, members and solids, can be undefined ([undefined, [1, 2], undefined]: array of indexes = only specified objects)
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.DefinableStiffness(no, nodes_or_line, definable_stiffness, comment, params) ⇒

Create definable stiffness member

Kind: instance method of Member
Returns: Created definable stiffness member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
definable_stiffness	Number	Definable stiffness
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.CouplingRigidRigid(no, nodes_or_line, comment, params) ⇒

Create coupling rigid-rigid member

Kind: instance method of Member
Returns: Created coupling rigid-rigid member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.CouplingRigidHinge(no, nodes_or_line, comment, params) ⇒

Create coupling rigid-hinge member

Kind: instance method of Member
Returns: Created coupling rigid-hinge member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.CouplingHingeRigid(no, nodes_or_line, comment, params) ⇒

Create coupling hinge-rigid member

Kind: instance method of Member
Returns: Created coupling hinge-rigid member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.CouplingHingeHinge(no, nodes_or_line, comment, params) ⇒

Create coupling hinge-hinge member

Kind: instance method of Member
Returns: Created coupling hinge-hinge member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined

member.Rib(nodes_or_line, no, section_start, rib_alignment, surface_assignment_autodetect, align_axes, flange_dimensions, surfaces, comment, params) ⇒

Kind: instance method of Member
Returns: object Rib

Param	Type	Description
nodes_or_line	Array/Number	List of node indexes or number of line
no	Number	Index of member, can be undefined
section_start	Number	Section start. Section end is same as section start by default. To set section end specify distribution type.
rib_alignment	String	Alignment of rib - "ALIGNMENT_ON_Z_SIDE_NEGATIVE","ALIGNMENT_CENTRIC","ALIGNMENT_ON_Z_SIDE_POSITIVE","ALIGNMENT_USER_DEFINED_VIA_MEMBER_ECCENTRICITY"
surface_assignment_autodetect	Boolean
align_axes	Boolean
flange_dimensions	Array	two dimensional array each row could have form [end_ordinate,reference_length_definition_type,reference_length_width,width_minus_y_maximal,width_plus_y_maximal,reference_length,width_minus_y_integrative,width_plus_y_integrative]
surfaces	Array
comment	String
params	Object

member.NodesOnMember(values)

Sets nodes on member

Kind: instance method of Member

Param	Type	Description
values	Array	Nodes on member values in format [[node_1, reference_1, from_start_1, from_end1_1] ... [node_n, reference_n, from_start_n, from_end_1]]

member.Hinges(member_start_hinge, member_end_hinge)

Sets member start and/or member end hinges

Kind: instance method of Member

Param	Type	Description
member_start_hinge	Number	Member hinge object id at member start, can be undefined
member_end_hinge	Number	Member hinge object id at member end, can be undefined

member.Eccentricities(member_start_eccentricity, member_end_eccentricity)

Sets member start and/or member end eccentricities

Kind: instance method of Member

Param	Type	Description
member_start_eccentricity	Number	Member eccentricity object id at member start, can be undefined
member_end_eccentricity	Number	Member eccentricity object id at member end, can be undefined

member.Supports(member_support)

Sets member supports

Kind: instance method of Member

Param	Type	Description
member_support	Number	Member supports object id

member.Nonlinearity(member_nonlinearity)

Sets member nonlinearity

Kind: instance method of Member

Param	Type	Description
member_nonlinearity	Number	Member nonlinearity object id

member.ResultIntermediatePoints(member_result_intermediate_point)

Kind: instance method of Member

Param	Type	Description
member_result_intermediate_point	Number	member result intermediate point object id

member.EndModifications(member_start, member_end)

Sets member start and/or member end extensions

Kind: instance method of Member

Param	Type	Description
member_start	Array	Member start values, can be undefined ([Δi, αi,y, αi,z])
member_end	Array	Member end values, can be undefined ([Δj, αj,y, αj,z])

member.SectionDistributionUniform()

Sets uniform section distribution

Kind: instance method of Member

member.SectionDistributionLinear(section_start, section_end, section_alignment)

Sets linear distribution

Kind: instance method of Member

Param	Type	Description
section_start	Number	Number of section at start of member
section_end	Number	Number of section at end of member
section_alignment	String	section_alignment Section alignment (Top, Centric, Bottom), can be undefined (centric as default)

member.SectionDistributionTaperedAtBothSides(section_start, section_internal, section_end, reference_type, section_distance_from_start, section_distance_from_end, section_alignment)

Sets tapered at both sides distribution

Kind: instance method of Member

Param	Type	Description
section_start	Number	Number of section at start of member
section_internal	Number	Number of section at internal point of member (between start and end)
section_end	Number	Number of section at end of member
reference_type	String	Reference type (L, XY, XZ), can be undefined
section_distance_from_start	Array	Member distance ([distance, is_relative]), can be undefined
section_distance_from_end	Array	Member distance ([distance, is_relative]), can be undefined
section_alignment	String	Section alignment (Top, Centric, Bottom), can be undefined (top as default)

member.SectionDistributionTaperedAtStart(section_start, section_end, reference_type, section_distance_from_start, section_alignment)

Sets tapered at start distribution

Kind: instance method of Member

Param	Type	Description
section_start	Number	Number of section at start of member
section_end	Number	Number of section at end of member
reference_type	String	Reference type (L, XY, XZ), can be undefined
section_distance_from_start	Array	Member distance ([distance, is_relative]), can be undefined
section_alignment	String	Section alignment (Top, Centric, Bottom), can be undefined (top as default)

member.SectionDistributionTaperedAtEnd(section_start, section_end, reference_type, section_distance_from_end, section_alignment)

Sets tapered at end distribution

Kind: instance method of Member

Param	Type	Description
section_start	Number	Number of section at start of member
section_end	Number	Number of section at end of member
reference_type	String	Reference type (L, XY, XZ), can be undefined
section_distance_from_end	Array	Member distance ([distance, is_relative]), can be undefined
section_alignment	String	Section alignment (Top, Centric, Bottom), can be undefined (top as default)

member.SectionDistributionSaddle(section_start, section_internal, section_end, reference_type, section_distance_from_start, section_alignment)

Sets saddle distribution

Kind: instance method of Member

Param	Type	Description
section_start	Number	Number of section at start of member
section_internal	Number	Number of section at internal point of member (between start and end)
section_end	Number	Number of section at end of member
reference_type	String	Reference type (L, XY, XZ), can be undefined
section_distance_from_start	Array	Member distance ([distance, is_relative]), can be undefined
section_alignment	String	Section alignment (Top, Centric, Bottom), can be undefined (top as default)

member.SectionDistributionOffsetAtBothSides(section_start, section_internal, section_end, reference_type, section_offset_from_start, section_offset_from_end, section_alignment)

Sets offset at both sides distribution

Kind: instance method of Member

Param	Type	Description
section_start	Number	Number of section at start of member
section_internal	Number	Number of section at internal point of member (between start and end)
section_end	Number	Number of section at end of member
reference_type	String	Reference type (L, XY, XZ), can be undefined
section_offset_from_start	Array	Member offset ([distance, is_relative]), can be undefined
section_offset_from_end	Array	Member offset ([distance, is_relative]), can be undefined
section_alignment	String	Section alignment (Top, Centric, Bottom), can be undefined (top as default)

member.SectionDistributionOffsetAtStart(section_start, section_end, reference_type, section_offset_from_start, section_alignment)

Sets offset at start distribution

Kind: instance method of Member

Param	Type	Description
section_start	Number	Number of section at start of member
section_end	Number	Number of section at end of member
reference_type	String	Reference type (L, XY, XZ), can be undefined
section_offset_from_start	Array	Member offset ([distance, is_relative]), can be undefined
section_alignment	String	Section alignment (Top, Centric, Bottom), can be undefined (top as default)

member.SectionDistributionOffsetAtEnd(reference_type, section_offset_from_end, section_alignment)

Sets offset at end distribution

Kind: instance method of Member

Param	Type	Description
reference_type	String	Reference type (L, XY, XZ), can be undefined
section_offset_from_end	Array	Member offset ([distance, is_relative]), can be undefined
section_alignment	String	Section alignment (Top, Centric, Bottom), can be undefined (top as default)

setDistributionAtStart()

Support function for section distributions (private), more info can be find there

Kind: global function

setDistributionAtEnd()

Support function for section distributions (private), more info can be find there

Kind: global function

setResultBeamObjects(member, param1_to_set, param2_to_set, value) ⇒

Sets result beam objects

Kind: global function
Returns: Modified member

Param	Type	Description
member	Object	Member to be set
param1_to_set	String	Name of parameter for include/exclude "all" objects
param2_to_set	String	Name of parameter for include/exclude object's indexes
value	Boolean/Array	Value can be specified in two formats, as boolean or array with numbers

createBaseMember(no, nodes_or_line, type, section_start, comment, params) ⇒

Creates member (private)

Kind: global function
Returns: Created member

Param	Type	Description
no	Number	Index of member, can be undefined
nodes_or_line	Array/Number	List of node indexes or number of line
type	String	Type of member, can be undefined
section_start	Number	Section start, can be undefined. Section end is same as section start by default. To set section end specify distribution type.
comment	String	Comment, can be undefined
params	Object	Member's parameters, can be undefined