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

JA class for the reuse rule dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateInstanceDataBlockBuilder

Created in NX11.0.0. More...

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

Public Types

enum  ActionType { ActionTypeGlobal, ActionTypeLocal }
 the idb scope More...
 
enum  CreateMode { CreateModeAspect, CreateModeLibrary }
 the idb create mode More...
 

Public Member Functions

NXOpen::AME::EODataItemAttributeHolderEoDataItemAttributeHolder ()
 Returns the data item
Created in NX11.0.0. More...
 
NXString InstanceDescription ()
 Returns the defined idb text description
Created in NX11.0.0. More...
 
NXString InstanceName ()
 Returns the defined idb text name
Created in NX11.0.0. More...
 
NXOpen::AME::SelectAMEBaseNodeSelectedBlock ()
 Returns the PlcBlock selection
Created in NX11.0.0. More...
 
NXOpen::AME::SelectAspectNodeSelectedEngObject ()
 Returns the EngObject selection
Created in NX11.0.0. More...
 
NXOpen::Tooling::SelectReuseLibraryItemBuilderSelectedFBFromLibrary ()
 Returns the library pou selection
Created in NX11.0.0. More...
 
void SetInstanceDescription (const NXString &resultText)
 Sets the defined idb text description
Created in NX11.0.0. More...
 
void SetInstanceDescription (const char *resultText)
 Sets the defined idb text description
Created in NX11.0.0. More...
 
void SetInstanceName (const NXString &resultText)
 Sets the defined idb text name
Created in NX11.0.0. More...
 
void SetInstanceName (const char *resultText)
 Sets the defined idb text name
Created in NX11.0.0. More...
 
void SetSymbolicName (const NXString &symbolicName)
 Updates the idb symbolic name
Created in NX12.0.0. More...
 
void SetSymbolicName (const char *symbolicName)
 Updates the idb symbolic name
Created in NX12.0.0. More...
 
void SetTypeOfIDB (NXOpen::AME::InstanceDataBlockBuilder::ActionType type)
 Sets the defined rule type
Created in NX11.0.0. More...
 
NXOpen::AME::InstanceDataBlockBuilder::ActionType TypeOfIDB ()
 Returns the defined rule type
Created in NX11.0.0. More...
 
void UpdateSourceBlock (NXOpen::AME::PlcBlock *selBlock)
 Updates the source block selection
Created in NX11.0.0. More...
 
void UpdateSourceBlockByName (const NXString &fileName)
 Updates the source block by using given file name of reuse library item
Created in NX11.0.0. More...
 
void UpdateSourceBlockByName (const char *fileName)
 Updates the source block by using given file name of reuse library item
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

JA class for the reuse rule dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateInstanceDataBlockBuilder

Created in NX11.0.0.


Member Enumeration Documentation

the idb scope

Enumerator
ActionTypeGlobal 

global

ActionTypeLocal 

local

the idb create mode

Enumerator
CreateModeAspect 

aspect

CreateModeLibrary 

library

Member Function Documentation

NXOpen::AME::EODataItemAttributeHolder* NXOpen::AME::InstanceDataBlockBuilder::EoDataItemAttributeHolder ( )

Returns the data item
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::InstanceDataBlockBuilder::InstanceDescription ( )

Returns the defined idb text description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::InstanceDataBlockBuilder::InstanceName ( )

Returns the defined idb text name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectAMEBaseNode* NXOpen::AME::InstanceDataBlockBuilder::SelectedBlock ( )

Returns the PlcBlock selection
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectAspectNode* NXOpen::AME::InstanceDataBlockBuilder::SelectedEngObject ( )

Returns the EngObject selection
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::Tooling::SelectReuseLibraryItemBuilder* NXOpen::AME::InstanceDataBlockBuilder::SelectedFBFromLibrary ( )

Returns the library pou selection
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::InstanceDataBlockBuilder::SetInstanceDescription ( const NXString resultText)

Sets the defined idb text description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
resultTextresulttext
void NXOpen::AME::InstanceDataBlockBuilder::SetInstanceDescription ( const char *  resultText)

Sets the defined idb text description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
resultTextresulttext
void NXOpen::AME::InstanceDataBlockBuilder::SetInstanceName ( const NXString resultText)

Sets the defined idb text name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
resultTextresulttext
void NXOpen::AME::InstanceDataBlockBuilder::SetInstanceName ( const char *  resultText)

Sets the defined idb text name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
resultTextresulttext
void NXOpen::AME::InstanceDataBlockBuilder::SetSymbolicName ( const NXString symbolicName)

Updates the idb symbolic name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
symbolicNamesymbolicname
void NXOpen::AME::InstanceDataBlockBuilder::SetSymbolicName ( const char *  symbolicName)

Updates the idb symbolic name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
symbolicNamesymbolicname
void NXOpen::AME::InstanceDataBlockBuilder::SetTypeOfIDB ( NXOpen::AME::InstanceDataBlockBuilder::ActionType  type)

Sets the defined rule type
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
typetype
NXOpen::AME::InstanceDataBlockBuilder::ActionType NXOpen::AME::InstanceDataBlockBuilder::TypeOfIDB ( )

Returns the defined rule type
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::InstanceDataBlockBuilder::UpdateSourceBlock ( NXOpen::AME::PlcBlock selBlock)

Updates the source block selection
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
selBlockselblock
void NXOpen::AME::InstanceDataBlockBuilder::UpdateSourceBlockByName ( const NXString fileName)

Updates the source block by using given file name of reuse library item
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fileNamefilename
void NXOpen::AME::InstanceDataBlockBuilder::UpdateSourceBlockByName ( const char *  fileName)

Updates the source block by using given file name of reuse library item
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fileNamefilename

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