NextFEM API reference

NextFEMapi

API Class

API Methods

activeBarsDiameters Method

activeHoopsDiameters Method

addCircleInSection Method

addCircSection Method

addCSection Method

addCustomTranslations Method

addDCSection Method

addDesignMatFromLib Method

addDesMaterial Method

addDLSection Method

addDrawing Method

addDTSection Method

addEC8spectrum Method

addEdgeLoad Method

addFillInSection Method

addFloorPlane Method

addGroup Method

addHeaderToREST Method

addHoleInSection Method

addIsoMaterial Method

addLayeredPlanarSection Method

addLoadCase Method

addLoadCaseToCombination Method

addLoadCaseToTimeHistoryAnalysis Method

addLongitRebar Method

addLongitRebarInSection Method

addNodalSpring Method

addNode Method

addNodeWithID Method

addNormalhinge Method

addNTCspectrum Method

addNVMhinge Method

addObject Method

addOmegaSection Method

addOrChangeDesMaterialProperty Method

addOrChangeElementFlag Method

addOrChangeLoadCombinationsTable Method

addOrChangeMaterialProperty Method

addOrModifyCustomData Method

addPipeSection Method

addPlanarSection Method

addQuad Method

addQuadWithID Method

addRebarPattern Method

addRebarPatternInSection Method

addRebarRowInSection Method

addRectangleInSection Method

addRectSection Method

addSectFromLib Method

addSectionByPoints Method

addSectionCover Method

addSectionFromDXF Method

addSeriesFunction Method

addSineFunction Method

addSolid Method

addSpring Method

addSpringNLProperty Method

addSpringProperty Method

addSpringsOnOverlappedNodes Method

addSpringWithID Method

addStirrupBars Method

addStirrupBarsInSection Method

addSubsoilNodalSpringsOnElements Method

addSubsoilZProperty Method

addSurfaceLoad Method

addThermalDistLoad Method

addTria Method

addTriaWithID Method

addTruss Method

addTrussWithID Method

addTSection Method

addVolumeLoad Method

alignShellXaxis Method

AnalyzeFireElement Method

appendDocXformula Method

appendDocXimage Method

appendDocXimageB Method

appendDocXtext Method

applyButterworthFilter Method

applyEC8lateralForces Method

areRebarsInsideSection Method

assignHinge Method

assignMaterialToElement Method

assignSectionToElement Method

assignSubsoilProperty Method

assignToGroup Method

changeDefSolverType Method

changeElementProperty Method

changeLoadValue Method

changeOrAddSectionPoint Method

changeSolver Method

changeSpringNLProperty Method

changeSpringNLPropertyDof Method

changeSpringProperty Method

checkConnectivity Method

checkElement Method

checkElementRatio Method

checkElements Method

checkElementsRatio Method

checkElementStation Method

checkFreeNodes Method

checkLineElements Method

checkModel Method

checkNode Method

checkNodes Method

checkOverlappedElements Method

clearElementCustomProperties Method

clearElementRebar Method

clearSectionRebar Method

clearSelection Method

clearStoredDomains Method

convertToMeshedSection Method

convertUnits Method

convertValue Method

convertValueAuto Method

deleteDocXheadingByTitle Method

deleteDocXheadings Method

divideLineByNodes Method

divideQuad Method

divideWedge Method

duplicateSection Method

elementAvailableFlags Method

elementFlagList Method

emptyPlot Method

exportDXF Method

exportElevationGroupToDXF Method

exportGLTF Method

exportGroupToDXF Method

exportIFC Method

exportIOM Method

exportMidas Method

exportOpenSees Method

exportRCbeamsDXF Method

exportRCmemberDXF Method

exportSAF Method

exportSAP2000 Method

exportSectionDXF Method

exportSpreadsheet Method

exportWexBIM Method

exportXMLresults Method

functionFromFile Method

generateFrame Method

generateLoadCombinations Method

getAlignedNodes Method

getAreaByNodes Method

getBC Method

getBeamDeflection Method

getBeamDeflections Method

getBeamForce Method

getBeamForce2 Method

getBeamForces Method

getBeamForcesAtNode Method

getBeamForcesDiagram Method

getBeamForcesEnvelopeTable Method

getBeamResMoments Method

getBeamResShear Method

getBillOfMaterials Method

getBuiltInChecking Method

getCenterOfMass Method

getCheckLogName Method

getCheckNameByMaterial Method

getCombinationCoeffPsi Method

getCombinationDesignType Method

getCombinationsByDesignType Method

getConnectedElements Method

getControlNode Method

getCornerNodes Method

getCustomData Method

getDataPlot Method

getDefinedDesignMaterials Method

getDefinedMaterials Method

getDefinedSections Method

getDesignMaterialProperty Method

getDesignMaterialsLibrary Method

getDesignMaterialsLibraryF Method

getDesMaterialLibNames Method

getDocXheadings Method

getDrawing Method

getDXFentities Method

getElementArea Method

getElementCentroid Method

getElementChecks Method

getElementConnectivity Method

getElementCustomProperty Method

getElementInfo Method

getElementOffset Method

getElementProperty Method

getElementRebarCoords Method

getElementRebarSegments Method

getElementRebarSize Method

getElementsChecks Method

getElementsChecksByMat Method

getElementsFromGroup Method

getElementType Method

getElementVolume Method

getElemIDsByProperty Method

getEndRelease Method

getEnvelopeCombination Method

getExtrudedBeamPoints Method

getFireSectionImage Method

getFirstMode Method

getFloorLoadType Method

getFloorPlanes Method

getForceUnit Method

getFreeElementID Method

getFreeNodeID Method

getFunctionGeneralData Method

getFunctionName Method

getFunctionPlot Method

getFunctions Method

getFunctionUnits Method

getGreekLetter Method

getGroups Method

getHTMLlogCheck Method

getItemDataResults Method

getLanguage Method

getLastBilinearMomentCurvature Method

getLastMomentCurvatureData Method

getLastRunLog Method

getLastSectionRes3DDomainPoints Method

getLastSectionResDomainPoints Method

getLenUnit Method

getLinearAddCombination Method

getLoad Method

getLoadA Method

getLoadcaseFactor Method

getLoadCaseFunction Method

getLoadCases Method

getLoadCaseType Method

getLoadCombinations Method

getLoadCombinationsTable Method

getLoadDurationClass Method

getLoadingData Method

getLoadsForElement Method

getLoadsForNode Method

getLoadsInLoadcase Method

getLocalAxes Method

getLocalAxesArray Method

getMachineData Method

getMacroelement Method

getMacroelements Method

getMaterialLibNames Method

getMaterialProperty Method

getMaterialsLibrary Method

getMaterialsLibraryF Method

getMaxElementID Method

getMaxMinBeamForces Method

getMaxMinNodeDispl Method

getMaxMinWoodArmerMoments Method

getMaxMinWoodArmerMomentsByElem Method

getMaxNodeID Method

getMemberElements Method

getMemberLength Method

getMembers Method

getModalPeriod Method

getModes Method

getMultiplePlots Method

getNodalDisp Method

getNodalReact Method

getNodalShellForce Method

getNodalStress Method

getNodeChecks Method

getNodeCoordinates Method

getNodeInfo Method

getNodePosition Method

getNodeProperty Method

getNodesChecks Method

getNodesFromCoords Method

getNodesFromGroup Method

getNodesOnSides Method

getOSprocedureName Method

getParticipatingMassesRatios Method

getParticipationFactors Method

getReinfPropertiesNTC Method

getResultHistory Method

getRigidDiaphragms Method

getRigidOffsets Method

getSectionColor Method

getSectionCutForce Method

getSectionFigure Method

getSectionImage Method

getSectionLibNames Method

getSectionOffset Method

getSectionProperties Method

getSectionProperty Method

getSectionRebarCoords Method

getSectionRebarSize Method

getSectionResDomainPoints Method

getSectionResMoments Method

getSectionResMoments2 Method

getSectionResMoments3 Method

getSectionResMoments4 Method

getSectionResMomentsOnElem Method

getSectionResShear Method

getSectionResShearDict Method

getSectionShearFRPImage Method

getSectionsLibrary Method

getSectionsLibraryF Method

getSectMomentCurvature Method

getSelfWeight Method

getSeparator Method

getShearResFromDict Method

getShellEndRelease Method

getSoilPressureAtNode Method

getSpringLocalAxes Method

getSpringProperties Method

getStaticLoadCases Method

getStoreyStiffnessTable Method

getSubsoilElements Method

getTimePeriods Method

getWallSection Method

hasResults Method

importAbaqusCalculix Method

importDolmen Method

importDXF Method

importDXFbytes Method

importMidasResults Method

importMidasResultsAPI Method

importMidasResultsText Method

importMidasText Method

importNodeElemFiles Method

importOBJ Method

importOpenSees Method

importOpenSeesRecorder Method

importSAF Method

importSAP2000 Method

importSeismoStruct Method

importSismicad Method

importSismicadSects_Combo Method

importSismicadSects_ComboText Method

importSofistik Method

importStrausResults Method

importStrausResultsText Method

importWinStrand Method

importZeusNL Method

importZeusNLresults Method

LaunchLoadCase Method

LaunchModel Method

listDesignMaterialCustomProperty Method

listMaterialCustomProperty Method

LoadCaseFromCombo Method

materialAvailableFlags Method

mergeImportedLines Method

mergeLines Method

mergeModelData Method

mergeModelResults Method

mergeOverlappedNodes Method

meshAreaTria Method

meshAreaTriaMulti Method

meshQuad2Wall Method

ModelToSection Method

moveNodes Method

newModel Method

openIDEAcodeCheck Method

openModel Method

openModelFromBytes Method

plotElemSectionWithBars Method

plotFireSectionWithBars Method

plotSectionWithBars Method

quad2tria Method

readBeamForces Method

recalculateSection Method

reDo Method

refreshDesignerView Method

refreshHinges Method

removeAllLoads Method

removeAllLoadsForLoadcase Method

removeBC Method

removeCompositeFlags Method

removeCustomData Method

removeDesMaterialProperty Method

removeDrawing Method

removeElement Method

removeElementsFromMember Method

removeFloorLoad Method

removeFloorPlane Method

removeFreeNodes Method

removeHinges Method

removeHingeType Method

removeLink Method

removeLoad Method

removeLoadCase Method

removeLoadCaseFromCombination Method

removeLoadCaseToTimeHistoryAnalysis Method

removeMaterial Method

removeMaterialProperty Method

removeMember Method

removeNodalMass Method

removeNode Method

removeNodeCS Method

removeOverlappedElements Method

removeRigidDiaphragms Method

removeSection Method

removeSectionCover Method

removeSectionFigure Method

removeSectionProperty Method

removeSpringProperty Method

renameSection Method

renumberElements Method

renumberElementsByCoordinates Method

renumberNodes Method

renumberNodesByCoordinates Method

requestDesignerUndo Method

saveDocXtoHTML Method

saveSectionImage Method

saveSectionImageWithBars Method

scaleNodes Method

SectionToModel Method

seriesFromFunction Method

setAluSection Method

setAnalysisSequence Method

setBC Method

setBeamAngle Method

setBucklingAnalysis Method

setCombination Method

setCombinationCoeffPsi Method

setCombinationFactors Method

setCompositeBeam Method

setCompositeColumn Method

setConcretePropertiesNTC Method

setConstraint Method

setElemAsJoint Method

setElementChecks Method

setElementCustomProperty Method

setElementOffset Method

setElementSection Method

setEndRelease Method

setEnvelope Method

setFiberSection Method

setFirePoint Method

setFloorLoad Method

setFunctionGeneralData Method

setLanguage Method

setLoadA Method

setLoadcaseFactor Method

setLoadCasePhaseInCombination Method

setLoadCaseType Method

setLoadDurationClass Method

setLoadsToMass Method

setMacroelement Method

setModalAnalysis Method

setNLDanalysis Method

setNLSanalysis Method

setNodeAsJoint Method

setNodeChecks Method

setNodeCoordinates Method

setNodeCS Method

setNodePosition Method

setPDeltaAnalysis Method

setPlaneStrainElement Method

setPlaneStressElement Method

setQuasiPermanentLoadcase Method

setRebarColorInSection Method

setRebarRotation Method

setRebarRotationInSection Method

setResponseSpectrumAnalysis Method

setRigidDiaphragms Method

setRigidLink Method

setRigidOffsets Method

setSectionAngle Method

setSectionColor Method

setSectionMaterial Method

setSectionOffset Method

setSectionProperty Method

setSectionRebarsToElements Method

setSeismicFloorEccentricity Method

setSeismicLoadcaseForCombos Method

setSelfWeight Method

setSelfWeightDirection Method

setShearReinfRCdata Method

setShearReinfRCelementData Method

setShellEndRelease Method

setSpringLocalAxes Method

setSRSScombination Method

setSteelSection Method

setUnits Method

setWall Method

showViewport Method

splitElementsByRebarSegments Method

startDesigner Method

unDo Method

userCheck Method

valueFromFunction Method

valueFromString Method

vertexFromNode Method

APIgetMacroelement Method

Get the macroelement type assigned to the selected element

REST path: /element/macro/[elemID]

REST verb: GET

Namespace: NextFEMapi
Assembly: NextFEMapi (in NextFEMapi.dll) Version: 2.8.1.1 (2.8.1.1)

Syntax

C++

JavaScript

Copy

public int getMacroelement(
	string elemID
)

Public Function getMacroelement ( 
	elemID As String
) As Integer

Dim instance As API
Dim elemID As String

Dim returnValue As Integer

returnValue = instance.getMacroelement(elemID)

public:
int getMacroelement(
	String^ elemID
)

member getMacroelement : 
        elemID : string -> int

function getMacroelement(elemID);

Parameters

elemID String: Selected element ID

Return Value

Int32
Line=0, Line3=1, Quad1=2, Quad2=3, Quad3=4, masonryWall=5, rigidWall=6, -1 if not assigned

Reference

API Class

NextFEMapi Namespace