Class BeamGroupAPI
Last update: 16.07.2025Namespace: VM.API.Pre
Assembly: VM.API.Pre.dll
This class implements APIs for beam group.
public static class BeamGroupAPI
Inheritance
Extension Methods
LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)
Methods
CreateBeamGroup(SubSystemDocument, Vector, Vector, Vector, string, CrossSectionType, IEnumerable<ExpressionValueVariable>, ExpressionValueVariable?, Obj?, Color?)
Create
[NotNull(new string[] { "subSystemDocument" })]
[MatchTypeObj(new object[] { "material", typeof(ISO) })]
[NotZeroMagnitude(new string[] { "directionY" })]
public static Obj CreateBeamGroup(this SubSystemDocument subSystemDocument, Vector startPoint, Vector endPoint, Vector directionY, string name = "", CrossSectionType crossSection = CrossSectionType.CIRCULAR, IEnumerable<ExpressionValueVariable> crossSectionValueInfo = null, ExpressionValueVariable? noOfElement = null, Obj? material = null, Color? color = null)
Parameters
subSystemDocument SubSystemDocument
The
startPoint Vector
The start point of a beam group.
endPoint Vector
The end point of a beam group.
directionY Vector
The Y-direction of a beam group.
name string
The name of a beam group.
crossSection CrossSectionType
The cross section of a beam group.
crossSectionValueInfo IEnumerable<ExpressionValueVariable>
The cross section value info of a beam group.
noOfElement ExpressionValueVariable?
The num of element of a beam group.
material Obj?
The material of a beam group.
color Color?
The color of a beam group.
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument' argument is null.
Will be thrown if the magnitude of 'directionY' is 0 and if the type of 'material' is not 'ISO'.
CreateBeamGroup(SubSystemDocument, IEnumerable<Vector>, Vector, string, CrossSectionType, IEnumerable<ExpressionValueVariable>, ExpressionValueVariable?, Obj?, Color?)
Create
[NotNull(new string[] { "subSystemDocument", "positions" })]
[MatchTypeObj(new object[] { "material", typeof(ISO) })]
[NotZeroMagnitude(new string[] { "directionY" })]
public static Obj CreateBeamGroup(this SubSystemDocument subSystemDocument, IEnumerable<Vector> positions, Vector directionY, string name = "", CrossSectionType crossSection = CrossSectionType.CIRCULAR, IEnumerable<ExpressionValueVariable> crossSectionValueInfo = null, ExpressionValueVariable? noOfElement = null, Obj? material = null, Color? color = null)
Parameters
subSystemDocument SubSystemDocument
The
positions IEnumerable<Vector>
The positions of a beam group.
directionY Vector
The Y-direction of a beam group.
name string
The name of a beam group.
crossSection CrossSectionType
The cross section of a beam group.
crossSectionValueInfo IEnumerable<ExpressionValueVariable>
The cross section value info of a beam group.
noOfElement ExpressionValueVariable?
The num of element of a beam group.
material Obj?
The material of a beam group.
color Color?
The color of a beam group.
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument' argument is null.
Will be thrown if the magnitude of 'directionY' is 0 and if the type of 'material' is not ISO.
Will be thrown if the num of 'positions' is less than 2.
CreateBeamGroup(SubSystemDocument, string, string, CrossSectionType, Vector, IEnumerable<ExpressionValueVariable>, ExpressionValueVariable?, Obj?, Color?)
Create
[NotNull(new string[] { "subSystemDocument" })]
[MatchTypeObj(new object[] { "material", typeof(ISO) })]
[ExistFile(new string[] { "filePath" })]
public static Obj CreateBeamGroup(this SubSystemDocument subSystemDocument, string filePath, string name = "", CrossSectionType crossSection = CrossSectionType.CIRCULAR, Vector yDirection = default, IEnumerable<ExpressionValueVariable> crossSectionValueInfo = null, ExpressionValueVariable? noOfElement = null, Obj? material = null, Color? color = null)
Parameters
subSystemDocument SubSystemDocument
The
filePath string
The file path of a beam group.
name string
The name of a beam group.
crossSection CrossSectionType
The cross section of a beam group.
yDirection Vector
The Y Direction.
crossSectionValueInfo IEnumerable<ExpressionValueVariable>
The cross section value info of a beam group.
noOfElement ExpressionValueVariable?
The num of element of a beam group.
material Obj?
The material of a beam group.
color Color?
The color of a beam group.
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument' argument is null.
Will be thrown if the type of 'material' is not 'ISO'.
Will be thrown if 'filePath' file is not exist.
