NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::AME::PortBuilder Class Reference

builder for the software block properties dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreatePortBuilder

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::AME::PortBuilder:
NXOpen::AME::AMEBaseBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ConnectableAttrProxyObjectType { ConnectableAttrProxyObjectTypeAll, ConnectableAttrProxyObjectTypeLibrary, ConnectableAttrProxyObjectTypeTag }
 Represents the type of connectable attribute proxy object for typed port. More...
 
enum  CreationModeType { CreationModeTypeNew, CreationModeTypeLibrary }
 Represents the type of creation mode. More...
 
enum  Type {
  TypeAll, TypeCaller, TypeOperand, TypeMethod,
  TypeBlock
}
 the type of a port More...
 

Public Member Functions

NXOpen::AME::PortBuilder::ConnectableAttrProxyObjectType ConnectableProxyObjectType ()
 Returns the connectable object type
Created in NX12.0.0. More...
 
NXOpen::AME::PortBuilder::CreationModeType CreationMode ()
 Returns the creation mode
Created in NX11.0.0. More...
 
NXOpen::AME::SelectionEngineeringObjectDefinitionBuilderEngObjectType ()
 Returns the engineering object type
Created in NX12.0.0. More...
 
NXString PortClassId ()
 Returns the classification id of port
Created in NX1847.0.0. More...
 
NXString PortName ()
 Returns the name of port
Created in NX11.0.0. More...
 
NXString PortType ()
 Returns the type of port
Created in NX11.0.0. More...
 
NXOpen::Tooling::SelectReuseLibraryItemBuilderReuseLibraryItem ()
 Returns the reuse library item
Created in NX11.0.0. More...
 
void SetConnectableProxyObjectType (NXOpen::AME::PortBuilder::ConnectableAttrProxyObjectType connectableAttrObjectType)
 Sets the connectable object type
Created in NX12.0.0. More...
 
void SetCreationMode (NXOpen::AME::PortBuilder::CreationModeType creationMode)
 Sets the creation mode
Created in NX11.0.0. More...
 
void SetPortCardinality (const NXString &portCardinality)
 Set the cardinality
Created in NX11.0.0. More...
 
void SetPortCardinality (const char *portCardinality)
 Set the cardinality
Created in NX11.0.0. More...
 
void SetPortClassId (const NXString &type)
 Sets the classification id of port
Created in NX1847.0.0. More...
 
void SetPortClassId (const char *type)
 Sets the classification id of port
Created in NX1847.0.0. More...
 
void SetPortDirection (const NXString &portDirection)
 Set the direction
Created in NX11.0.0. More...
 
void SetPortDirection (const char *portDirection)
 Set the direction
Created in NX11.0.0. More...
 
void SetPortName (const NXString &portName)
 Sets the name of port
Created in NX11.0.0. More...
 
void SetPortName (const char *portName)
 Sets the name of port
Created in NX11.0.0. More...
 
void SetPortType (const NXString &type)
 Sets the type of port
Created in NX11.0.0. More...
 
void SetPortType (const char *type)
 Sets the type of port
Created in NX11.0.0. More...
 

Detailed Description

builder for the software block properties dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreatePortBuilder

Created in NX11.0.0.


Member Enumeration Documentation

Represents the type of connectable attribute proxy object for typed port.

Enumerator
ConnectableAttrProxyObjectTypeAll 

all

ConnectableAttrProxyObjectTypeLibrary 

library

ConnectableAttrProxyObjectTypeTag 

tag

Represents the type of creation mode.

Enumerator
CreationModeTypeNew 

new

CreationModeTypeLibrary 

library

the type of a port

Enumerator
TypeAll 

all

TypeCaller 

caller

TypeOperand 

operand

TypeMethod 

method

TypeBlock 

block

Member Function Documentation

NXOpen::AME::PortBuilder::ConnectableAttrProxyObjectType NXOpen::AME::PortBuilder::ConnectableProxyObjectType ( )

Returns the connectable object type
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::PortBuilder::CreationModeType NXOpen::AME::PortBuilder::CreationMode ( )

Returns the creation mode
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectionEngineeringObjectDefinitionBuilder* NXOpen::AME::PortBuilder::EngObjectType ( )

Returns the engineering object type
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::PortBuilder::PortClassId ( )

Returns the classification id of port
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::PortBuilder::PortName ( )

Returns the name of port
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::PortBuilder::PortType ( )

Returns the type of port
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::Tooling::SelectReuseLibraryItemBuilder* NXOpen::AME::PortBuilder::ReuseLibraryItem ( )

Returns the reuse library item
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::PortBuilder::SetConnectableProxyObjectType ( NXOpen::AME::PortBuilder::ConnectableAttrProxyObjectType  connectableAttrObjectType)

Sets the connectable object type
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
connectableAttrObjectTypeconnectableattrobjecttype
void NXOpen::AME::PortBuilder::SetCreationMode ( NXOpen::AME::PortBuilder::CreationModeType  creationMode)

Sets the creation mode
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
creationModecreationmode
void NXOpen::AME::PortBuilder::SetPortCardinality ( const NXString portCardinality)

Set the cardinality
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
portCardinalityportcardinality
void NXOpen::AME::PortBuilder::SetPortCardinality ( const char *  portCardinality)

Set the cardinality
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
portCardinalityportcardinality
void NXOpen::AME::PortBuilder::SetPortClassId ( const NXString type)

Sets the classification id of port
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
typetype
void NXOpen::AME::PortBuilder::SetPortClassId ( const char *  type)

Sets the classification id of port
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
typetype
void NXOpen::AME::PortBuilder::SetPortDirection ( const NXString portDirection)

Set the direction
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
portDirectionportdirection
void NXOpen::AME::PortBuilder::SetPortDirection ( const char *  portDirection)

Set the direction
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
portDirectionportdirection
void NXOpen::AME::PortBuilder::SetPortName ( const NXString portName)

Sets the name of port
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
portNameportname
void NXOpen::AME::PortBuilder::SetPortName ( const char *  portName)

Sets the name of port
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
portNameportname
void NXOpen::AME::PortBuilder::SetPortType ( const NXString type)

Sets the type of port
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
typetype
void NXOpen::AME::PortBuilder::SetPortType ( const char *  type)

Sets the type of port
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
typetype

The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.