Attribute Controller

interface ICwAPI3DAttributeController

Public Functions

virtual ICwAPI3DString *getLastError(int32_t *aErrorCode) = 0

Gets the last error.

Parameters:

aErrorCode – [out] [int32_t*] The error code.

Returns:

[ICwAPI3DString*] The error string.

virtual ICwAPI3DString *getName(elementID aElementId) = 0

Gets the element name.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The element name.

virtual void setName(ICwAPI3DElementIDList *aElementIdList, const character *aName) = 0

Sets the element name.

Parameters:
virtual ICwAPI3DString *getGroup(elementID aElementId) = 0

Gets the element group.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The element group.

virtual void setGroup(ICwAPI3DElementIDList *aElementIdList, const character *aGroup) = 0

Sets the element group.

Parameters:
virtual ICwAPI3DString *getSubgroup(elementID aElementId) = 0

Gets the element subgroup.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The element subgroup.

virtual void setSubgroup(ICwAPI3DElementIDList *aElementIdList, const character *aSubgroup) = 0

Sets the element subgroup.

Parameters:
virtual ICwAPI3DString *getComment(elementID aElementId) = 0

Gets the element comment.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The element comment.

virtual void setComment(ICwAPI3DElementIDList *aElementIdList, const character *aComment) = 0

Sets the element comment.

Parameters:
virtual ICwAPI3DString *getUserAttribute(elementID aElementId, uint32_t aNumber) = 0

Gets the element user attribute.

Parameters:

  • aElementId – [in] [elementID] The element id.

  • aNumber – [in] [uint32_t] user attribute number

Returns:

[ICwAPI3DString*] The element user attribute.

virtual void setUserAttribute(ICwAPI3DElementIDList *aElementIdList, uint32_t aNumber, const character *aUserAttribute) = 0

Sets the element user attribute.

Parameters:

  • aElementIdList – [in] [ICwAPI3DElementIDList*] The element id list.

  • aNumber – [in] [uint32_t] The user attribute number.

  • aUserAttribute – [in] [const character*] The element user attribute value.

virtual ICwAPI3DString *getSKU(elementID aElementId) = 0

Gets the element SKU.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The element SKU.

virtual void setSKU(ICwAPI3DElementIDList *aElementIdList, const character *aSKU) = 0

Sets the element SKU.

Parameters:
virtual uint32_t getProductionNumber(elementID aElementId) = 0

Gets the element production number.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[uint32_t] The element production number.

virtual void setProductionNumber(ICwAPI3DElementIDList *aElementIdList, uint32_t aProductionNumber) = 0

Sets the element production number.

Parameters:

  • aElementIdList – [in] [ICwAPI3DElementIDList*] The element id list.

  • aProductionNumber – [in] [uint32_t] The element production number.

virtual uint32_t getPartNumber(elementID aElementId) = 0

Gets the element part number.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[uint32_t] The element part number.

virtual void setPartNumber(ICwAPI3DElementIDList *aElementIdList, uint32_t aPartNumber) = 0

Sets the element part number.

Parameters:

  • aElementIdList – [in] [ICwAPI3DElementIDList*] The element id list.

  • aPartNumber – [in] [uint32_t] The element part number.

virtual ICwAPI3DString *getAdditionalData(elementID aElementId, const character *aDataID) = 0

Gets the element additional data.

Parameters:

  • aElementId – [in] [elementID] The element id.

  • aDataID – [in] [const character*] The data id to retrieve.

Returns:

[ICwAPI3DString*] The element additional data

virtual void setAdditionalData(ICwAPI3DElementIDList *aElementIdList, const character *aDataID, const character *aDataText) = 0

Sets the element additional data.

Parameters:
virtual void deleteAdditionalData(ICwAPI3DElementIDList *aElementIdList, const character *aDataID) = 0

Deletes the element additional data.

Parameters:
virtual ICwAPI3DString *getUserAttributeName(uint32_t aNumber) = 0

Gets the user attribute name.

Parameters:

aNumber – [in] [uint32_t] The user attribute number.

Returns:

[ICwAPI3DString*] The user attribute name.

virtual void setUserAttributeName(uint32_t aNumber, const character *aUserAttributeName) = 0

Sets the user attribute name.

Parameters:

  • aNumber – [in] [uint32_t] The user attribute number.

  • aUserAttributeName – [in] [const character*] The user attribute name.

virtual ICwAPI3DString *getWallSituation(elementID aElementId) = 0

Gets the element wall situation.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The element wall situation.

virtual bool isBeam(elementID aElementId) = 0

Tests if element is beam.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if element is beam, false otherwise.

virtual bool isPanel(elementID aElementId) = 0

Tests if element is panel.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if element is panel, false otherwise.

virtual bool isOpening(elementID aElementId) = 0

Tests if element is opening.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if element is opening, false otherwise.

virtual bool isWall(elementID aElementId) = 0

Tests if element is wall.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if element is wall, false otherwise.

virtual bool isFloor(elementID aElementId) = 0

Tests if element is floor.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if element is floor, false otherwise.

virtual bool isRoof(elementID aElementId) = 0

Tests if element is roof.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if element is roof, false otherwise.

virtual bool isMetal(elementID aElementId) = 0

Tests if element is metal.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if element is metal, false otherwise.

virtual bool isExportSolid(elementID aElementId) = 0

Tests if element is export solid.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if element is export solid, false otherwise.

virtual bool isContainer(elementID aElementId) = 0

Tests if element is container.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if element is container, false otherwise.

virtual bool isConnectorAxis(elementID aElementId) = 0

Tests if element is connector axis.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if element is connector axis, false otherwise.

virtual bool isDrilling(elementID aElementId) = 0

Tests if element is drilling.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if element is drilling, false otherwise.

virtual bool isNode(elementID aElementId) = 0

Tests if element is node.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if element is node, false otherwise.

virtual bool isAuxiliary(elementID aElementId) = 0

Tests if element is auxiliary.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if element is auxiliary, false otherwise.

virtual ICwAPI3DString *getElementMaterialName(elementID aElementId) = 0

Gets the element material name.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The element material name.

virtual ICwAPI3DString *getPrefabLayer(elementID aElementId) = 0

Gets the element prefab layer.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The element prefab layer.

virtual ICwAPI3DString *getMachineCalculationSet(elementID aElementId) = 0

Gets the element machine calculation set.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The element machine calculation set.

virtual ICwAPI3DString *getCuttingSet(elementID aElementId) = 0

Gets the element cutting set.

Parameters:

aElementId – [in] element ID

Returns:

[ICwAPI3DString*] The element cutting set.

virtual void setProcessTypeAndExtendedSettingsFromName(ICwAPI3DElementIDList *aElementIdList) = 0

Sets the element process type and extended settings from the element name.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The element id list.

virtual void setNameProcessType(const character *aName, ICwAPI3DProcessType *aProcessType) = 0

Sets the process type for an element name.

Parameters:
virtual ICwAPI3DProcessType *getNameProcessType(const character *aName) = 0

Gets the process type for an element name.

Parameters:

aName – [in] [const character*] The element name.

Returns:

[ICwAPI3DProcessType*] The process type.

virtual void setNameExtendedSettings(const character *aName, ICwAPI3DExtendedSettings *aExtendedSettings) = 0

Sets the extended settings for an element name.

Parameters:
virtual ICwAPI3DExtendedSettings *getNameExtendedSettings(const character *aName) = 0

Gets the extended settings for an element name.

Parameters:

aName – [in] [const character*] The element name.

Returns:

[ICwAPI3DExtendedSettings*] The extended settings.

virtual ICwAPI3DProcessType *getOutputType(elementID aElementId) = 0

Gets the element output type.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DProcessType*] The element output type.

virtual void setOutputType(ICwAPI3DElementIDList *aElementIdList, ICwAPI3DProcessType *aProcessType) = 0

Sets the element output type.

Parameters:
virtual ICwAPI3DExtendedSettings *getExtendedSettings(elementID aElementId) = 0

Gets the element extended settings.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DExtendedSettings*] The element extended settings.

virtual void setExtendedSettings(ICwAPI3DElementIDList *aElementIdList, ICwAPI3DExtendedSettings *aExtendedSettings) = 0

Sets the element extended settings.

Parameters:
virtual ICwAPI3DElementType *getElementType(elementID aElementId) = 0

Gets the element type.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DElementType*] The element type.

virtual void setWall(ICwAPI3DElementIDList *aElementIdList) = 0

Sets the element to wall.

Deprecated:

Use setFramedWall() instead.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The element id list.

virtual void setFloor(ICwAPI3DElementIDList *aElementIdList) = 0

Sets the element to floor.

Deprecated:

Use setFramedFloor() instead.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The element id list.

virtual void setOpening(ICwAPI3DElementIDList *aElementIdList) = 0

Sets the element to opening.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The element id list.

virtual ICwAPI3DString *getFasteningAttribute(elementID aElementId) = 0

Get the element fastening attribute.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The element fastening attribute.

virtual void setFasteningAttribute(ICwAPI3DElementIDList *aElementIdList, const character *aValue) = 0

Sets the element fastening attribute.

Parameters:
virtual bool isRoofSurface(elementID aElementId) = 0

Tests if the element is roof surface.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a roof surface, false otherwise.

virtual bool isCaddyObject(elementID aElementId) = 0

Tests if the element is caddy object.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a caddy object, false otherwise.

virtual void setElementMaterial(ICwAPI3DElementIDList *aElementIdList, materialID aMaterial) = 0

Sets the element material.

Parameters:
virtual ICwAPI3DString *getAssemblyNumber(elementID aElementId) = 0

Retrieves the assembly number of the given element.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The assembly number of the element.

virtual void setAssemblyNumber(ICwAPI3DElementIDList *aElementIdList, const character *aAssemblyNumber) = 0

Sets the assembly number for a list of elements.

Parameters:
virtual uint32_t getListQuantity(elementID aElementId) = 0

Retrieves the list quantity of the given element.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[uint32_t] The list quantity of the element.

virtual void setListQuantity(ICwAPI3DElementIDList *aElementIdList, uint32_t aListQuantity) = 0

Sets the list quantity for a list of elements.

Parameters:

  • aElementIdList – [in] [ICwAPI3DElementIDList*] The list of element IDs.

  • aListQuantity – [in] [uint32_t] The list quantity to set.

virtual bool isEnvelope(elementID aElementId) = 0

Checks if the given element is an envelope.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is an envelope, false otherwise.

virtual void setLayerSettings(ICwAPI3DElementIDList *aElementIdList, ICwAPI3DLayerSettings *aLayerSettings) = 0

Sets the layer settings for a list of elements.

Parameters:
virtual void setIgnoreInVBACalculation(ICwAPI3DElementIDList *aElementIdList, bool aIgnore) = 0

Sets if the element should be ignored in VBA Calculation.

Parameters:

  • aElementIdList – [in] [ICwAPI3DElementIDList*] The element id list.

  • aIgnore – [in] [bool] True if the element should be ignored in VBA calculation, false otherwise.

virtual bool getIgnoreInVBACalculation(elementID aElement) = 0

Retrieves the VBA calculation ignore status of the given element.

Parameters:

aElement – [in] [elementID] The element id.

Returns:

[bool] True if the element is set to be ignored in VBA calculation, false otherwise.

virtual void clearErrors() = 0

Clears all errors.

virtual bool isArchitectureWall2dc(elementID aElement) = 0

Tests if the element has a 2dc reference wall.

Parameters:

aElement – [in] [elementID] The element id.

Returns:

[bool] True if it’s an architecture wall 2dc, false otherwise.

virtual bool isArchitectureWallXml(elementID aElement) = 0

Tests if the element has a xml reference wall.

Parameters:

aElement – [in] [elementID] The element id.

Returns:

[bool] True if it’s an architecture wall xml, false otherwise.

virtual void setReferenceWall2dc(ICwAPI3DElementIDList *aElementIdList, const character *a2dcFilePath) = 0

Applies a new 2dc reference wall to an element.

Parameters:
virtual bool isSurface(elementID aElementId) = 0

Tests if the element is a Surface.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a Surface, false otherwise.

virtual bool isLine(elementID aElementId) = 0

Tests if the element is a Line.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a Line, false otherwise.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsFor3D() = 0

Retrieves the attribute display settings for 3D.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for 3D.

virtual void setAttributeDisplaySettingsFor3D(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for 3D.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for 3D.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsFor2D() = 0

Retrieves the attribute display settings for 2D.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for 2D.

virtual void setAttributeDisplaySettingsFor2D(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for 2D.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for 2D.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsFor2DWithoutLayout() = 0

Retrieves the attribute display settings for 2D without layout.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for 2D without layout.

virtual void setAttributeDisplaySettingsFor2DWithoutLayout(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for 2D without layout.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for 2D without layout.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsFor2DWithLayout() = 0

Retrieves the attribute display settings for 2D with layout.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for 2D with layout.

virtual void setAttributeDisplaySettingsFor2DWithLayout(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for 2D with layout.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for 2D with layout.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForExportSolid() = 0

Retrieves the attribute display settings for export solid.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for export solid.

virtual void setAttributeDisplaySettingsForExportSolid(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for export solid.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for export solid.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForContainer() = 0

Retrieves the attribute display settings for a container.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a container.

virtual void setAttributeDisplaySettingsForContainer(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a container.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a container.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForMachine() = 0

Retrieves the attribute display settings for a machine.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a machine.

virtual void setAttributeDisplaySettingsForMachine(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a machine.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a machine.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForLogWallBeam() = 0

Retrieves the attribute display settings for a log wall beam.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a log wall beam.

virtual void setAttributeDisplaySettingsForLogWallBeam(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a log wall beam.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a log wall beam.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForLogWallPanel() = 0

Retrieves the attribute display settings for a log wall panel.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a log wall panel.

virtual void setAttributeDisplaySettingsForLogWallPanel(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a log wall panel.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a log wall panel.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForLogWallAxis() = 0

Retrieves the attribute display settings for a log wall axis.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a log wall axis.

virtual void setAttributeDisplaySettingsForLogWallAxis(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a log wall axis.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a log wall axis.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForLogWallOpening() = 0

Retrieves the attribute display settings for a log wall opening.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a log wall opening.

virtual void setAttributeDisplaySettingsForLogWallOpening(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a log wall opening.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a log wall opening.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForFramedWallBeam() = 0

Retrieves the attribute display settings for a framed wall beam.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a framed wall beam.

virtual void setAttributeDisplaySettingsForFramedWallBeam(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a framed wall beam.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a framed wall beam.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForFramedWallPanel() = 0

Retrieves the attribute display settings for a framed wall panel.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a framed wall panel.

virtual void setAttributeDisplaySettingsForFramedWallPanel(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a framed wall panel.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a framed wall panel.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForFramedWallAxis() = 0

Retrieves the attribute display settings for a framed wall axis.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a framed wall axis.

virtual void setAttributeDisplaySettingsForFramedWallAxis(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a framed wall axis.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a framed wall axis.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForFramedWallOpening() = 0

Retrieves the attribute display settings for a framed wall opening.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a framed wall opening.

virtual void setAttributeDisplaySettingsForFramedWallOpening(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a framed wall opening.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a framed wall opening.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForSolidWallBeam() = 0

Retrieves the attribute display settings for a solid wall beam.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a solid wall beam.

virtual void setAttributeDisplaySettingsForSolidWallBeam(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a solid wall beam.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a solid wall beam.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForSolidWallPanel() = 0

Retrieves the attribute display settings for a solid wall panel.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a solid wall panel.

virtual void setAttributeDisplaySettingsForSolidWallPanel(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a solid wall panel.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a solid wall panel.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForSolidWallAxis() = 0

Retrieves the attribute display settings for a solid wall axis.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a solid wall axis.

virtual void setAttributeDisplaySettingsForSolidWallAxis(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a solid wall axis.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a solid wall axis.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForSolidWallOpening() = 0

Retrieves the attribute display settings for a solid wall opening.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a solid wall opening.

virtual void setAttributeDisplaySettingsForSolidWallOpening(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a solid wall opening.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a solid wall opening.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForNestingVolume() = 0

Retrieves the attribute display settings for a nesting volume.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a nesting volume.

virtual void setAttributeDisplaySettingsForNestingVolume(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a nesting volume.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a nesting volume.

virtual ICwAPI3DAttributeDisplaySettings *getAttributeDisplaySettingsForNestingElement() = 0

Retrieves the attribute display settings for a nesting element.

Returns:

[ICwAPI3DAttributeDisplaySettings*] The attribute display settings for a nesting element.

virtual void setAttributeDisplaySettingsForNestingElement(ICwAPI3DAttributeDisplaySettings *aSettings) = 0

Sets the attribute display settings for a nesting element.

Parameters:

aSettings – [in] [ICwAPI3DAttributeDisplaySettings*] The attribute display settings to set for a nesting element.

virtual uint32_t getUserAttributeCount() = 0

Retrieves the count of user attributes.

Returns:

[uint32_t] The count of user attributes.

virtual void setStandardPart(ICwAPI3DElementIDList *aElementIdList) = 0

Sets covers (wall,opening or floor) to standard part.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The elements to set.

virtual void setSolidWall(ICwAPI3DElementIDList *aElementIdList) = 0

Sets elements to solid wall.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The elements to set.

virtual void setLogWall(ICwAPI3DElementIDList *aElementIdList) = 0

Sets elements to log wall.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The elements to set.

virtual void setSolidFloor(ICwAPI3DElementIDList *aElementIdList) = 0

Sets elements to solid floor.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The elements to set.

virtual void setRoof(ICwAPI3DElementIDList *aElementIdList) = 0

Sets elements to roof cover.

Deprecated:

Use setFramedRoof() instead.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The elements to set.

virtual void setSolidRoof(ICwAPI3DElementIDList *aElementIdList) = 0

Sets elements to solid roof cover.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The elements to set.

virtual int32_t getNodeSymbol(elementID aElement) = 0

Retrieves the symbol of the node for the given element.

Parameters:

aElement – [in] [elementID] The element id.

Returns:

[nodeSymbol] The symbol of the node for the element.

virtual void setNodeSymbol(ICwAPI3DElementIDList *aElementIdList, int32_t aSymbol) = 0

Sets the node symbol for a list of elements.

Parameters:
virtual bool isProcessing(elementID aElementId) = 0

Checks if the given element is processing.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is processing, false otherwise.

virtual ICwAPI3DString *getStandardElementName(elementID aElementId) = 0

Retrieves the standard name of the given element.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The standard name of the element.

virtual ICwAPI3DString *getSteelShapeName(elementID aElementId) = 0

Retrieves the name of the steel shape for the given element.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The name of the steel shape for the element.

virtual ICwAPI3DString *getAssociatedNestingNumber(elementID aElementId) = 0

Retrieves the associated nesting number for the given element.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The associated nesting number for the element.

virtual ICwAPI3DString *getAssociatedNestingName(elementID aElementId) = 0

Retrieves the associated nesting name for the given element.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The associated nesting name for the element.

virtual void enableAttributeDisplay() = 0

Enables the attribute display.

virtual void disableAttributeDisplay() = 0

Disables the attribute display.

virtual bool isAttributeDisplayEnabled() = 0

Checks if the attribute display is enabled.

Returns:

[bool] True if the attribute display is enabled, false otherwise.

virtual ICwAPI3DString *getAutoAttribute(elementID aElementId, uint32_t aNumber) = 0

Retrieves the auto attribute of the given element.

Parameters:

  • aElementId – [in] [elementID] The element id.

  • aNumber – [in] [uint32_t] The number of the auto attribute.

Returns:

[ICwAPI3DString*] The auto attribute of the element.

virtual ICwAPI3DString *getAutoAttributeName(uint32_t aNumber) = 0

Retrieves the name of the auto attribute.

Parameters:

aNumber – [in] [uint32_t] The number of the auto attribute.

Returns:

[ICwAPI3DString*] The name of the auto attribute.

virtual void updateAutoAttributes() = 0

Updates the auto attributes.

virtual bool isFramedWall(elementID aElementId) = 0

Checks if the given element is a framed wall.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a framed wall, false otherwise.

virtual bool isSolidWall(elementID aElementId) = 0

Checks if the given element is a solid wall.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a solid wall, false otherwise.

virtual bool isLogWall(elementID aElementId) = 0

Checks if the given element is a log wall.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a log wall, false otherwise.

virtual bool isFramedFloor(elementID aElementId) = 0

Checks if the given element is a framed floor.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a framed floor, false otherwise.

virtual bool isSolidFloor(elementID aElementId) = 0

Checks if the given element is a solid floor.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a solid floor, false otherwise.

virtual bool isFramedRoof(elementID aElementId) = 0

Checks if the given element is a framed roof.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a framed roof, false otherwise.

virtual bool isSolidRoof(elementID aElementId) = 0

Checks if the given element is a solid roof.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a solid roof, false otherwise.

virtual ICwAPI3DString *getAdditionalGuid(elementID aElementId, const character *aDataID) = 0

Retrieves the additional GUID for the given element.

Parameters:

  • aElementId – [in] [elementID] The element id.

  • aDataID – [in] [const character*] The data ID.

Returns:

[ICwAPI3DString*] The additional GUID of the element.

virtual void setAdditionalGuid(ICwAPI3DElementIDList *aElementIdList, const character *aDataID, const character *aGuid) = 0

Sets the additional GUID for a list of elements.

Parameters:
virtual std::vector<int32_t> getPrefabLayerAllAssigned(elementID aElementId) = 0

Retrieves all assigned prefab layer numbers for the given element.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[std::vector<int32_t>] A vector of all assigned prefab layer numbers.

virtual std::vector<int32_t> getPrefabLayerWithDimensions(elementID aElementId) = 0

Retrieves prefab layer numbers with dimensions for the given element.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[std::vector<int32_t>] A vector of prefab layer numbers with dimensions.

virtual std::vector<int32_t> getPrefabLayerWithoutDimensions(elementID aElementId) = 0

Retrieves prefab layer numbers without dimensions for the given element.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[std::vector<int32_t>] A vector of prefab layer numbers without dimensions.

virtual bool isNestingParent(elementID aElementId) = 0

Checks if the given element is a nesting parent.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a nesting parent, false otherwise.

virtual bool isNestingRawPart(elementID aElementId) = 0

Checks if the given element is a raw part of a nesting.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a raw part of a nesting, false otherwise.

virtual ICwAPI3DStringList *getGroupListItems() = 0

Retrieves a list of group items.

Returns:

[ICwAPI3DStringList*] A list of group items.

virtual ICwAPI3DStringList *getSubgroupListItems() = 0

Retrieves a list of subgroup items.

Returns:

[ICwAPI3DStringList*] A list of subgroup items.

virtual ICwAPI3DStringList *getCommentListItems() = 0

Retrieves a list of comment items.

Returns:

[ICwAPI3DStringList*] A list of comment items.

virtual ICwAPI3DStringList *getSkuListItems() = 0

Retrieves a list of SKU items.

Returns:

[ICwAPI3DStringList*] A list of SKU items.

virtual ICwAPI3DStringList *getUserAttributeListItems(uint32_t aNumber) = 0

Retrieves a list of user attribute items.

Parameters:

aNumber – [in] [uint32_t] The number of the user attribute.

Returns:

[ICwAPI3DStringList*] A list of user attribute items.

virtual void addItemToGroupList(const character *aItem) = 0

Adds an item to the group list.

Parameters:

aItem – [in] [const character*] The item to add to the group list.

virtual void addItemToSubgroupList(const character *aItem) = 0

Adds an item to the subgroup list.

Parameters:

aItem – [in] [const character*] The item to add to the subgroup list.

virtual void addItemToCommentList(const character *aItem) = 0

Adds an item to the comment list.

Parameters:

aItem – [in] [const character*] The item to add to the comment list.

virtual void addItemToSkuList(const character *aItem) = 0

Adds an item to the SKU list.

Parameters:

aItem – [in] [const character*] The item to add to the SKU list.

virtual void addItemToUserAttributeList(uint32_t aNumber, const character *aItem) = 0

Adds an item to the user attribute list.

Parameters:

  • aNumber – [in] [uint32_t] The number of the user attribute.

  • aItem – [in] [const character*] The item to add to the user attribute list.

virtual bool isCircularMEP(elementID aElementId) = 0

Checks if the given element is a circular MEP.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a circular MEP, false otherwise.

virtual bool isRectangularMEP(elementID aElementId) = 0

Checks if the given element is a rectangular MEP.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is a rectangular MEP, false otherwise.

virtual bool deleteItemFromGroupList(const character *aItem) = 0

Deletes an item from the group list.

Parameters:

aItem – [in] [const character*] The item to delete from the group list.

Returns:

[bool] True if the item was successfully deleted, false otherwise.

virtual bool deleteItemFromSubgroupList(const character *aItem) = 0

Deletes an item from the subgroup list.

Parameters:

aItem – [in] [const character*] The item to delete from the subgroup list.

Returns:

[bool] True if the item was successfully deleted, false otherwise.

virtual bool deleteItemFromCommentList(const character *aItem) = 0

Deletes an item from the comment list.

Parameters:

aItem – [in] [const character*] The item to delete from the comment list.

Returns:

[bool] True if the item was successfully deleted, false otherwise.

virtual bool deleteItemFromSkuList(const character *aItem) = 0

Deletes an item from the SKU list.

Parameters:

aItem – [in] [const character*] The item to delete from the SKU list.

Returns:

[bool] True if the item was successfully deleted, false otherwise.

virtual bool deleteItemFromUserAttributeList(uint32_t aNumber, const character *aItem) = 0

Deletes an item from the user attribute list.

Parameters:

  • aNumber – [in] [uint32_t] The number of the user attribute.

  • aItem – [in] [const character*] The item to delete from the user attribute list.

Returns:

[bool] True if the item was successfully deleted, false otherwise.

virtual ICwAPI3DStringList *getNameListItems() = 0

Retrieves a list of names for all items.

Returns:

[ICwAPI3DStringList*] A list of names for all items.

virtual void addItemToNameList(const character *aItem) = 0

Adds an item to the name list.

Parameters:

aItem – [in] [const character*] The item to add to the name list.

virtual ICwAPI3DString *getContainerNumberWithPrefix(elementID aElementId) = 0

Retrieves the container number of the given element with a prefix.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The container number of the element with a prefix.

virtual uint32_t getContainerNumber(elementID aElementId) = 0

Retrieves the container number of the given element.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[uint32_t] The container number of the element.

virtual void setContainerNumber(ICwAPI3DElementIDList *aElementIdList, uint32_t aNumber) = 0

Sets the container number for a list of elements.

Parameters:

  • aElementIdList – [in] [ICwAPI3DElementIDList*] The list of element IDs.

  • aNumber – [in] [uint32_t] The container number to set.

virtual ICwAPI3DString *getMachineCalculationState(elementID aElementId) = 0

Retrieves the machine calculation state of the given element.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The machine calculation state of the element.

virtual ICwAPI3DString *getMachineCalculationSetMachineType(elementID aElementId) = 0

Retrieves the machine type used for the machine calculation set of the given element.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[ICwAPI3DString*] The machine type used for the machine calculation set of the element.

virtual bool isBTLProcessingGroup(elementID aElementId) = 0

Checks if the given element is part of a BTL processing group.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is part of a BTL processing group, false otherwise.

virtual bool isHundeggerProcessingGroup(elementID aElementId) = 0

Checks if the given element is part of a Hundegger processing group.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[bool] True if the element is part of a Hundegger processing group, false otherwise.

virtual elementGroupingType getElementGroupingType() = 0

Get the element grouping type (group, subgroup)

Returns:

[elementGroupingType] element grouping type

virtual void setElementGroupingType(const elementGroupingType aType) = 0

Set the element grouping type (group, subgroup).

Parameters:

aType – [in] [const elementGroupingType] The element grouping type to set.

virtual void setFramedWall(ICwAPI3DElementIDList *aElementIdList) = 0

Sets the element to framed wall.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The element id list.

virtual bool deleteUserAttribute(uint32_t aNumber) = 0

Delete user attribute from attribute list. The attribute is only deleted when the attribute is not used.

Parameters:

aNumber – [in] [uint32_t] The attribute number.

Returns:

[bool] True if deletion is successful, false otherwise.

virtual void setFramedFloor(ICwAPI3DElementIDList *aElementIdList) = 0

Sets the elements to framed floor.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The element id list.

virtual void setFramedRoof(ICwAPI3DElementIDList *aElementIdList) = 0

Sets the elements to framed roof.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The element id list.

virtual ICwAPI3DStringList *getNameListItemsByElementType(ICwAPI3DElementType *aType) = 0

Retrieves a list of names for elements of a specific type.

Parameters:

aType – [in] [ICwAPI3DElementType*] The type of elements for which to retrieve the names.

Returns:

[ICwAPI3DStringList*] A list of names for elements of the specified type.

virtual bool isAttributeVisibleInModifyWindow(uint32_t aNumber) = 0

Check if the user-attribute is visible in the modify window.

Parameters:

aNumber – [in] [uint32_t] User attribute number.

Returns:

[bool] True if the user-attribute is visible in the modify window, false otherwise.

virtual void setAttributeVisibilityInModifyWindow(uint32_t aNumber, bool aVisibility) = 0

Sets the visibility state in the modify window for the user-attribute.

Parameters:

  • aNumber – [in] [uint32_t] The user attribute number.

  • aVisibility – [in] [bool] The visibility state to set.

virtual bool setCuttingSet(ICwAPI3DElementIDList *aElementIdList, const character *aCuttingSetName) = 0

Sets the cutting set on the elements. The cutting set is applied with cutElementsWithOvermeasure.

Parameters:
Returns:

[bool] True if the cutting set was successfully applied, false otherwise.

virtual materialID getStandardElementMaterialId(elementID aElementId) = 0

Gets the material id of a given element.

Parameters:

aElementId – [in] [elementID] The element id.

Returns:

[materialID] The id of the element’s material or 0 if no material id could be retrieved.

virtual bool setMachineCalculationSet(ICwAPI3DElementIDList *aElementIdList, const character *aName) = 0

Sets the machine calculation set on the elements.

Example :
ICwAPI3DElementIDList* activeElements = aFactory->getElementController()->getActiveIdentifiableElementIDs();
elementID element = activeElements->at(0);

ICwAPI3DString* currentSet = aFactory->getAttributeController()->getMachineCalculationSet(element);
bool result = aFactory->getAttributeController()->setMachineCalculationSet(activeElements, L"xyz_hundegger K2_BVN");

Note

If multiple sets share the same name, the first matching set is used.

Parameters:
Returns:

[bool] True if the machine calculation set was successfully set, false otherwise.