NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::AME::InterruptionPointBuilder Class Reference

Represents builder for AME::DB::InterruptionPoint
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateInterruptionPointBuilder

Created in NX12.0.0. More...

Inheritance diagram for NXOpen::AME::InterruptionPointBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Variant {
  VariantA, VariantB, VariantC, VariantD,
  VariantE, VariantF, VariantG, VariantH
}
 Represents Interruption Point Variant type. More...
 

Public Member Functions

NXString InterruptionPointName ()
 Returns the interruption point name
Created in NX12.0.0. More...
 
NXOpen::AME::InterruptionPointBuilder::Variant InterruptionPointVariant ()
 Returns the interrupt point variant
Created in NX12.0.0. More...
 
void SetDestinationInterruptionPoint (NXOpen::AME::AMEExtendedObject *interruptionPoint)
 Set the destination interruption point to link to
Created in NX12.0.0. More...
 
void SetInterruptionPointLocation (const NXOpen::Point2d &point, NXOpen::AME::PageObject *pageObject)
 Set node location of Interruption Point on page. More...
 
void SetInterruptionPointName (const NXString &interruptionPointName)
 Sets the interruption point name
Created in NX12.0.0. More...
 
void SetInterruptionPointName (const char *interruptionPointName)
 Sets the interruption point name
Created in NX12.0.0. More...
 
void SetInterruptionPointVariant (NXOpen::AME::InterruptionPointBuilder::Variant interruptionPointVariant)
 Sets the interrupt point variant
Created in NX12.0.0. More...
 
void SetStarSource (bool starSource)
 Set the interruption point type to star source
Created in NX12.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

Represents builder for AME::DB::InterruptionPoint
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateInterruptionPointBuilder

Created in NX12.0.0.


Member Enumeration Documentation

Represents Interruption Point Variant type.

Enumerator
VariantA 

a

VariantB 

b

VariantC 

c

VariantD 

d

VariantE 

e

VariantF 

f

VariantG 

g

VariantH 

h

Member Function Documentation

NXString NXOpen::AME::InterruptionPointBuilder::InterruptionPointName ( )

Returns the interruption point name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::InterruptionPointBuilder::Variant NXOpen::AME::InterruptionPointBuilder::InterruptionPointVariant ( )

Returns the interrupt point variant
Created in NX12.0.0.



License requirements : None

void NXOpen::AME::InterruptionPointBuilder::SetDestinationInterruptionPoint ( NXOpen::AME::AMEExtendedObject interruptionPoint)

Set the destination interruption point to link to
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
interruptionPointinterruptionpoint
void NXOpen::AME::InterruptionPointBuilder::SetInterruptionPointLocation ( const NXOpen::Point2d point,
NXOpen::AME::PageObject pageObject 
)

Set node location of Interruption Point on page.


Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
pointpoint
pageObjectpageobject
void NXOpen::AME::InterruptionPointBuilder::SetInterruptionPointName ( const NXString interruptionPointName)

Sets the interruption point name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
interruptionPointNameinterruptionpointname
void NXOpen::AME::InterruptionPointBuilder::SetInterruptionPointName ( const char *  interruptionPointName)

Sets the interruption point name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
interruptionPointNameinterruptionpointname
void NXOpen::AME::InterruptionPointBuilder::SetInterruptionPointVariant ( NXOpen::AME::InterruptionPointBuilder::Variant  interruptionPointVariant)

Sets the interrupt point variant
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
interruptionPointVariantinterruptionpointvariant
void NXOpen::AME::InterruptionPointBuilder::SetStarSource ( bool  starSource)

Set the interruption point type to star source
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
starSourcestarsource

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