Archicad 29 C++ API
Loading...
Searching...
No Matches
MEP Element Manager

Functions related to the creation, manipulation and management of MEP (Mechanical, Electrical, Plumbing) elements. More...

Classes

class  ACAPI::MEP::Accessory
 The Accessory is a complex element with two ports on a single axis. More...
 
class  ACAPI::MEP::Accessory::Modifier
 Modifier of the Accessory. More...
 
class  ACAPI::MEP::AccessoryDefault
 The AccessoryDefault contains the necessary non-geometric data for creating an Accessory element. More...
 
class  ACAPI::MEP::AccessoryUIManager
 The AccessoryUIManager contains UI-related services for an Accessory. More...
 
class  ACAPI::MEP::Adapter::UniqueID
 It is a helper class that converts a simple GS::Guid or API_Guid into an MEP::UniqueID. More...
 
class  ACAPI::MEP::AngleSetBase
 The AngleSetBase represents a named table, and it contains angles which are used as keys in the PreferenceTables. By default, Archicad will provide you the Angle angleSet, but you can choose your own by renaming it and populate it with your desired values. More...
 
class  ACAPI::MEP::AngleSetBase::Modifier
 Modifier of the AngleSetBase. More...
 
class  ACAPI::MEP::Branch
 A branch is a specific type of fitting that acts as an outlet from a large pipe to a smaller pipe or one of equal size. More...
 
class  ACAPI::MEP::Branch::Modifier
 Modifier of the Branch. More...
 
class  ACAPI::MEP::BranchDefault
 
class  ACAPI::MEP::BranchUIManager
 The BranchUIManager contains UI-related services for a Branch. More...
 
class  ACAPI::MEP::CableCarrierPort
 The CableCarrierPort represents a connection point of a cable carrier. More...
 
class  ACAPI::MEP::CableCarrierPortDefault
 Through this CableCarrierPortDefault you can access and configure the CableCarrierPorts of MEPElementDefaults before placement. More...
 
class  ACAPI::MEP::CableCarrierPortDefault::Modifier
 Modifier of the CableCarrierPortDefault. More...
 
class  ACAPI::MEP::CableCarrierSegmentPreferenceTable
 The CableCarrierSegmentPreferenceTable represents a named entity, that contains rows that consists of a size and a description. The rows have to be unique by value and are always in ascending order. More...
 
class  ACAPI::MEP::CableCarrierSegmentPreferenceTable::Modifier
 Modifier of the CableCarrierSegmentPreferenceTable. More...
 
class  ACAPI::MEP::CableCarrierSegmentPreferenceTableContainer
 The CableCarrierSegmentPreferenceTableContainer can contain several PreferenceTableBase associated with cable carriers. More...
 
class  ACAPI::MEP::DistributionSystem
 A helper object representing a "distribution system", which is a set of connected MEP elements sharing the same system category index and MEP domain. (E.g. "hot water pipes" or "cold air ducts") More...
 
class  ACAPI::MEP::DistributionSystemsGraph
 A graph data structure to display MEP distribution systems data. More...
 
class  ACAPI::MEP::DistributionSystemsGraphTreeNode
 A structural helper class used when iterating through a DistributionSystem in the DistributionSystemsGraph as a tree. More...
 
class  ACAPI::MEP::DuctAngleSet
 The DuctAngleSet contains angles that are used in DuctElbowPreferenceTable and DuctBranchPreferenceTable. More...
 
class  ACAPI::MEP::DuctBranchPreferenceTable
 The DuctBranchPreferenceTable contains cross section and geometry related information for Duct branches. More...
 
struct  ACAPI::MEP::DuctBranchPreferenceTable::Key
 The key that uniquely identifies a row in the DuctBranchPreferenceTable. More...
 
class  ACAPI::MEP::DuctBranchPreferenceTable::Modifier
 Modifier of the DuctBranchPreferenceTable. More...
 
class  ACAPI::MEP::DuctBranchPreferenceTableContainer
 The DuctBranchPreferenceTableContainer can contain several DuctBranchPreferenceTables. More...
 
class  ACAPI::MEP::DuctCircularSegmentPreferenceTable
 The DuctCircularSegmentPreferenceTable contains cross section related information for Circular Duct routing segments. More...
 
class  ACAPI::MEP::DuctCircularSegmentPreferenceTable::Modifier
 Modifier of the DuctCircularSegmentPreferenceTable. More...
 
class  ACAPI::MEP::DuctElbowPreferenceTable
 The DuctElbowPreferenceTable contains cross section related information for Duct elbows. More...
 
struct  ACAPI::MEP::DuctElbowPreferenceTable::Key
 The key that uniquely identifies a row in the DuctElbowPreferenceTable. More...
 
class  ACAPI::MEP::DuctElbowPreferenceTable::Modifier
 Modifier of the DuctElbowPreferenceTable. More...
 
class  ACAPI::MEP::DuctElbowPreferenceTableContainer
 The DuctElbowPreferenceTableContainer can contain several DuctElbowPreferenceTables. More...
 
class  ACAPI::MEP::DuctRectangularSegmentPreferenceTable
 The DuctRectangularSegmentPreferenceTable represents a named entity, that contains rows that consists of a size and a description. The rows have to be unique by value and are always in ascending order. More...
 
class  ACAPI::MEP::DuctRectangularSegmentPreferenceTable::Modifier
 Modifier of the DuctRectangularSegmentPreferenceTable. More...
 
class  ACAPI::MEP::DuctReferenceSet
 The DuctReferenceSet contains referenceIds that are used in DuctCircularSegmentPreferenceTable and DuctElbowPreferenceTable. More...
 
class  ACAPI::MEP::DuctSegmentPreferenceTableContainer
 The DuctSegmentPreferenceTableContainer can contain several PreferenceTableBase associated with ventilation. More...
 
class  ACAPI::MEP::DuctTransitionPreferenceTable
 The DuctTransitionPreferenceTable contains cross section and geometry related information for Duct transitions. More...
 
struct  ACAPI::MEP::DuctTransitionPreferenceTable::Key
 The key that uniquely identifies a row in the DuctTransitionPreferenceTable. More...
 
class  ACAPI::MEP::DuctTransitionPreferenceTable::Modifier
 Modifier of the DuctTransitionPreferenceTable. More...
 
class  ACAPI::MEP::DuctTransitionPreferenceTableContainer
 The DuctTransitionPreferenceTableContainer can contain several DuctTransitionPreferenceTables. More...
 
class  ACAPI::MEP::Elbow
 The Elbow can connect two straight RoutingSegments with the same dimensions but different directions. More...
 
class  ACAPI::MEP::ElbowDefault
 The ElbowDefault contains the necessary non-geometric data for modifying an Elbow. More...
 
class  ACAPI::MEP::ElbowDefault::Modifier
 Modifier of the ElbowDefault. More...
 
class  ACAPI::MEP::ElbowUIManager
 The ElbowUIManager contains UI-related services for an Elbow. More...
 
class  ACAPI::MEP::Element
 The Element represents an instantiable ElementBase. More...
 
class  ACAPI::MEP::ElementBase
 
class  ACAPI::MEP::ElementDefault
 The ElementDefault contains the necessary non-geometric data for creating a MEP element. More...
 
class  ACAPI::MEP::ElementDefault::Modifier
 Modifier of the ElementDefault. More...
 
class  ACAPI::MEP::ElementUIManager
 The ElementUIManager contains UI-related services for an Element. More...
 
class  ACAPI::MEP::Equipment
 The Equipment is a complex element with more than two ports. More...
 
class  ACAPI::MEP::Equipment::Modifier
 Modifier of the Equipment. More...
 
class  ACAPI::MEP::EquipmentDefault
 The EquipmentDefault contains the necessary non-geometric data for creating an Equipment element. More...
 
class  ACAPI::MEP::EquipmentUIManager
 The EquipmentUIManager contains UI-related services for an Equipment . More...
 
class  ACAPI::MEP::Fitting
 A fitting is used in distribution systems to connect straight sections of pipes and ducts, adapting to different sizes or shapes. More...
 
class  ACAPI::MEP::Fitting::Modifier
 Modifier of the Fitting. More...
 
class  ACAPI::MEP::FittingDefault
 The FittingDefault contains the necessary non-geometric data for creating a Fitting element. More...
 
class  ACAPI::MEP::FittingUIManager
 The FittingUIManager contains UI-related services for a Fitting. More...
 
class  ACAPI::MEP::FlexibleSegment
 In contrast to rigid segments flexible duct is not a connection of multiple elements (straight segments and elbows), instead a type of ducting pipe that could easily be bent in different angles. Since Archicad 28 there is a flexible pipe as well for liquids. FlexibleSegment either has a spline geometry defined by control points, or a polyline geometry, which is defined by alternating straight line parts and spline parts. Line parts are defined by their starting and ending coordinates, while spline parts are defined by control points. These alterning segments must start where the previous one ends. Polyline FlexibleSegemnts are only supported in the Piping domain. In the Ventilation domain FlexibleSegments can only be splines. More...
 
class  ACAPI::MEP::FlexibleSegment::Modifier
 Modifier of the FlexibleSegment. More...
 
class  ACAPI::MEP::FlexibleSegmentDefault
 The FlexibleSegmentDefault contains the necessary non-geometric data for creating a FlexibleSegment element. More...
 
class  ACAPI::MEP::FlexibleSegmentUIManager
 The FlexibleSegmentUIManager contains UI-related services for a FlexibleSegment. More...
 
class  ACAPI::MEP::ModifiableElement
 The Modifiable Element represents an instantiable ModifiableElementBase. More...
 
class  ACAPI::MEP::ModifiableElementBase
 The ModifiableElementBase contains the available modifying actions for ElementBase. More...
 
class  ACAPI::MEP::ModifiableElementBase::Modifier
 Modifier of the ModifiableElementBase. More...
 
class  ACAPI::MEP::PhysicalSystem
 A PhysicalSystem represents a physical instance of a system. More...
 
class  ACAPI::MEP::PhysicalSystem::Modifier
 Modifier object for PhysicalSystem. More...
 
class  ACAPI::MEP::PipeAngleSet
 The PipeAngleSet contains angles that are used in PipeElbowPreferenceTable and PipeBranchPreferenceTable. More...
 
class  ACAPI::MEP::PipeBranchPreferenceTable
 The PipeBranchPreferenceTable contains cross section and geometry related information for Pipe branches. More...
 
struct  ACAPI::MEP::PipeBranchPreferenceTable::Key
 The key that uniquely identifies a row in the PipeBranchPreferenceTable. More...
 
class  ACAPI::MEP::PipeBranchPreferenceTable::Modifier
 Modifier of the PipeBranchPreferenceTable. More...
 
class  ACAPI::MEP::PipeBranchPreferenceTableContainer
 The PipeBranchPreferenceTableContainer can contain several PipeBranchPreferenceTables. More...
 
class  ACAPI::MEP::PipeElbowPreferenceTable
 The PipeElbowPreferenceTable contains cross section related information for Pipe elbows. More...
 
struct  ACAPI::MEP::PipeElbowPreferenceTable::Key
 The key that uniquely identifies a row in the PipeElbowPreferenceTable. More...
 
class  ACAPI::MEP::PipeElbowPreferenceTable::Modifier
 Modifier of the PipeElbowPreferenceTable. More...
 
class  ACAPI::MEP::PipeElbowPreferenceTableContainer
 The PipeElbowPreferenceTableContainer can contain several PipeElbowPreferenceTables. More...
 
class  ACAPI::MEP::PipeReferenceSet
 The PipeReferenceSet contains referenceIds that are used in PipeSegmentPreferenceTable and PipeElbowPreferenceTable. More...
 
class  ACAPI::MEP::PipeSegmentPreferenceTable
 The PipeSegmentPreferenceTable contains cross section related information for Pipe routing segments. More...
 
class  ACAPI::MEP::PipeSegmentPreferenceTable::Modifier
 Modifier of the PipeSegmentPreferenceTable. More...
 
class  ACAPI::MEP::PipeSegmentPreferenceTableContainer
 The PipeSegmentPreferenceTableContainer can contain several PreferenceTableBase associated with piping. More...
 
class  ACAPI::MEP::PipeTransitionPreferenceTable
 The PipeTransitionPreferenceTable contains cross section and geometry related information for Pipe transitions. More...
 
struct  ACAPI::MEP::PipeTransitionPreferenceTable::Key
 The key that uniquely identifies a row in the PipeTransitionPreferenceTable. More...
 
class  ACAPI::MEP::PipeTransitionPreferenceTable::Modifier
 Modifier of the PipeTransitionPreferenceTable. More...
 
class  ACAPI::MEP::PipeTransitionPreferenceTableContainer
 The PipeTransitionPreferenceTableContainer can contain several PipeTransitionPreferenceTables. More...
 
class  ACAPI::MEP::PipingPort
 The PipingPort represents a connection point of a pipe segment. More...
 
class  ACAPI::MEP::PipingPort::Modifier
 Modifier of the PipingPort. More...
 
class  ACAPI::MEP::PipingPortDefault
 Through this PipingPortDefault you can access and configure the PipingPorts of MEPElementDefaults before placement. More...
 
class  ACAPI::MEP::PipingPortDefault::Modifier
 Modifier of the PipingPortDefault. More...
 
class  ACAPI::MEP::Port
 The Port represents an instantiable PortBase. Through this object you can reference to the three domain's ports in a common way. More...
 
class  ACAPI::MEP::PortBase
 The Port is associated to an element and it represents a point between elements. More...
 
class  ACAPI::MEP::PortBase::Modifier
 Modifier of the PortBase. More...
 
class  ACAPI::MEP::PortDefaultBase
 Through this PortDefault you can access and configure the Ports of MEPElementDefaults before placement. More...
 
class  ACAPI::MEP::PortDefaultBase::Modifier
 Modifier of the PortDefaultBase. More...
 
class  ACAPI::MEP::PreferenceTableContainerBase
 The PreferenceTableContainerBase contains PreferenceTables, and you can Add/Get/Delete them. More...
 
class  ACAPI::MEP::PreferenceTableContainerBase::Modifier
 Modifier of the PreferenceTableContainerBase. More...
 
class  ACAPI::MEP::ReferenceSetBase
 The ReferenceSetBase represents a named table, and it contains referenceIds which are used as keys in the PreferenceTables. By default, Archicad will provide you the DN referenceSet, but you can choose your own by renaming it and populate it with your desired values. More...
 
class  ACAPI::MEP::ReferenceSetBase::Modifier
 Modifier of the ReferenceSetBase. More...
 
class  ACAPI::MEP::RigidSegment
 The RigidSegment is placed in RoutingSegments. More...
 
class  ACAPI::MEP::RigidSegmentDefault
 The RigidSegmentDefault contains the necessary non-geometric data for creating a RigidSegment element. More...
 
class  ACAPI::MEP::RigidSegmentUIManager
 The RigidSegmentUIManager contains UI-related services for a RigidSegment. More...
 
class  ACAPI::MEP::RoutingElement
 The RoutingElement can contain Routing Segments and Routing Nodes. More...
 
class  ACAPI::MEP::RoutingElement::Modifier
 Modifier of the RoutingElement. More...
 
class  ACAPI::MEP::RoutingElementDefault
 The RoutingElementDefault contains the necessary non-geometric data for creating a Routing element. More...
 
class  ACAPI::MEP::RoutingElementDefault::Modifier
 Modifier of the RoutingElementDefault. More...
 
class  ACAPI::MEP::RoutingElementUIManager
 The RoutingElementUIManager contains UI-related services for a Routing element. More...
 
class  ACAPI::MEP::RoutingNode
 The RoutingNode can contain Elbow and Transition elements. More...
 
class  ACAPI::MEP::RoutingNode::Modifier
 Modifier of the RoutingNode. More...
 
class  ACAPI::MEP::RoutingNodeDefault
 The RoutingNodeDefault contains the necessary non-geometric data for creating and modifying a Routing Node. More...
 
class  ACAPI::MEP::RoutingNodeDefault::Modifier
 Modifier of the RoutingNodeDefault. More...
 
class  ACAPI::MEP::RoutingNodeUIManager
 The RoutingNodeUIManager contains UI-related services for a RoutingNode. More...
 
class  ACAPI::MEP::RoutingSegment
 The RoutingSegment can contain Rigid Segment elements. More...
 
class  ACAPI::MEP::RoutingSegment::Modifier
 Modifier of the RoutingSegment. More...
 
class  ACAPI::MEP::RoutingSegmentDefault
 The RoutingSegmentDefault contains the necessary non-geometric data for creating and modifying a Routing Segment. More...
 
class  ACAPI::MEP::RoutingSegmentDefault::Modifier
 Modifier of the RoutingSegmentDefault. More...
 
class  ACAPI::MEP::RoutingSegmentUIManager
 The RoutingSegmentUIManager contains UI-related services for a RoutingSegment. More...
 
class  ACAPI::MEP::ICalculationResultColumn
 Formatting for calculated values for use in ACAPI::MEP::SystemBrowserCalculationCallbackInterface::RegisterCalculatedColumns. More...
 
class  ACAPI::MEP::TypedCalculationResultColumn< T >
 Template typed version of the ICalculationResultColumn interface. More...
 
class  ACAPI::MEP::SystemBrowserCalculationCallbackInterface
 Interface for handling calculated columns in the system browser. More...
 
struct  ACAPI::MEP::SystemBrowserCalculationCallbackInterface::ColumnRowEntry
 The signature of the entries in the result data. The row is decided by the system browser, so the entry is identified using the associated element id instead. More...
 
class  ACAPI::MEP::SystemGroup
 A SystemGroup represents a collection of PhysicalSystems. More...
 
class  ACAPI::MEP::SystemGroup::Modifier
 Modifier object for SystemGroup. More...
 
class  ACAPI::MEP::TakeOff
 The Take-off is a simple element with two ports on a single axis. More...
 
class  ACAPI::MEP::TakeOff::Modifier
 Modifier of the TakeOff. More...
 
class  ACAPI::MEP::TakeOffDefault
 The TakeOffDefault contains the necessary non-geometric data for creating a Take-off element. More...
 
class  ACAPI::MEP::TakeOffUIManager
 The TakeOffUIManager contains UI-related services for an TakeOff. More...
 
class  ACAPI::MEP::Terminal
 The Terminal is a complex element with a single port. More...
 
class  ACAPI::MEP::Terminal::Modifier
 Modifier of the Terminal. More...
 
class  ACAPI::MEP::TerminalDefault
 The TerminalDefault contains the necessary non-geometric data for creating a Terminal element. More...
 
class  ACAPI::MEP::TerminalUIManager
 The TerminalUIManager contains UI-related services for a Terminal. More...
 
class  ACAPI::MEP::Transition
 The Transition is an element that connects two different Routing Segments. More...
 
class  ACAPI::MEP::TransitionDefault
 The TransitionDefault contains the necessary non-geometric data for creating and modifying a Transition. More...
 
class  ACAPI::MEP::TransitionDefault::Modifier
 Modifier of the TransitionDefault. More...
 
class  ACAPI::MEP::TransitionUIManager
 The TransitionUIManager contains UI-related services for a Transition. More...
 
class  ACAPI::MEP::UniqueID
 The MEP unique identifier. More...
 
class  ACAPI::MEP::VentilationPort
 The VentilationPort represents a connection point of a duct. More...
 
class  ACAPI::MEP::VentilationPort::Modifier
 Modifier of the VentilationPort. More...
 
class  ACAPI::MEP::VentilationPortDefault
 Through this VentilationPortDefault you can access and configure the VentilationPorts of MEPElementDefaults before placement. More...
 
class  ACAPI::MEP::VentilationPortDefault::Modifier
 Modifier of the VentilationPortDefault. More...
 
struct  ACAPI::MEP::Orientation
 Defines the orientation with the help of a direction and rotation vector. More...
 
struct  ACAPI::MEP::RoutingSegmentRectangularCrossSectionData
 Defines the necessary data for placing RectangularRoutingSegments of a RoutingElement. More...
 
struct  ACAPI::MEP::RoutingSegmentCircularCrossSectionData
 Defines the necessary data for placing CircularRoutingSegments of a RoutingElement. More...
 
struct  ACAPI::MEP::RouteConnectionResult
 Defines the changes regarding Ids after a RoutingElement-RoutingElement connection. More...
 
struct  ACAPI::MEP::FlexibleSegmentPolylineLinePart
 Defines a single line segment of a polyline FlexibleSegment. More...
 
struct  ACAPI::MEP::FlexibleSegmentPolylineSplinePart
 Defines a single spline segment of a polyline FlexibleSegment. More...
 

Typedefs

using ACAPI::MEP::FlexibleSegmentPolyline = std::vector<std::variant<FlexibleSegmentPolylineLinePart, FlexibleSegmentPolylineSplinePart>>
 Defines a polyline FlexibleSegment geometry. Must contain alternating line and spline segments.
 

Enumerations

enum class  ACAPI::MEP::Domain { Domain::Ventilation , Domain::Piping , Domain::CableCarrier }
 Type of the domain. More...
 
enum class  ACAPI::MEP::ConnectorShape { ConnectorShape::Rectangular , ConnectorShape::Circular , ConnectorShape::Oval , ConnectorShape::UShape }
 Shape of the connector. More...
 
enum class  ACAPI::MEP::ConnectionStyle { ConnectionStyle::SimpleBody , ConnectionStyle::Flanged , ConnectionStyle::Welded }
 Style of the connection. More...
 
enum class  ACAPI::MEP::FlowDirection { FlowDirection::FlowNotDefined , FlowDirection::FlowIn , FlowDirection::FlowOut }
 Direction of the flow. More...
 
enum class  ACAPI::MEP::ConnectionSex { ConnectionSex::Unisex , ConnectionSex::Male , ConnectionSex::Female }
 Sex of the connection. More...
 
enum class  ACAPI::MEP::PreferredTransitionPlacement { PreferredTransitionPlacement::SmallToLarge , PreferredTransitionPlacement::LargeToSmall }
 Placement type of the preferred transition. More...
 
enum class  ACAPI::MEP::FloorPlanDisplayOption { Projected , ProjectedWithOverhead , Symbolic , ByMVO }
 Defines the possible Floor Plan Display Options.
 
enum class  ACAPI::MEP::CutPlanePosition { AtUpperDisplayLimit , ByViewSettings }
 Defines the possible Cut Plane Position options.
 
enum class  ACAPI::MEP::ShowProjection { ToFloorPlanRange , ToAbsoluteDisplayLimit , EntireElement }
 Defines the possible Show Projection options.
 
enum class  ACAPI::MEP::OnStoryVisibility { AllRelevantStories , HomeStoryOnly }
 Defines the possible On Story Visibility options. AllRelevantStories is the same as Auto.
 

Functions

Result< AccessoryDefaultACAPI::MEP::CreateAccessoryDefault (Domain domain)
 Creates an AccessoryDefault.
 
MEPAPI_EXPORT Result< AccessoryDefaultACAPI::MEP::CreateAccessoryDefault (const ACAPI::ElementDefault &defaultElem)
 Creates an AccessoryDefault from the given base element default.
 
Result< AccessoryUIManagerACAPI::MEP::CreateAccessoryUIManager ()
 Creates a AccessoryUIManager.
 
MEPAPI_EXPORT GS::Array< API_GuidACAPI::MEP::CollectAllMEPElements ()
 Returns every MEP element.
 
MEPAPI_EXPORT bool ACAPI::MEP::IsBranch (const API_Guid &typeID)
 
MEPAPI_EXPORT bool ACAPI::MEP::IsAccessory (const API_Guid &typeID)
 
MEPAPI_EXPORT bool ACAPI::MEP::IsEquipment (const API_Guid &typeID)
 
MEPAPI_EXPORT bool ACAPI::MEP::IsTerminal (const API_Guid &typeID)
 
MEPAPI_EXPORT bool ACAPI::MEP::IsRoutingElement (const API_Guid &typeID)
 
MEPAPI_EXPORT bool ACAPI::MEP::IsFitting (const API_Guid &typeID)
 
MEPAPI_EXPORT bool ACAPI::MEP::IsRigidSegment (const API_Guid &typeID)
 
MEPAPI_EXPORT bool ACAPI::MEP::IsElbow (const API_Guid &typeID)
 
MEPAPI_EXPORT bool ACAPI::MEP::IsTransition (const API_Guid &typeID)
 
MEPAPI_EXPORT bool ACAPI::MEP::IsFlexibleSegment (const API_Guid &typeID)
 
MEPAPI_EXPORT bool ACAPI::MEP::IsTakeOff (const API_Guid &typeID)
 
MEPAPI_EXPORT bool ACAPI::MEP::IsPiping (const API_Guid &typeID)
 
MEPAPI_EXPORT bool ACAPI::MEP::IsCableCarrier (const API_Guid &typeID)
 
MEPAPI_EXPORT bool ACAPI::MEP::IsVentilation (const API_Guid &typeID)
 
MEPAPI_EXPORT API_Guid ACAPI::MEP::GetMEPModelCheckTypeId ()
 
 ACAPI::MEP::Adapter::UniqueID::UniqueID (const GS::Guid &guid)
 Constructs a UniqueID from GS::Guid.
 
 ACAPI::MEP::Adapter::UniqueID::UniqueID (const API_Guid &guid)
 Constructs a UniqueID from API_Guid.
 
MEPAPI_EXPORT ACAPI::MEP::Domain ACAPI::MEP::FromAttributeEnum (API_MEPDomainID domain)
 Converts from the attribute management's API_MEPDomainID to ACAPI::MEP::Domain.
 
Result< BranchDefaultACAPI::MEP::CreateBranchDefault (Domain domain)
 Creates a BranchDefault.
 
Result< BranchUIManagerACAPI::MEP::CreateBranchUIManager ()
 Creates a BranchUIManager.
 
Result< CableCarrierSegmentPreferenceTableContainerACAPI::MEP::GetCableCarrierSegmentPreferenceTableContainer ()
 
Result< DistributionSystemsGraphACAPI::MEP::CreateDistributionSystemsGraph ()
 Creates a DistributionSystemsGraph.
 
Result< DuctAngleSetACAPI::MEP::GetDuctAngleSet ()
 
Result< DuctBranchPreferenceTableContainerACAPI::MEP::GetDuctBranchPreferenceTableContainer ()
 
Result< DuctElbowPreferenceTableContainerACAPI::MEP::GetDuctElbowPreferenceTableContainer ()
 
Result< DuctReferenceSetACAPI::MEP::GetDuctReferenceSet ()
 
Result< DuctSegmentPreferenceTableContainerACAPI::MEP::GetDuctSegmentPreferenceTableContainer ()
 
Result< DuctTransitionPreferenceTableContainerACAPI::MEP::GetDuctTransitionPreferenceTableContainer ()
 
Result< ElbowDefaultACAPI::MEP::CreateElbowDefault (Domain domain)
 Creates an ElbowDefault.
 
Result< ElbowUIManagerACAPI::MEP::CreateElbowUIManager ()
 Creates an ElbowUIManager.
 
Result< ElementUIManagerACAPI::MEP::CreateElementUIManager ()
 Creates a ElementUIManager.
 
Result< EquipmentDefaultACAPI::MEP::CreateEquipmentDefault ()
 Creates an EquipmentDefault.
 
MEPAPI_EXPORT Result< EquipmentDefaultACAPI::MEP::CreateEquipmentDefault (const ACAPI::ElementDefault &defaultElem)
 Creates an EquipmentDefault from the given base element default.
 
Result< EquipmentUIManagerACAPI::MEP::CreateEquipmentUIManager ()
 Creates a EquipmentUIManager.
 
Result< FittingDefaultACAPI::MEP::CreateFittingDefault (Domain domain)
 Creates an FittingDefault.
 
MEPAPI_EXPORT Result< FittingDefaultACAPI::MEP::CreateFittingDefault (const ACAPI::ElementDefault &defaultElem)
 Creates a FittingDefault from the given base element default.
 
Result< FittingUIManagerACAPI::MEP::CreateFittingUIManager ()
 Creates a FittingUIManager.
 
Result< FlexibleSegmentDefaultACAPI::MEP::CreateFlexibleSegmentDefault (Domain domain)
 Creates a FlexibleSegmentDefault.
 
MEPAPI_EXPORT Result< FlexibleSegmentDefaultACAPI::MEP::CreateFlexibleSegmentDefault (const ACAPI::ElementDefault &defaultElem)
 Creates a FlexibleSegmentDefault from the given base element default.
 
Result< FlexibleSegmentUIManagerACAPI::MEP::CreateFlexibleSegmentUIManager ()
 Creates a FlexibleSegmentUIManager.
 
Result< PipeAngleSetACAPI::MEP::GetPipeAngleSet ()
 
Result< PipeBranchPreferenceTableContainerACAPI::MEP::GetPipeBranchPreferenceTableContainer ()
 
Result< PipeElbowPreferenceTableContainerACAPI::MEP::GetPipeElbowPreferenceTableContainer ()
 
Result< PipeReferenceSetACAPI::MEP::GetPipeReferenceSet ()
 
Result< PipeSegmentPreferenceTableContainerACAPI::MEP::GetPipeSegmentPreferenceTableContainer ()
 
Result< PipeTransitionPreferenceTableContainerACAPI::MEP::GetPipeTransitionPreferenceTableContainer ()
 
Result< RigidSegmentDefaultACAPI::MEP::CreateRigidSegmentDefault (Domain domain)
 Creates a RigidSegmentDefault.
 
Result< RigidSegmentUIManagerACAPI::MEP::CreateRigidSegmentUIManager ()
 Creates a RigidSegmentUIManager.
 
Result< RoutingElementDefaultACAPI::MEP::CreateRoutingElementDefault (Domain domain)
 Creates a RoutingElementDefault.
 
MEPAPI_EXPORT Result< RoutingElementDefaultACAPI::MEP::CreateRoutingElementDefault (const ACAPI::ElementDefault &defaultElem)
 Creates a RoutingElementDefault from the given base element default.
 
Result< RoutingElementUIManagerACAPI::MEP::CreateRoutingElementUIManager ()
 Creates a RoutingElementUIManager.
 
Result< RoutingNodeDefaultACAPI::MEP::CreateRoutingNodeDefault (Domain domain)
 Creates a RoutingNodeDefault.
 
Result< RoutingNodeUIManagerACAPI::MEP::CreateRoutingNodeUIManager ()
 Creates a RoutingNodeUIManager.
 
Result< RoutingSegmentDefaultACAPI::MEP::CreateRoutingSegmentDefault (Domain domain)
 Creates a RoutingSegmentDefault.
 
Result< RoutingSegmentUIManagerACAPI::MEP::CreateRoutingSegmentUIManager ()
 Creates a RoutingSegmentUIManager.
 
Result< void > ACAPI::MEP::RegisterCalculationCallback (SystemBrowserCalculationCallbackInterface &callbackInterface)
 Registers a custom callback interface implementation.
 
Result< std::vector< UniqueID > > ACAPI::MEP::GetSystemGroupIDs ()
 Fetches the IDs of the current SystemGroups.
 
Result< SystemGroupACAPI::MEP::CreateSystemGroup (const GS::UniString &name, const GS::UniString &undoString="Create system group")
 Creates a new SystemGroup.
 
Result< TakeOffDefaultACAPI::MEP::CreateTakeOffDefault (Domain domain)
 Creates a TakeOffDefault.
 
MEPAPI_EXPORT Result< TakeOffDefaultACAPI::MEP::CreateTakeOffDefault (const ACAPI::ElementDefault &defaultElem)
 Creates a TakeOffDefault from the given base element default.
 
Result< TakeOffUIManagerACAPI::MEP::CreateTakeOffUIManager ()
 Creates a TakeOffUIManager.
 
Result< TerminalDefaultACAPI::MEP::CreateTerminalDefault (Domain domain)
 Creates a TerminalDefault.
 
MEPAPI_EXPORT Result< TerminalDefaultACAPI::MEP::CreateTerminalDefault (const ACAPI::ElementDefault &defaultElem)
 Creates a TerminalDefault from the given base element default.
 
Result< TerminalUIManagerACAPI::MEP::CreateTerminalUIManager ()
 Creates a TerminalUIManager.
 
Result< TransitionDefaultACAPI::MEP::CreateTransitionDefault (Domain domain)
 Creates a TransitionDefault.
 
Result< TransitionUIManagerACAPI::MEP::CreateTransitionUIManager ()
 Creates a TransitionUIManager.
 
 ACAPI::MEP::UniqueID::UniqueID (const GS::Guid &, const API_Token &)
 Constructs a UniqueID.
 

Detailed Description

Functions related to the creation, manipulation and management of MEP (Mechanical, Electrical, Plumbing) elements.

Enumeration Type Documentation

◆ ConnectionSex

enum class ACAPI::MEP::ConnectionSex
strong

Sex of the connection.

Remarks
Defines the sex of the connections in Mechanical, Electrical, and Plumbing (MEP) systems.
Enumerator
Unisex 

Unisex connection, suitable for both male and female counterparts.

Male 

Male connection, designed to connect with a female counterpart.

Female 

Female connection, designed to connect with a male counterpart.

◆ ConnectionStyle

enum class ACAPI::MEP::ConnectionStyle
strong

Style of the connection.

Remarks
Specifies the style of connections used in Mechanical, Electrical, and Plumbing (MEP) systems.
Enumerator
SimpleBody 

Simple body connection, typically used for straightforward and direct connections without additional features.

Flanged 

Flanged connection, featuring flanges for bolting connections, commonly used in piping systems for easy assembly and disassembly.

Welded 

Welded connection, where the components are joined by welding, providing a strong and permanent connection.

◆ ConnectorShape

enum class ACAPI::MEP::ConnectorShape
strong

Shape of the connector.

Remarks
Specifies the shape of connectors used in Mechanical, Electrical, and Plumbing (MEP) systems.
Enumerator
Rectangular 

Rectangular shape, commonly used in ductwork and rectangular piping systems.

Circular 

Circular shape, often used for pipes and round ducts.

Oval 

Oval shape, used in specific applications where space constraints or aerodynamic properties are considered.

UShape 

U-shape, typically used for specialized connectors and fittings in various MEP systems.

◆ Domain

enum class ACAPI::MEP::Domain
strong

Type of the domain.

Remarks
Specifies the type of domain within the Mechanical, Electrical, and Plumbing (MEP) context.
Enumerator
Ventilation 

Ventilation domain, typically involves HVAC systems and related components.

Piping 

Piping domain, generally includes plumbing and other fluid transport systems.

CableCarrier 

Cable carrier domain, encompasses systems for routing and supporting electrical cables.

◆ FlowDirection

enum class ACAPI::MEP::FlowDirection
strong

Direction of the flow.

Remarks
Specifies the direction of the flow in Mechanical, Electrical, and Plumbing (MEP) systems.
Enumerator
FlowNotDefined 

The flow direction is not defined.

FlowIn 

The flow is directed inward.

FlowOut 

The flow is directed outward.

◆ PreferredTransitionPlacement

Placement type of the preferred transition.

Remarks
Determines the preferred transition placement type in Mechanical, Electrical, and Plumbing (MEP) systems.
Enumerator
SmallToLarge 

Transition from a smaller size to a larger size.

LargeToSmall 

Transition from a larger size to a smaller size.

Function Documentation

◆ CollectAllMEPElements()

MEPAPI_EXPORT GS::Array< API_Guid > ACAPI::MEP::CollectAllMEPElements ( )

Returns every MEP element.

Since
Archicad 28
Returns
Gives back every MEP element's GUID in an array

◆ CreateAccessoryDefault() [1/2]

MEPAPI_EXPORT Result< AccessoryDefault > ACAPI::MEP::CreateAccessoryDefault ( const ACAPI::ElementDefault & defaultElem)

Creates an AccessoryDefault from the given base element default.

Parameters
defaultElemThe base element default which will be converted to an AccessoryDefault.
Since
Archicad 29
Returns
If the given base element default refers to an Accessory, returns a copy of the AccessoryDefault, otherwise Error.

◆ CreateAccessoryDefault() [2/2]

Result< AccessoryDefault > ACAPI::MEP::CreateAccessoryDefault ( Domain domain)
inline

Creates an AccessoryDefault.

Parameters
domainThe Domain of the requested AccessoryDefault. It can be ventilation or piping.
Returns
If able, returns a copy of Archicad's current Default of the Accessory tool for the domain defined by the parameter, otherwise Error (for ex. if domain is cable carrier).

◆ CreateAccessoryUIManager()

Result< AccessoryUIManager > ACAPI::MEP::CreateAccessoryUIManager ( )
inline

Creates a AccessoryUIManager.

Returns
If able, creates a new manager for Accessory, otherwise Error.

◆ CreateBranchDefault()

Result< BranchDefault > ACAPI::MEP::CreateBranchDefault ( Domain domain)
inline

Creates a BranchDefault.

After creating and customizing a BranchDefault, it needs to be set as Archicad's default in order to use it during the upcoming RoutingElement connections.

Parameters
domainThe Domain of the requested BranchDefault.
Returns
If able, returns a copy of Archicad's current Default of the Branch tool for the domain defined by the parameter, otherwise Error

◆ CreateBranchUIManager()

Result< BranchUIManager > ACAPI::MEP::CreateBranchUIManager ( )
inline

Creates a BranchUIManager.

Returns
If able, creates a new manager for Branch, otherwise Error.

◆ CreateDistributionSystemsGraph()

Result< DistributionSystemsGraph > ACAPI::MEP::CreateDistributionSystemsGraph ( )
inline

Creates a DistributionSystemsGraph.

Returns
If able, creates a new DistributionSystemsGraph, otherwise Error.
if (newGraph.IsErr ())

◆ CreateElbowDefault()

Result< ElbowDefault > ACAPI::MEP::CreateElbowDefault ( Domain domain)
inline

Creates an ElbowDefault.

Parameters
domainThe Domain of the requested ElbowDefault.
Returns
If able, returns a copy of Archicad's current Default of the Elbow from the RoutingElement tool for the domain defined by the parameter, otherwise Error.

◆ CreateElbowUIManager()

Result< ElbowUIManager > ACAPI::MEP::CreateElbowUIManager ( )
inline

Creates an ElbowUIManager.

Returns
If able, creates a new manager for Elbow, otherwise Error.

◆ CreateElementUIManager()

Result< ElementUIManager > ACAPI::MEP::CreateElementUIManager ( )
inline

Creates a ElementUIManager.

Returns
If able, creates a new manager for Element, otherwise Error.

◆ CreateEquipmentDefault() [1/2]

Result< EquipmentDefault > ACAPI::MEP::CreateEquipmentDefault ( )
inline

Creates an EquipmentDefault.

Returns
If able, returns a copy of Archicad's current Default of the Equipment tool, otherwise Error.

◆ CreateEquipmentDefault() [2/2]

MEPAPI_EXPORT Result< EquipmentDefault > ACAPI::MEP::CreateEquipmentDefault ( const ACAPI::ElementDefault & defaultElem)

Creates an EquipmentDefault from the given base element default.

Parameters
defaultElemThe base element default which will be converted to an EquipmentDefault.
Since
Archicad 29
Returns
If the given base element default refers to an Equipment, returns a copy of the EquipmentDefault, otherwise Error.

◆ CreateEquipmentUIManager()

Result< EquipmentUIManager > ACAPI::MEP::CreateEquipmentUIManager ( )
inline

Creates a EquipmentUIManager.

Returns
If able, creates a new manager for Equipment, otherwise Error.

◆ CreateFittingDefault() [1/2]

MEPAPI_EXPORT Result< FittingDefault > ACAPI::MEP::CreateFittingDefault ( const ACAPI::ElementDefault & defaultElem)

Creates a FittingDefault from the given base element default.

Parameters
defaultElemThe base element default which will be converted to a FittingDefault.
Since
Archicad 29
Returns
If the given base element default refers to a Fitting, returns a copy of the FittingDefault, otherwise Error.

◆ CreateFittingDefault() [2/2]

Result< FittingDefault > ACAPI::MEP::CreateFittingDefault ( Domain domain)
inline

Creates an FittingDefault.

Parameters
domainThe Domain of the requested FittingDefault.
Returns
If able, returns a copy of Archicad's current Default of the Fitting tool for the domain defined by the parameter, otherwise Error.

◆ CreateFittingUIManager()

Result< FittingUIManager > ACAPI::MEP::CreateFittingUIManager ( )
inline

Creates a FittingUIManager.

Returns
If able, creates a new manager for Fitting, otherwise Error.

◆ CreateFlexibleSegmentDefault() [1/2]

MEPAPI_EXPORT Result< FlexibleSegmentDefault > ACAPI::MEP::CreateFlexibleSegmentDefault ( const ACAPI::ElementDefault & defaultElem)

Creates a FlexibleSegmentDefault from the given base element default.

Parameters
defaultElemThe base element default which will be converted to a FlexibleSegmentDefault.
Since
Archicad 29
Returns
If the given base element default refers to a FlexibleSegment, returns a copy of the FlexibleSegmentDefault, otherwise Error.

◆ CreateFlexibleSegmentDefault() [2/2]

Result< FlexibleSegmentDefault > ACAPI::MEP::CreateFlexibleSegmentDefault ( Domain domain)
inline

Creates a FlexibleSegmentDefault.

Parameters
domainThe domain determines whether the Default will be Duct or Pipe FlexibleSegment tool.
Returns
If able, returns a copy of Archicad's current Default of the Duct (Ventilation) or Pipe (Piping) FlexibleSegment tool, otherwise Error.

◆ CreateFlexibleSegmentUIManager()

Result< FlexibleSegmentUIManager > ACAPI::MEP::CreateFlexibleSegmentUIManager ( )
inline

Creates a FlexibleSegmentUIManager.

Returns
If able, creates a new manager for FlexibleSegment, otherwise Error.

◆ CreateRigidSegmentDefault()

Result< RigidSegmentDefault > ACAPI::MEP::CreateRigidSegmentDefault ( Domain domain)
inline

Creates a RigidSegmentDefault.

Parameters
domainThe Domain of the requested RigidSegmentDefault.
Returns
If able, returns a copy of Archicad's current Default of the RigidSegment from the RoutingElement tool for the domain defined by the parameter, otherwise Error.

◆ CreateRigidSegmentUIManager()

Result< RigidSegmentUIManager > ACAPI::MEP::CreateRigidSegmentUIManager ( )
inline

Creates a RigidSegmentUIManager.

Returns
If able, creates a new manager for RigidSegment, otherwise Error.

◆ CreateRoutingElementDefault() [1/2]

MEPAPI_EXPORT Result< RoutingElementDefault > ACAPI::MEP::CreateRoutingElementDefault ( const ACAPI::ElementDefault & defaultElem)

Creates a RoutingElementDefault from the given base element default.

Parameters
defaultElemThe base element default which will be converted to a RoutingElementDefault.
Since
Archicad 29
Returns
If the given base element default refers to a RoutingElement, returns a copy of the RoutingElementDefault, otherwise Error.

◆ CreateRoutingElementDefault() [2/2]

Result< RoutingElementDefault > ACAPI::MEP::CreateRoutingElementDefault ( Domain domain)
inline

Creates a RoutingElementDefault.

Parameters
domainThe Domain of the requested RoutingElementDefault.
Returns
If able, returns a copy of Archicad's current Default of the RoutingElement tool for the domain defined by the parameter, otherwise Error.

◆ CreateRoutingElementUIManager()

Result< RoutingElementUIManager > ACAPI::MEP::CreateRoutingElementUIManager ( )
inline

Creates a RoutingElementUIManager.

Returns
If able, creates a new manager for RoutingElement, otherwise Error.

◆ CreateRoutingNodeDefault()

Result< RoutingNodeDefault > ACAPI::MEP::CreateRoutingNodeDefault ( Domain domain)
inline

Creates a RoutingNodeDefault.

Parameters
domainThe Domain of the requested RoutingNodeDefault.
Returns
If able, returns a copy of Archicad's current Default of the RoutingNode from the RoutingElement tool for the domain defined by the parameter, otherwise Error.

◆ CreateRoutingNodeUIManager()

Result< RoutingNodeUIManager > ACAPI::MEP::CreateRoutingNodeUIManager ( )
inline

Creates a RoutingNodeUIManager.

Returns
If able, creates a new manager for RoutingNode, otherwise Error.

◆ CreateRoutingSegmentDefault()

Result< RoutingSegmentDefault > ACAPI::MEP::CreateRoutingSegmentDefault ( Domain domain)
inline

Creates a RoutingSegmentDefault.

Parameters
domainThe Domain of the requested RoutingSegmentDefault.
Returns
If able, returns a copy of Archicad's current Default of the RoutingSegment from the RoutingElement tool for the domain defined by the parameter, otherwise Error.

◆ CreateRoutingSegmentUIManager()

Result< RoutingSegmentUIManager > ACAPI::MEP::CreateRoutingSegmentUIManager ( )
inline

Creates a RoutingSegmentUIManager.

Returns
If able, creates a new manager for RoutingSegment, otherwise Error.

◆ CreateSystemGroup()

Result< SystemGroup > ACAPI::MEP::CreateSystemGroup ( const GS::UniString & name,
const GS::UniString & undoString = "Create system group" )
inline

Creates a new SystemGroup.

Parameters
nameThe name of the new SystemGroup.
undoStringThe text which appears in the undo queue of Archicad after executing the command.
Returns
A new SystemGroup if successful, otherwise an error.
constexpr std::string_view DefaultSystemGroupName { "Generated System Group" };
std::optional<ACAPI::MEP::SystemGroup> FindOrCreateDefaultGroup ()
{
// First, locate the default system group:
auto systemGroups { ACAPI::MEP::GetSystemGroupIDs () };
if (systemGroups.IsErr ())
return {};
for (const auto& id : systemGroups.Unwrap ()) {
auto systemGroup { ACAPI::MEP::SystemGroup::Get (id) };
if (systemGroup.IsErr ())
return {};
if (systemGroup->GetName () == DefaultSystemGroupName)
return systemGroup.Unwrap ();
}
auto newlyCreatedSystemGroup { ACAPI::MEP::CreateSystemGroup (GS::UniString { DefaultSystemGroupName }) };
if (newlyCreatedSystemGroup.IsErr ())
return {};
return newlyCreatedSystemGroup.Unwrap ();
}

◆ CreateTakeOffDefault() [1/2]

MEPAPI_EXPORT Result< TakeOffDefault > ACAPI::MEP::CreateTakeOffDefault ( const ACAPI::ElementDefault & defaultElem)

Creates a TakeOffDefault from the given base element default.

Parameters
defaultElemThe base element default which will be converted to a TakeOffDefault.
Since
Archicad 29
Returns
If the given base element default refers to a Take-off, returns a copy of the TakeOffDefault, otherwise Error.

◆ CreateTakeOffDefault() [2/2]

Result< TakeOffDefault > ACAPI::MEP::CreateTakeOffDefault ( Domain domain)
inline

Creates a TakeOffDefault.

Parameters
domainThe domain of the requested TakeOffDefault. Currently it can only be ventilation.
Returns
If able, returns a copy of Archicad's current Default of the Take-off tool for the domain defined by the parameter, otherwise Error (for ex. if domain is cable carrier).

◆ CreateTakeOffUIManager()

Result< TakeOffUIManager > ACAPI::MEP::CreateTakeOffUIManager ( )
inline

Creates a TakeOffUIManager.

Returns
If able, creates a new manager for TakeOff, otherwise Error.

◆ CreateTerminalDefault() [1/2]

MEPAPI_EXPORT Result< TerminalDefault > ACAPI::MEP::CreateTerminalDefault ( const ACAPI::ElementDefault & defaultElem)

Creates a TerminalDefault from the given base element default.

Parameters
defaultElemThe base element default which will be converted to a TerminalDefault.
Since
Archicad 29
Returns
If the given base element default refers to a Terminal, returns a copy of the TerminalDefault, otherwise Error.

◆ CreateTerminalDefault() [2/2]

Result< TerminalDefault > ACAPI::MEP::CreateTerminalDefault ( Domain domain)
inline

Creates a TerminalDefault.

Parameters
domainThe Domain of the requested TerminalDefault. It can be ventilation or piping.
Returns
If able, returns a copy of Archicad's current Default of the Terminal tool for the domain defined by the parameter, otherwise Error (for ex. if domain is cable carrier).

◆ CreateTerminalUIManager()

Result< TerminalUIManager > ACAPI::MEP::CreateTerminalUIManager ( )
inline

Creates a TerminalUIManager.

Returns
If able, creates a new manager for Terminal, otherwise Error.

◆ CreateTransitionDefault()

Result< TransitionDefault > ACAPI::MEP::CreateTransitionDefault ( Domain domain)
inline

Creates a TransitionDefault.

Parameters
domainThe Domain of the requested TransitionDefault.
Returns
If able, returns a copy of Archicad's current Default of the Transition from the RoutingElement tool for the domain defined by the parameter, otherwise Error.

◆ CreateTransitionUIManager()

Result< TransitionUIManager > ACAPI::MEP::CreateTransitionUIManager ( )
inline

Creates a TransitionUIManager.

Returns
If able, creates a new manager for Transitions, otherwise Error.

◆ FromAttributeEnum()

MEPAPI_EXPORT ACAPI::MEP::Domain ACAPI::MEP::FromAttributeEnum ( API_MEPDomainID domain)

Converts from the attribute management's API_MEPDomainID to ACAPI::MEP::Domain.

For implementation reasons, MEP systems are managed through our public C-API. To withold compatibility with our more modern C++ API, the MEP domain enum is duplicated both places. Outside of the C/C++ language interface, the enum is otherwise identical.

Parameters
domainThe attribute domain
Since
Archicad 29
Returns
The ACAPI::MEP::Domain corresponding to a API_MEPDomainID.

◆ GetCableCarrierSegmentPreferenceTableContainer()

Result< CableCarrierSegmentPreferenceTableContainer > ACAPI::MEP::GetCableCarrierSegmentPreferenceTableContainer ( )
inline
Returns
If able, returns the CableCarrierPreferenceTableContainer from the project.

◆ GetDuctAngleSet()

Result< DuctAngleSet > ACAPI::MEP::GetDuctAngleSet ( )
inline
Returns
If able, returns the DuctAngleSet from the project.

◆ GetDuctBranchPreferenceTableContainer()

Result< DuctBranchPreferenceTableContainer > ACAPI::MEP::GetDuctBranchPreferenceTableContainer ( )
inline
Returns
If able, returns the DuctBranchPreferenceTableContainer from the project.

◆ GetDuctElbowPreferenceTableContainer()

Result< DuctElbowPreferenceTableContainer > ACAPI::MEP::GetDuctElbowPreferenceTableContainer ( )
inline
Returns
If able, returns the DuctElbowPreferenceTableContainer from the project.

◆ GetDuctReferenceSet()

Result< DuctReferenceSet > ACAPI::MEP::GetDuctReferenceSet ( )
inline
Returns
If able, returns the DuctReferenceSet from the project.

◆ GetDuctSegmentPreferenceTableContainer()

Result< DuctSegmentPreferenceTableContainer > ACAPI::MEP::GetDuctSegmentPreferenceTableContainer ( )
inline
Returns
If able, returns the DuctPreferenceTableContainer from the project.

◆ GetDuctTransitionPreferenceTableContainer()

Result< DuctTransitionPreferenceTableContainer > ACAPI::MEP::GetDuctTransitionPreferenceTableContainer ( )
inline
Returns
If able, returns the DuctTransitionPreferenceTableContainer from the project.

◆ GetMEPModelCheckTypeId()

MEPAPI_EXPORT API_Guid ACAPI::MEP::GetMEPModelCheckTypeId ( )
Since
Archicad 29
Returns
Returns the unique identifier of the MEP Model Check Type

◆ GetPipeAngleSet()

Result< PipeAngleSet > ACAPI::MEP::GetPipeAngleSet ( )
inline
Returns
If able, returns the PipeAngleSet from the project.

◆ GetPipeBranchPreferenceTableContainer()

Result< PipeBranchPreferenceTableContainer > ACAPI::MEP::GetPipeBranchPreferenceTableContainer ( )
inline
Returns
If able, returns the PipeBranchPreferenceTableContainer from the project.

◆ GetPipeElbowPreferenceTableContainer()

Result< PipeElbowPreferenceTableContainer > ACAPI::MEP::GetPipeElbowPreferenceTableContainer ( )
inline
Returns
If able, returns the PipeElbowPreferenceTableContainer from the project.

◆ GetPipeReferenceSet()

Result< PipeReferenceSet > ACAPI::MEP::GetPipeReferenceSet ( )
inline
Returns
If able, returns the PipeReferenceSet from the project.

◆ GetPipeSegmentPreferenceTableContainer()

Result< PipeSegmentPreferenceTableContainer > ACAPI::MEP::GetPipeSegmentPreferenceTableContainer ( )
inline
Returns
If able, returns the PipePreferenceTableContainer from the project.

◆ GetPipeTransitionPreferenceTableContainer()

Result< PipeTransitionPreferenceTableContainer > ACAPI::MEP::GetPipeTransitionPreferenceTableContainer ( )
inline
Returns
If able, returns the PipeTransitionPreferenceTableContainer from the project.

◆ GetSystemGroupIDs()

Result< std::vector< UniqueID > > ACAPI::MEP::GetSystemGroupIDs ( )
inline

Fetches the IDs of the current SystemGroups.

Returns
A list of the IDs of the current SystemGroups.
if (systemGroupIDs.IsErr ())
return systemGroupIDs.UnwrapErr ().kind;
for (const ACAPI::MEP::UniqueID& systemGroupID : systemGroupIDs.Unwrap ()) {

◆ IsAccessory()

MEPAPI_EXPORT bool ACAPI::MEP::IsAccessory ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Since
Archicad 26
Returns
Decides if the typeID belongs to an Accessory

◆ IsBranch()

MEPAPI_EXPORT bool ACAPI::MEP::IsBranch ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Since
Archicad 26
Returns
Decides if the typeID belongs to a Branch

◆ IsCableCarrier()

MEPAPI_EXPORT bool ACAPI::MEP::IsCableCarrier ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Since
Archicad 28
Returns
Decides if the typeID belongs to a Cable carrier

◆ IsElbow()

MEPAPI_EXPORT bool ACAPI::MEP::IsElbow ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Returns
Decides if the typeID belongs to an Elbow

◆ IsEquipment()

MEPAPI_EXPORT bool ACAPI::MEP::IsEquipment ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Since
Archicad 26
Returns
Decides if the typeID belongs to an Equipment

◆ IsFitting()

MEPAPI_EXPORT bool ACAPI::MEP::IsFitting ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Since
Archicad 26
Returns
Decides if the typeID belongs to a Fitting

◆ IsFlexibleSegment()

MEPAPI_EXPORT bool ACAPI::MEP::IsFlexibleSegment ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Returns
Decides if the typeID belongs to a FlexibleSegment

◆ IsPiping()

MEPAPI_EXPORT bool ACAPI::MEP::IsPiping ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Since
Archicad 28
Returns
Decides if the typeID belongs to a Piping

◆ IsRigidSegment()

MEPAPI_EXPORT bool ACAPI::MEP::IsRigidSegment ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Since
Archicad 26
Returns
Decides if the typeID belongs to a RigidSegment

◆ IsRoutingElement()

MEPAPI_EXPORT bool ACAPI::MEP::IsRoutingElement ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Since
Archicad 26
Returns
Decides if the typeID belongs to a RoutingElement

◆ IsTakeOff()

MEPAPI_EXPORT bool ACAPI::MEP::IsTakeOff ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Since
Archicad 28
Returns
Decides if the typeID belongs to a Take-off

◆ IsTerminal()

MEPAPI_EXPORT bool ACAPI::MEP::IsTerminal ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Since
Archicad 26
Returns
Decides if the typeID belongs to a Terminal

◆ IsTransition()

MEPAPI_EXPORT bool ACAPI::MEP::IsTransition ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Returns
Decides if the typeID belongs to a Transition

◆ IsVentilation()

MEPAPI_EXPORT bool ACAPI::MEP::IsVentilation ( const API_Guid & typeID)
Parameters
typeIDThe guid of the element type
Since
Archicad 28
Returns
Decides if the typeID belongs to a Ventilation

◆ RegisterCalculationCallback()

Result< void > ACAPI::MEP::RegisterCalculationCallback ( SystemBrowserCalculationCallbackInterface & callbackInterface)
inline

Registers a custom callback interface implementation.

Parameters
callbackInterfaceThe custom callback interface implementation to register.
Returns
Error if registration failed, otherwise nothing.
Since
Archicad 29
TestCalculationCallback testCallback;
if (result.IsErr ())
return result.UnwrapErr ().kind;

◆ UniqueID() [1/2]

ACAPI::MEP::Adapter::UniqueID::UniqueID ( const API_Guid & guid)
inline

Constructs a UniqueID from API_Guid.

Parameters
guidThe GUID to convert.

◆ UniqueID() [2/2]

ACAPI::MEP::Adapter::UniqueID::UniqueID ( const GS::Guid & guid)
inline

Constructs a UniqueID from GS::Guid.

Parameters
guidThe GUID to convert.