|
enum class | API_AnalyticalMemberType : UInt16 {
API_AnalyticalMemberType::Unknown
, API_AnalyticalMemberType::Beam
, API_AnalyticalMemberType::Column
, API_AnalyticalMemberType::Roof
,
API_AnalyticalMemberType::Slab
, API_AnalyticalMemberType::Wall
} |
| Describes the Structural Analytical Model Member type. More...
|
|
enum | API_AnalyticalCrossSectionType { API_CrossSection_Rectangle
, API_CrossSection_Circle
, API_CrossSection_Attribute
, API_CrossSection_Custom
} |
| The type of the Structural Analytical Model Cross Section (simple, custom, or predefined). More...
|
|
enum | API_Analytical1DFEMType { API_Analytical1DFEM_Standard
, API_Analytical1DFEM_AxialForceOnly
, API_Analytical1DFEM_CompressionOnly
, API_Analytical1DFEM_TensionOnly
} |
| The FEM type of the curve member. More...
|
|
enum class | API_AnalyticalAlignmentType {
API_AnalyticalAlignmentType::TopLeft
, API_AnalyticalAlignmentType::Top
, API_AnalyticalAlignmentType::TopRight
, API_AnalyticalAlignmentType::Left
,
API_AnalyticalAlignmentType::Center
, API_AnalyticalAlignmentType::Right
, API_AnalyticalAlignmentType::BottomLeft
, API_AnalyticalAlignmentType::Bottom
,
API_AnalyticalAlignmentType::BottomRight
, API_AnalyticalAlignmentType::None
} |
| Describes the alignment of a Cross Section. More...
|
|
enum | API_AnalyticalSurfaceType { API_AnalyticalSurface_PlaneType
, API_AnalyticalSurface_CylinderType
} |
| Describes the Structural Analytical Model Surface type. More...
|
|
enum | API_Analytical2DFEMType { API_Analytical2DFEM_Plate
, API_Analytical2DFEM_Wall
, API_Analytical2DFEM_Shell
} |
| The FEM type of the surface member. More...
|
|
enum | API_AnalyticalLoadCaseActionType { API_AnalyticalLoadCase_PermanentAction
, API_AnalyticalLoadCase_VariableAction
, API_AnalyticalLoadCase_AccidentalAction
} |
| Describes the Structural Analytical Load Case Action type. More...
|
|
enum | API_AnalyticalLoadCaseLoadType {
API_AnalyticalLoadCase_SelfWeightLoad
, API_AnalyticalLoadCase_PrestressLoad
, API_AnalyticalLoadCase_DynamicLoad
, API_AnalyticalLoadCase_StaticLoad
,
API_AnalyticalLoadCase_TemperatureLoad
, API_AnalyticalLoadCase_WindLoad
, API_AnalyticalLoadCase_SnowLoad
, API_AnalyticalLoadCase_MaintenanceLoad
,
API_AnalyticalLoadCase_FireLoad
, API_AnalyticalLoadCase_MovingLoad
, API_AnalyticalLoadCase_SeismicLoad
, API_AnalyticalLoadCase_StandardLoad
,
API_AnalyticalLoadCase_OthersLoad
} |
| Describes the Structural Analytical Load Case Load type. More...
|
|
enum | API_AnalyticalLoadCaseDuration { API_AnalyticalLoadCase_LongDuration
, API_AnalyticalLoadCase_MediumDuration
, API_AnalyticalLoadCase_ShortDuration
, API_AnalyticalLoadCase_InstantaneousDuration
} |
| Describes the Structural Analytical Load Case duration. More...
|
|
enum | API_AnalyticalLoadGroupType {
API_AnalyticalLoadGroup_PermanentLoad
, API_AnalyticalLoadGroup_VariableLoad
, API_AnalyticalLoadGroup_AccidentalLoad
, API_AnalyticalLoadGroup_SeismicLoad
,
API_AnalyticalLoadGroup_MovingLoad
, API_AnalyticalLoadGroup_TensioningLoad
, API_AnalyticalLoadGroup_FireLoad
} |
| Describes the Structural Analytical Load Group type. More...
|
|
enum | API_AnalyticalLoadGroupRelation { API_AnalyticalLoadGroup_ExclusiveRelation
, API_AnalyticalLoadGroup_StandardRelation
, API_AnalyticalLoadGroup_TogetherRelation
} |
| Describes the relation of load cases in the particular load group. More...
|
|
enum | API_AnalyticalLoadCombinationCategory {
API_AnalyticalLoadCombination_ULS
, API_AnalyticalLoadCombination_SLS
, API_AnalyticalLoadCombination_ALS
, API_AnalyticalLoadCombination_ANS
,
API_AnalyticalLoadCombination_NotDefined
} |
| Describes the category of the Structural Analytical Load Combination. More...
|
|
enum | API_AnalyticalLoadCombinationNationalStandard {
API_AnalyticalLoadNationalStandard_ENULSSTRGEOSetB
, API_AnalyticalLoadNationalStandard_ENULSSTRGEOSetC
, API_AnalyticalLoadNationalStandard_ENAccidental1
, API_AnalyticalLoadNationalStandard_ENAccidental2
,
API_AnalyticalLoadNationalStandard_ENSeismic
, API_AnalyticalLoadNationalStandard_ENSLSCharacteristic
, API_AnalyticalLoadNationalStandard_ENSLSFrequent
, API_AnalyticalLoadNationalStandard_ENSLSQuasipermanent
,
API_AnalyticalLoadNationalStandard_IBCLRFDultimate
, API_AnalyticalLoadNationalStandard_IBCASDultimate
, API_AnalyticalLoadNationalStandard_IBCASDserviceability
, API_AnalyticalLoadNationalStandard_IBCASDseismic
,
API_AnalyticalLoadNationalStandard_IBCLRFDseismic
} |
| Describes the National code application of the Structural Analytical Load Combination. More...
|
|
enum class | API_AM_VisibilityMode { API_AM_VisibilityMode::AnalyticalModelOnly
, API_AM_VisibilityMode::AnalyticalModelWithinEntireModel
} |
| Describes the Analytical Model Visiblity Mode. More...
|
|
enum class | API_LoadVisibilityMode { API_LoadVisibilityMode::API_LoadVisibilityMode_FilterByActive
, API_LoadVisibilityMode::API_LoadVisibilityMode_HideAll
, API_LoadVisibilityMode::API_LoadVisibilityMode_ShowAll
} |
| Describes the Load Visiblity Mode. More...
|
|
enum | API_AnalyticalMemberPartRefType : UInt16 {
API_AMPartRef_BegVertex = 1
, API_AMPartRef_BegVertex = 1
, API_AMPartRef_EndVertex = 2
, API_AMPartRef_EndVertex = 2
,
API_AMPartRef_CustomVertex = 3
, API_AMPartRef_CustomVertex = 3
, API_AMPartRef_Edge = 4
, API_AMPartRef_Edge = 4
,
API_AMPartRef_RatioEdge = 5
, API_AMPartRef_RatioEdge = 5
, API_AMPartRef_Surface = 6
, API_AMPartRef_Surface = 6
,
API_AMPartRef_CustomSurface = 7
, API_AMPartRef_CustomSurface = 7
, API_AMPartRef_CustomEdge = 8
, API_AMPartRef_CustomEdge = 8
} |
| Describes the type of the Structural Analytical Model Member Part Ref. More...
|
|
enum | API_AnalyticalCoordSysDirection : UInt16 { API_Global = 1
, API_Global = 1
, API_Local = 2
, API_Local = 2
} |
| Describes the type of the Structural Analytical Model coordinate system. More...
|
|
enum | API_AnalyticalRigidityType : UInt16 {
API_FreeType = 1
, API_FreeType = 1
, API_RigidType = 2
, API_RigidType = 2
,
API_CustomType = 3
, API_CustomType = 3
, API_RigidCompressionOnlyType = 4
, API_RigidCompressionOnlyType = 4
,
API_RigidTensionOnlyType = 5
, API_RigidTensionOnlyType = 5
, API_CustomCompressionOnlyType = 6
, API_CustomCompressionOnlyType = 6
,
API_CustomTensionOnlyType = 7
, API_CustomTensionOnlyType = 7
} |
| Describes the type of the Structural Analytical Model rigidity class type. More...
|
|
enum | API_AnalyticalSupport_SupportType : UInt16 {
API_SimplePoint = 1
, API_SimplePoint = 1
, API_SingleLine = 2
, API_SingleLine = 2
,
API_Surface = 3
, API_Surface = 3
} |
| Describes the type of the Structural Analytical Model Analytical Support type. More...
|
|
enum | API_AnalyticalLink_LinkType : UInt16 { API_Rigid = 1
, API_Rigid = 1
, API_Spring = 2
, API_Spring = 2
} |
| Describes the type of the Structural Analytical Model Analytical Link. More...
|
|
enum | API_AnalyticalLink_LinkGeometry : UInt16 { API_Link1D = 1
, API_Link1D = 1
, API_Link2D = 2
, API_Link2D = 2
} |
| Describes the geometry of the Structural Analytical Model Analytical Link. More...
|
|
enum | API_AnalyticalLink_RigidLinkConnectionType : UInt16 { API_RigidConnection = 1
, API_RigidConnection = 1
, API_HingeConnection = 2
, API_HingeConnection = 2
} |
| Describes the type of the Structural Analytical Model Analytical Rigid Link connection. More...
|
|
enum | API_AnalyticalLoad_LoadDistributionType : UInt16 { API_Uniform = 1
, API_Uniform = 1
, API_Trapezoid = 2
, API_Trapezoid = 2
} |
| Describes the distribution type of the Structural Analytical Edge Load. The load may be either constant along the 1D member or linearly variable (trapezoidal). More...
|
|
|
GSErrCode | ACAPI_Analytical_GetCurrentAnalyticalModel (API_Guid &amGuid) |
| Returns the Structural Analytical Model created for the current view.
|
|
GSErrCode | ACAPI_Analytical_UpdateAnalyticalModel (const API_Guid &amGuid) |
| Triggers an update of the Structural Analytical Model specified.
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalModelVariation (const API_Guid &amGuid, API_AnalyticalModelVariation &api_modelVariation) |
| Returns the Model Variation used for creating the specified Structural Analytical Model.
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalModel (const API_AnalyticalModelVariation &api_modelVariation, API_Guid &amGuid) |
| Returns the Structural Analytical Model created for the specified Model Variation.
|
|
GSErrCode | ACAPI_Analytical_SetGenerationSettingsToNoRule () |
| Sets the current analytical model's generation settings to no rules.
|
|
GSErrCode | ACAPI_Analytical_GetVisibilitySettings (API_AM_VisibilitySettings &api_am_visiblitySettings) |
| Returns the Visibility Settings of the analytical model.
|
|
GSErrCode | ACAPI_Analytical_SetVisibilitySettings (const API_AM_VisibilitySettings &api_am_visiblitySettings) |
| Sets the Visibility Settings of the analytical model.
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalRelease (const API_Guid &amGuid, const API_Guid &elemGuid, API_AnalyticalReleaseType &api_analyticalRelease) |
| Returns the Structural Analytical Model Member Relase associated with the selected Curve Element.
|
|
GSErrCode | ACAPI_Analytical_SetAnalyticalRelease (const API_Guid &elemGuid, const API_AnalyticalReleaseType &api_analyticalRelease) |
| Sets the Structural Analytical Model Member Release to the selected Curve Element.
|
|
GSErrCode | ACAPI_Analytical_GetCurveElements (const API_Guid &amGuid, GS::Array< API_Guid > &curveElements) |
| Returns the elements that have Structural Analytical Model Curve Member associated.
|
|
GSErrCode | ACAPI_Analytical_GetCurveMember (const API_Guid &amGuid, const API_Guid &elemGuid, API_AnalyticalCurveMember &cm) |
| Returns the Structural Analytical Model Curve Member associated with the selected Curve Element.
|
|
GSErrCode | ACAPI_Analytical_GetCustomCurveMemberStretchValues (const API_Guid &elemGuid, double &begAdditionalLength, double &endAdditionalLength) |
| Returns the stretch/cutback values of the Structural Analytical Model Curve Member of a Curve Element.
|
|
GSErrCode | ACAPI_Analytical_SetCustomCurveMember (const API_Guid &elemGuid, double begAdditionalLength, double endAdditionalLength) |
| Provides possibility to stretch/cutback the Structural Analytical Model Curve Member of a Curve Element.
|
|
GSErrCode | ACAPI_Analytical_GetSurfaceElements (const API_Guid &amGuid, GS::Array< API_Guid > &surfaceElements) |
| Returns the elements that have Structural Analytical Model Surface Member associated.
|
|
GSErrCode | ACAPI_Analytical_GetSurfaceMember (const API_Guid &amGuid, const API_Guid &elemGuid, API_AnalyticalSurfaceMember &surfaceMember, API_ExportIdMappingType &idMapping) |
| Returns the Structural Analytical Model Surface Member associated with the selected Surface Element.
|
|
GSErrCode | ACAPI_Analytical_GetSegmentedSurfaceMember (const API_Guid &amGuid, const API_Guid &elemGuid, GS::Array< API_AnalyticalSurfaceMember > &surfaceMember, double centralAngle, API_ExportIdMappingType &surfaceIdMapping) |
| Returns the Structural Analytical Model Surface Member segmented version associated with the selected Surface Element.
|
|
GSErrCode | ACAPI_Analytical_CreateElementFromCurveMember (API_AnalyticalCurveMember &api_curveMember, const GS::Optional< GS::UniString > &favoriteName) |
| Creates an element from the Structural Analytical Model Curve Member.
|
|
GSErrCode | ACAPI_Analytical_CreateElementFromSurfaceMember (API_AnalyticalSurfaceMember &api_surfaceMember, const GS::Optional< GS::UniString > &favoriteName, API_ImportIdMappingType *idMapping) |
| Creates an element from the Structural Analytical Model Surface Member.
|
|
GSErrCode | ACAPI_Analytical_CreateElementFromSegmentedSurfaceMember (GS::Array< API_AnalyticalSurfaceMember > &api_surfaceMember, const GS::Optional< GS::UniString > &favoriteName, API_ImportIdMappingType *idMapping) |
| Creates an element from the Structural Analytical Model Surface Member segments.
|
|
GSErrCode | ACAPI_Analytical_GetLCSOfAnalyticalMember (const API_AnalyticalMemberPartRef &analyticalMemberPartRef, API_CoordinateSystem &coordinateSystem) |
| Get the local coordinate system of a member from AnalyticalMemberPartRef.
|
|
GSErrCode | ACAPI_Analytical_GetLCSOfAnalyticalMemberInIntersection (const API_AnalyticalMemberPartRef &firstAnalyticalMemberPartRef, const API_AnalyticalMemberPartRef &secondAnalyticalMemberPartRef, API_CoordinateSystem &coordinateSystem) |
| Get the local coordinate system of a member in intersection of AnalyticalMemberPartRefs.
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalMemberConnections (const API_Guid &amGuid, const API_Guid &elemGuid, GS::HashSet< API_Guid > &api_connections) |
| Returns the guids of elements which are connected to a Structural Analytical Member, given by it's guid. Includes elements which are connected by Structural Analytical Links.
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalMemberPartRefCoord (const API_Guid &amGuid, const API_AnalyticalMemberPartRef &api_memberPartRef, API_AnalyticalNode &api_analyticalNode) |
| Returns the coord of the given Structural Analytical Model's Analytical Member part if it identifies an edge.
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalMemberPartRefCurve (const API_Guid &amGuid, const API_AnalyticalMemberPartRef &api_memberPartRef, API_AnalyticalCurve &api_analyticalCurve) |
| Returns the curve of the given Structural Analytical Model's Analytical Member part if it identifies a vertex.
|
|
GSErrCode | ACAPI_Analytical_GetComplementaryProjectMemberType (const API_Guid &elemGuid, API_AnalyticalMemberType &analyticalMemberType) |
| Returns the Analytical Member Type of a certain element from the Complementary Project.
|
|
GSErrCode | ACAPI_Analytical_SetElementFromLink (const API_AnalyticalLinkType &link, API_Element &element) |
| Sets element.type to API_AnalyticalLinkID , and element.externalElemData to link .
|
|
GSErrCode | ACAPI_Analytical_GetLinkFromElement (const API_Element &element, API_AnalyticalLinkType &link) |
| Obtains the API_AnalyticalLinkType from.
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalLinkGeometry (const API_Guid &amGuid, const API_Guid &elemGuid, API_AnalyticalLinkGeometry &api_analyticalLinkGeometry) |
| Returns the Structural Analytical Link Geometry.
|
|
GSErrCode | ACAPI_Analytical_ConvertAnalyticalLinkToNonShortest (const API_Guid &amGuid, const API_Guid &elemGuid, API_AnalyticalLinkType &api_analyticalLink) |
| Converts an Analytical Link that is associative to a Curve Member or an edge of a Surface Member (known as a "shortest" Analytical Link) to an Analytical Link that is connected to a fixed coordinate.
|
|
GSErrCode | ACAPI_Analytical_SetElementFromSupport (const API_AnalyticalSupportType &support, API_Element &element) |
| Sets element.type to API_AnalyticalSupportID , and element.externalElemData to support .
|
|
GSErrCode | ACAPI_Analytical_GetSupportFromElement (const API_Element &element, API_AnalyticalSupportType &support) |
| Obtains the API_AnalyticalSupportType from element , if it is a valid API_AnalyticalSupportType .
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalSupportGeometry (const API_Guid &amGuid, const API_Guid &elemGuid, API_AnalyticalSupportGeometry &api_analyticalSupportGeometry) |
| Returns the Structural AnalyticalSupport Geometry.
|
|
GSErrCode | ACAPI_Analytical_SetElementFromPointLoad (const API_AnalyticalPointLoadType &pointLoad, API_Element &element) |
| Sets element.type to API_AnalyticalPointLoadID , and element.externalElemData to pointLoad .
|
|
GSErrCode | ACAPI_Analytical_GetPointLoadFromElement (const API_Element &element, API_AnalyticalPointLoadType &pointLoad) |
| Obtains the API_AnalyticalPointLoadType from element , if it is a valid API_AnalyticalPointLoadType .
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalPointLoadGeometry (const API_Guid &amGuid, const API_Guid &elemGuid, API_AnalyticalPointLoadGeometry &api_analyticalPointLoadGeometry) |
| Returns the Structural Analytical Point Load Geometry.
|
|
GSErrCode | ACAPI_Analytical_SetElementFromEdgeLoad (const API_AnalyticalEdgeLoadType &edgeLoad, API_Element &element) |
| Sets element.type to API_AnalyticalEdgeLoadID , and element.externalElemData to edgeLoad .
|
|
GSErrCode | ACAPI_Analytical_GetEdgeLoadFromElement (const API_Element &element, API_AnalyticalEdgeLoadType &edgeLoad) |
| Obtains the API_AnalyticalEdgeLoadType from element , if it is a valid API_AnalyticalEdgeLoadType .
|
|
GSErrCode | ACAPI_Analytical_GetEdgeLoadGeometry (const API_Guid &amGuid, const API_Guid &elemGuid, API_EdgeLoadCustomData &edgeLoadCustomData) |
| Returns the Structural Analytical Model's Analytical Edge Load Geometry.
|
|
GSErrCode | ACAPI_Analytical_SetMemoFromEdgeLoadCustomData (const API_EdgeLoadCustomData &edgeLoadCustomData, API_ElementMemo &memo) |
| Set Structural Analytical Model's Analytical Edge Load Geometry in the given memo.
|
|
GSErrCode | ACAPI_Analytical_SetEdgeLoadCustomDataFromMemo (const API_ElementMemo &memo, API_EdgeLoadCustomData &edgeLoadCustomData) |
| Get Structural Analytical Model's Analytical Edge Load Geometry from the given memo.
|
|
GSErrCode | ACAPI_Analytical_SetElementFromSurfaceLoad (const API_AnalyticalSurfaceLoadType &surfaceLoad, API_Element &element) |
| Sets element.type to API_AnalyticalSurfaceLoadID , and element.externalElemData to surfaceLoad .
|
|
GSErrCode | ACAPI_Analytical_GetSurfaceLoadFromElement (const API_Element &element, API_AnalyticalSurfaceLoadType &surfaceLoad) |
| Obtains the API_AnalyticalSurfaceLoadType from element , if it is a valid API_AnalyticalSurfaceLoadType .
|
|
GSErrCode | ACAPI_Analytical_GetSurfaceLoadGeometry (const API_Guid &amGuid, const API_Guid &elemGuid, API_SurfaceLoadCustomData &edgeLoadCustomData) |
| Returns the Structural Analytical Model's Custom Surface Coordinates for Surface Load.
|
|
GSErrCode | ACAPI_Analytical_SetMemoFromSurfaceLoadCustomData (const API_SurfaceLoadCustomData &customData, API_ElementMemo &memo) |
| Set Structural Analytical Model's Custom Surface Coordinates for Surface Load in the given memo.
|
|
GSErrCode | ACAPI_Analytical_SetSurfaceLoadCustomDataFromMemo (const API_ElementMemo &memo, API_SurfaceLoadCustomData &customData) |
| Get Structural Analytical Model's Custom Surface Coordinates for Surface Load from the given memo.
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalLoadGroups (GS::Array< API_Guid > &analyticalLoadGroups) |
| Returns an array of unique identifiers of the existing Load Groups.
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalLoadGroup (const API_Guid &analyticalLoadGroupGuid, API_AnalyticalLoadGroup &analyticalLoadGroup) |
| Returns the Load Group with the given unique identifier.
|
|
GSErrCode | ACAPI_Analytical_CreateAnalyticalLoadGroup (API_AnalyticalLoadGroup &analyticalLoadGroup) |
| Creates an Analytical Load Group.
|
|
GSErrCode | ACAPI_Analytical_DeleteAnalyticalLoadGroup (const API_Guid &analyticalLoadGroupGuid) |
| Deletes an Analytical Load Group.
|
|
GSErrCode | ACAPI_Analytical_GetAllAnalyticalLoadCases (GS::Array< API_Guid > &analyticalLoadCases) |
| Returns an array of unique identifiers of all the existing Load Cases from every Load Group.
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalLoadCases (const API_Guid &analyticalLoadGroupGuid, GS::Array< API_Guid > &analyticalLoadCases) |
| Returns an array of unique identifiers of the existing Load Cases from a Load Group.
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalLoadCase (const API_Guid &analyticalLoadCaseGuid, API_AnalyticalLoadCase &analyticalLoadCase) |
| Returns the Load Case with the given unique identifier.
|
|
GSErrCode | ACAPI_Analytical_CreateAnalyticalLoadCase (API_AnalyticalLoadCase &analyticalLoadCase) |
| Creates an Analytical Load Group.
|
|
GSErrCode | ACAPI_Analytical_DeleteAnalyticalLoadCase (const API_Guid &analyticalLoadCaseGuid) |
| Deletes an Analytical Load Group.
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalLoadCombinations (GS::Array< API_Guid > &analyticalLoadCombinations) |
| Returns an array of unique identifiers of the existing Load Combinations.
|
|
GSErrCode | ACAPI_Analytical_GetAnalyticalLoadCombination (const API_Guid &analyticalLoadCombinationGuid, API_AnalyticalLoadCombination &analyticalLoadCombination) |
| Returns the Load Combination with the given unique identifier.
|
|
GSErrCode | ACAPI_Analytical_CreateAnalyticalLoadCombination (API_AnalyticalLoadCombination &analyticalLoadCombination) |
| Creates an Analytical Load Combination.
|
|
GSErrCode | ACAPI_Analytical_AddLoadCaseToLoadCombination (const API_AnalyticalLoadFactor &loadFactor, const API_Guid &analyticalLoadCombinationGuid) |
| Adds a Load Case (with its adherent coefficients) to a Load Combination identified with guid.
|
|
GSErrCode | ACAPI_Analytical_DeleteAnalyticalLoadCombination (const API_Guid &analyticalLoadCombinationGuid) |
| Deletes an Analytical Load Combination.
|
|
GSErrCode | ACAPI_Analytical_GetModelCheckTypeId (API_Guid &typeId) |
| Returns the unique identifier of the Structural Analytical Model Check Type.
|
|
Functions related to the Analytical Model.
Archicad generates an Analytical Model for the cores of all load-bearing elements. The generation depends on the 3D model of the cores and the Analytical Model generation rules. The 3D models of the cores of the physical elements are checked to see if they are connected.
The 3D connection is governed by the renovation filter and the layer connection class IDs, where it can be customized which layers should interact with each other. The special layer connection class ID of 0 means that the elements shouldn't interact with any other element.
The Analytical Model Generation Rules can be customized to fit the plan's needs. These rules are part of the plan database, so it can be saved with the plan and it is common for all users joined in the same Teamwork project. The rules can also be saved as part of a template.
In Archicad the Analytical Model generation is done only when it is needed (e.g. when it is visible in the active view). To ensure that the latest data is available from an Analytical Model it can be updated using the ACAPI_Analytical_UpdateAnalyticalModel function.
As the Analytical Model is generated, there is no way on the API to directly create analytical members, since even in Archicad the members are calculated and can't exist on their own. A physical element can be created based on a specified analytical member. The element will be created without any generation rules or connection to another element, the analytical member generated from this element should be identical to the specified one. However this can't be guaranteed because it might be affected by the connections or the rules.
The API provides methods to create elements based on curve or surface members. The actual physical element's type will be decided by Archicad based on the limitations of the tools and tries to match with the most likely uses.
The following functions can be used to create elements based on analytical members:
The analytical members may connect to each other. This is visualized in Archicad by having green nodes where the two members connect. By default such connections are set to be fully rigid. The behaviour of an element's member when connected to another member can be customized via the release properties of the element. The structure API_AnalyticalReleaseType can be used to describe the release properties.
An element's release properties are valid even if no other member is connected to it. There is even a special generation setting that can automatically reset release properties to rigid where there is no connection to another member.
An Analytical Release is always defined for a specific part of an element that is described by the API_AnalyticalMemberPartRef structure.
When two members are not connected after applying the generation rules, but they should be connected in the Structural Analytical Model it is possible to use a tool called Analytical Link to connect them in Archicad.
An Analytical Link can be one-dimensional or a surface. A specific case of the one-dimensional link is the so-called "zero-length" link, this means the two members it connects have an intersection and the link is connected to this point on both members.
Either end of the link can be connected to a vertex of a curve or surface member, a curve member, the edge of a surface member, the face of a surface member or a specific non-predefined point of any member.
The links being connected to the members means that if the geometry or position of the members changes then so will that of the link(s) connecting them.
The Analytical Support represents the connection of the Structural Analytical Model to the outside world. A support can be placed on a vertex of a curve or surface member, on the edge of a surface member, along the line of a curve member or on the face of a surface member.