User's Guide > Creo Simulate: Items > Beam Orientations
Beam Orientations
 
The functions described in this section provide read and write access to the data and contents of the Creo Simulate beam orientations data structure. Beam orientations use the ProType field in the ProMechitem structure as PRO_SIMULATION_BEAM_ORIENT.
Functions Introduced:
Functions Superseded:
The function ProMechbeamorientDataGet() provides access to the data structure containing the properties of the beam orientation. Use the function ProMechbeamorientDataSet() to set the properties of the beam orientation data. The functions ProMechbeamorientDataGet() and ProMechbeamorientDataSet() have been deprecated. Use the functions ProMechBeamorientIntegerGet() and ProMechBeamorientIntegerSet() instead.
The function ProMechbeamorientDescriptionGet() returns the description of the beam orientation. Use the function ProMechbeamorientDescriptionSet() to set the description of the beam orientation.
The functions ProMechBeamorientExpressionGet/Set, ProMechBeamorientIntegerGet/Set, and ProMechBeamorientVectorGet/Set use the enumerated type ProMechBeamorientPropertyType to define the beam orientation property type.
The values are as follows:
typedef enum
{
PRO_MECH_BEAM_ORIENT_OFFSET_TYPE = 0, /* ProMechBeamOrientType (int) */

PRO_MECH_BEAM_ORIENT_ANGLE = 1, /* ProMechExpression */

PRO_MECH_BEAM_ORIENT_OFFSET = 2 /* ProMechVector (3)
[ Dx Dy Dz ]
*/
}
ProMechBeamorientPropertyType;
The function ProMechBeamorientExpressionGet() gets the value for the defined beam orientation property type. If an expression is defined, the output value is calculated using ProMathExpressionEvaluate(). Use the function ProMechBeamorientExpressionSet() to set the value for the beam orientation property type. For the functions ProMechBeamorientExpressionGet/Set, the only enumerated value allowed is PRO_MECH_BEAM_ORIENT_ANGLE. You can get and set the angle of the beam orientation.
The function ProMechBeamorientIntegerGet() gets the integer of the specified beam orientation property type. Use the function ProMechBeamorientIntegerSet() to set an integer value for the specified beam orientation property type. For the functions ProMechBeamorientIntegerGet/Set, the only enumerated value allowed is PRO_MECH_BEAM_ORIENT_OFFSET_TYPE.
PRO_MECH_BEAM_ORIENT_OFFSET_TYPE returns the handle to ProMechBeamOrientType. You can specify the type of orientation using the enumerated type ProMechBeamOrientType.
The types of orientations are as follows:
PRO_MECH_BEAM_ORIENT_OFFSET_SHAPE_ORIGIN— Specifies the point of origin of the beam shape coordinate system.
PRO_MECH_BEAM_ORIENT_OFFSET_CENTROID— Specifies the origin of the principal coordinate system which is at the centroid of the section. For general sections and all standard sections, it is coincident with PRO_MECH_BEAM_ORIENT_OFFSET_SHAPE_ORIGIN.
PRO_MECH_BEAM_ORIENT_OFFSET_SHEAR_CENTER— Specifies the point on a beam section about which the section rotates under deflection.
The function ProMechBeamorientVectorGet() returns the Creo Simulate vector handle ProMechVector. Use the function ProMechBeamorientVectorSet() to set the handle to ProMechVector. The functions ProMechVectorComponentGet/Set provide read and write access to the individual vector components of the specified beam orientation property type. For more information about handling vector components, see Creo Simulate Vector Functions.
For the functions ProMechBeamorientVectorGet/Set, the only enumerated value allowed is PRO_MECH_BEAM_ORIENT_OFFSET. For example, you can get/set the direction of the beam vector.
The function ProMechBeamorientVectorGet() automatically allocates the memory for the Creo Simulate vector handle. Use the function ProMechVectorFree() to free the memory.
The function ProMechbeamorientdataTypeGet() returns the type of the orientation specified for the Creo Simulate beam orientation item. Use the function ProMechbeamorientdataTypeSet() to set the type of orientation The functions ProMechbeamorientdataTypeGet() and ProMechbeamorientdataTypeSet() have been deprecated. Use the enumerated type ProMechBeamOrientType instead.
The function ProMechbeamorientdataAngleGet() returns the angle of the beam orientation. Use the function ProMechbeamorientdataAngleSet() to set the angle of the beam orientation. The functions ProMechbeamorientdataAngleGet() and ProMechbeamorientdataAngleSet() have been deprecated. Use the functions ProMechBeamorientExpressionGet() and ProMechBeamorientExpressionSet() instead.
The function ProMechbeamorientdataVectorGet() returns the direction of the beam vector. Use the function ProMechbeamorientdataVectorSet() to set the direction of the beam vector. The functions ProMechbeamorientdataVectorGet() and ProMechbeamorientdataVectorSet() have been deprecated. Use the functions ProMechBeamorientVectorGet() and ProMechBeamorientVectorSet() instead.
Use the function ProMechbeamorientdataFree() to free the memory allocated to the beam orientation data structure. The function ProMechbeamorientdataFree() has been deprecated.
Was this helpful?