NX Open C++ Reference Guide
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::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...
 
NXOpen::AME::PortAttributeHolderPortAttributeHolder ()
 Returns the port attribute holder
Created in NX12.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 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...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. 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")

NXOpen::AME::PortAttributeHolder* NXOpen::AME::PortBuilder::PortAttributeHolder ( )

Returns the port attribute holder
Created in NX12.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::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 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.