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

Classes
class	ACAPI::MEP::v1::Accessory
	The Accessory is a complex element with two ports on a single axis. More...

class	ACAPI::MEP::v1::AccessoryDefault
	The AccessoryDefault contains the necessary non-geometric data for creating an Accessory element. 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::v1::Bend
	The Bend can connect two straight RoutingSegments with the same dimensions but different directions. More...

class	ACAPI::MEP::v1::BendDefault
	The BendDefault contains the necessary non-geometric data for modifying a Bend. More...

class	ACAPI::MEP::v1::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::v1::BranchDefault

class	ACAPI::MEP::v1::CableCarrierPort
	The CableCarrierPort represents a connection point of a cable carrier. More...

class	ACAPI::MEP::v1::CableCarrierPreferenceTableContainer
	The CableCarrierPreferenceTableContainer can contain several PreferenceTableBase associated with cable carriers. More...

class	ACAPI::MEP::v1::DuctPreferenceTableContainer
	The DuctPreferenceTableContainer can contain several PreferenceTableBase associated with ventilation. More...

class	ACAPI::MEP::v1::Element
	The Element represents an instantiable ElementBase. More...

class	ACAPI::MEP::v1::ElementBase

class	ACAPI::MEP::v1::ElementDefault
	The ElementDefault contains the necessary non-geometric data for creating a MEP element. More...

class	ACAPI::MEP::v1::Equipment
	The Equipment is a complex element with more than two ports. More...

class	ACAPI::MEP::v1::EquipmentDefault
	The EquipmentDefault contains the necessary non-geometric data for creating an Equipment element. More...

class	ACAPI::MEP::v1::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::v1::FittingDefault
	The FittingDefault contains the necessary non-geometric data for creating a Fitting element. More...

class	ACAPI::MEP::v1::FlexibleSegment
	In contrast to rigid segments flexible duct is not a connection of multiple elements (straight segments and bends), instead a type of ducting pipe that could easily be bent in different angles. More...

class	ACAPI::MEP::v1::FlexibleSegmentDefault
	The FlexibleSegmentDefault contains the necessary non-geometric data for creating a FlexibleSegment element. More...

class	ACAPI::MEP::v1::ModifiableElement
	The Modifiable Element represents an instantiable ModifiableElementBase. More...

class	ACAPI::MEP::v1::ModifiableElementBase
	The ModifiableElementBase contains the available modifying actions for ElementBase. More...

class	ACAPI::MEP::v1::PipePreferenceTableContainer
	The PipePreferenceTableContainer can contain several PreferenceTableBase associated with piping. More...

class	ACAPI::MEP::v1::PipingPort
	The PipingPort represents a connection point of a pipe segment. More...

class	ACAPI::MEP::v1::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::v1::PortBase
	The Port is associated to an element and it represents a point between elements. More...

class	ACAPI::MEP::v1::PreferenceTableBase
	The PreferenceTableBase represents a named entity, that contains inner tables associated with cross section shapes and these table 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::v1::PreferenceTableContainerBase
	The PreferenceTableContainerBase contains PreferenceTables, and you can Add/Get/Delete them. More...

class	ACAPI::MEP::v1::RigidSegment
	The RigidSegment is placed in RoutingSegments. More...

class	ACAPI::MEP::v1::RigidSegmentDefault
	The RigidSegmentDefault contains the necessary non-geometric data for creating a RigidSegment element. More...

class	ACAPI::MEP::v1::RoutingElement
	The RoutingElement can contain Routing Segments and Routing Nodes. More...

class	ACAPI::MEP::v1::RoutingElementDefault
	The RoutingElementDefault contains the necessary non-geometric data for creating a Routing element. More...

class	ACAPI::MEP::v1::RoutingNode
	The RoutingNode can contain Bend and Transition elements. More...

class	ACAPI::MEP::v1::RoutingNodeDefault
	The RoutingNodeDefault contains the necessary non-geometric data for creating and modifying a Routing Node. More...

class	ACAPI::MEP::v1::RoutingSegment
	The RoutingSegment can contain Rigid Segment elements. More...

class	ACAPI::MEP::v1::RoutingSegmentDefault
	The RoutingSegmentDefault contains the necessary non-geometric data for creating and modifying a Routing Segment. More...

class	ACAPI::MEP::v1::Terminal
	The Terminal is a complex element with a single port. More...

class	ACAPI::MEP::v1::TerminalDefault
	The TerminalDefault contains the necessary non-geometric data for creating a Terminal element. More...

class	ACAPI::MEP::v1::Transition
	The Transition is an element that connects two different Routing Segments. More...

class	ACAPI::MEP::v1::TransitionDefault
	The TransitionDefault contains the necessary non-geometric data for creating and modifying a Transition. More...

class	ACAPI::MEP::UniqueID

class	ACAPI::MEP::v1::VentilationPort
	The VentilationPort represents a connection point of a duct. More...

struct	ACAPI::MEP::Orientation
	Defines the orientation with the help of a direction and rotation vector. More...

struct	ACAPI::MEP::RoutingSegmentCrossSectionData
	Defines the necessary data for placing RoutingSegments of a RouteElement. More...

Enumerations
enum class	Domain { Ventilation , Piping , CableCarrier }

enum class	ConnectorShape { Rectangular , Circular , UShape }

enum class	ConnectionStyle { NoConnector , Flanged , Overlap }

enum class	FlowDirection { FlowNotDefined , FlowIn , FlowOut }

enum class	ConnectionSex { Unisex , Male , Female }

enum class	PreferredTransitionPlacement { SmallToLarge , LargeToSmall }

enum class	PreferenceTableShape { Rectangular , Circular }

Functions
Result< AccessoryDefault >	ACAPI::MEP::CreateAccessoryDefault (Domain domain)
	Creates an AccessoryDefault.

MEPAPI_EXPORT GS::UniString	ACAPI::MEP::GetLocalizedElemTypeName (const API_Guid &typeID)
	Returns the localized name of MEP element types.

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::IsBend (const API_Guid &typeID)

MEPAPI_EXPORT bool	ACAPI::MEP::IsTransition (const API_Guid &typeID)

MEPAPI_EXPORT bool	ACAPI::MEP::IsFlexibleSegment (const API_Guid &typeID)

Result< BendDefault >	ACAPI::MEP::CreateBendDefault (Domain domain)
	Creates a BendDefault.

Result< BranchDefault >	ACAPI::MEP::CreateBranchDefault (Domain domain)
	Creates a BranchDefault.

Result< CableCarrierPreferenceTableContainer >	ACAPI::MEP::GetCableCarrierPreferenceTableContainer ()

Result< DuctPreferenceTableContainer >	ACAPI::MEP::GetDuctPreferenceTableContainer ()

Result< EquipmentDefault >	ACAPI::MEP::CreateEquipmentDefault ()
	Creates an EquipmentDefault.

Result< FittingDefault >	ACAPI::MEP::CreateFittingDefault (Domain domain)
	Creates an FittingDefault.

Result< FlexibleSegmentDefault >	ACAPI::MEP::CreateFlexibleSegmentDefault ()
	Creates a FlexibleSegmentDefault.

Result< PipePreferenceTableContainer >	ACAPI::MEP::GetPipePreferenceTableContainer ()

Result< RigidSegmentDefault >	ACAPI::MEP::CreateRigidSegmentDefault (Domain domain)
	Creates a RigidSegmentDefault.

Result< RoutingElementDefault >	ACAPI::MEP::CreateRoutingElementDefault (Domain domain)
	Creates a RoutingElementDefault.

Result< RoutingNodeDefault >	ACAPI::MEP::CreateRoutingNodeDefault (Domain domain)
	Creates a RoutingNodeDefault.

Result< RoutingSegmentDefault >	ACAPI::MEP::CreateRoutingSegmentDefault (Domain domain)
	Creates a RoutingSegmentDefault.

Result< TerminalDefault >	ACAPI::MEP::CreateTerminalDefault (Domain domain)
	Creates a TerminalDefault.

Result< TransitionDefault >	ACAPI::MEP::CreateTransitionDefault (Domain domain)
	Creates a TransitionDefault.

Detailed Description

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

Function Documentation

◆ CreateAccessoryDefault()

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

inline

Creates an AccessoryDefault.

Parameters

domain The 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).

◆ CreateBendDefault()

Result< BendDefault > ACAPI::MEP::v1::CreateBendDefault ( Domain domain )

inline

Creates a BendDefault.

Parameters

domain The Domain of the requested BendDefault.

Returns: If able, returns a copy of Archicad's current Default of the Bend from the Routing tool for the domain defined by the parameter, otherwise Error.

◆ CreateBranchDefault()

Result< BranchDefault > ACAPI::MEP::v1::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

domain The 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

◆ CreateEquipmentDefault()

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

inline

Creates an EquipmentDefault.

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

◆ CreateFittingDefault()

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

inline

Creates an FittingDefault.

Parameters

domain The 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.

◆ CreateFlexibleSegmentDefault()

Result< FlexibleSegmentDefault > ACAPI::MEP::v1::CreateFlexibleSegmentDefault ( )

inline

Creates a FlexibleSegmentDefault.

Returns: If able, returns a copy of Archicad's current Default of the Duct (Ventilation) FlexibleSegment tool, otherwise Error.

◆ CreateRigidSegmentDefault()

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

inline

Creates a RigidSegmentDefault.

Parameters

domain The Domain of the requested RigidSegmentDefault.

Returns: If able, returns a copy of Archicad's current Default of the RigidSegment from the Routing tool for the domain defined by the parameter, otherwise Error.

◆ CreateRoutingElementDefault()

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

inline

Creates a RoutingElementDefault.

Parameters

domain The Domain of the requested RoutingElementDefault.

Returns: If able, returns a copy of Archicad's current Default of the Routing tool for the domain defined by the parameter, otherwise Error.

◆ CreateRoutingNodeDefault()

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

inline

Creates a RoutingNodeDefault.

Parameters

domain The Domain of the requested RoutingNodeDefault.

Returns: If able, returns a copy of Archicad's current Default of the RoutingNode from the Routing tool for the domain defined by the parameter, otherwise Error.

◆ CreateRoutingSegmentDefault()

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

inline

Creates a RoutingSegmentDefault.

Parameters

domain The Domain of the requested RoutingSegmentDefault.

Returns: If able, returns a copy of Archicad's current Default of the RoutingSegment from the Routing tool for the domain defined by the parameter, otherwise Error.

◆ CreateTerminalDefault()

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

inline

Creates a TerminalDefault.

Parameters

domain The 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).

◆ CreateTransitionDefault()

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

inline

Creates a TransitionDefault.

Parameters

domain The Domain of the requested TransitionDefault.

Returns: If able, returns a copy of Archicad's current Default of the Transition from the Routing tool for the domain defined by the parameter, otherwise Error.

◆ GetCableCarrierPreferenceTableContainer()

Result< CableCarrierPreferenceTableContainer > ACAPI::MEP::v1::GetCableCarrierPreferenceTableContainer ( )

inline

Returns: If able, returns the CableCarrierPreferenceTableContainer from the project.

◆ GetDuctPreferenceTableContainer()

Result< DuctPreferenceTableContainer > ACAPI::MEP::v1::GetDuctPreferenceTableContainer ( )

inline

Returns: If able, returns the DuctPreferenceTableContainer from the project.

◆ GetLocalizedElemTypeName()

MEPAPI_EXPORT GS::UniString ACAPI::MEP::GetLocalizedElemTypeName ( const API_Guid & typeID )

Returns the localized name of MEP element types.

Since: Archicad 26

Parameters

typeID The guid of the element type

Returns: If the typeID belongs to an MEP element, it returns its name, otherwise an empty string.

◆ GetPipePreferenceTableContainer()

Result< PipePreferenceTableContainer > ACAPI::MEP::v1::GetPipePreferenceTableContainer ( )

inline

Returns: If able, returns the PipePreferenceTableContainer from the project.

◆ IsAccessory()

MEPAPI_EXPORT bool ACAPI::MEP::IsAccessory ( const API_Guid & typeID )

Parameters

typeID The guid of the element type

Since: Archicad 26

Returns: Decides if the typeID belongs to an Accessory

◆ IsBend()

MEPAPI_EXPORT bool ACAPI::MEP::IsBend ( const API_Guid & typeID )

Parameters

typeID The guid of the element type

Returns: Decides if the typeID belongs to a Bend

◆ IsBranch()

MEPAPI_EXPORT bool ACAPI::MEP::IsBranch ( const API_Guid & typeID )

Parameters

typeID The guid of the element type

Since: Archicad 26

Returns: Decides if the typeID belongs to a Branch

◆ IsEquipment()

MEPAPI_EXPORT bool ACAPI::MEP::IsEquipment ( const API_Guid & typeID )

Parameters

typeID The 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

typeID The 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

typeID The guid of the element type

Returns: Decides if the typeID belongs to a FlexibleSegment

◆ IsRigidSegment()

MEPAPI_EXPORT bool ACAPI::MEP::IsRigidSegment ( const API_Guid & typeID )

Parameters

typeID The 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

typeID The guid of the element type

Since: Archicad 26

Returns: Decides if the typeID belongs to a RoutingElement

◆ IsTerminal()

MEPAPI_EXPORT bool ACAPI::MEP::IsTerminal ( const API_Guid & typeID )

Parameters

typeID The 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

typeID The guid of the element type

Returns: Decides if the typeID belongs to a Transition

Classes

Enumerations

Functions

Detailed Description

Function Documentation

◆ CreateAccessoryDefault()

◆ CreateBendDefault()

◆ CreateBranchDefault()

◆ CreateEquipmentDefault()

◆ CreateFittingDefault()

◆ CreateFlexibleSegmentDefault()

◆ CreateRigidSegmentDefault()

◆ CreateRoutingElementDefault()

◆ CreateRoutingNodeDefault()

◆ CreateRoutingSegmentDefault()

◆ CreateTerminalDefault()

◆ CreateTransitionDefault()

◆ GetCableCarrierPreferenceTableContainer()

◆ GetDuctPreferenceTableContainer()

◆ GetLocalizedElemTypeName()

◆ GetPipePreferenceTableContainer()

◆ IsAccessory()

◆ IsBend()

◆ IsBranch()

◆ IsEquipment()

◆ IsFitting()

◆ IsFlexibleSegment()

◆ IsRigidSegment()

◆ IsRoutingElement()

◆ IsTerminal()

◆ IsTransition()