NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::PLAS::RunBuilder Class Reference

Represents a RunBuilder. More...

Inheritance diagram for NXOpen::PLAS::RunBuilder:
NXOpen::Builder NXOpen::IAttributeSourceObjectBuilder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

virtual NXOpen::ErrorListAutoAssignAttributes (const std::vector< NXOpen::NXObject * > &objects)
 Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign. More...
 
virtual NXOpen::ErrorListAutoAssignAttributesWithNamingPattern (const std::vector< NXOpen::NXObject * > &objects, const std::vector< NXOpen::NXObject * > &properties)
 Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign. More...
 
virtual NXOpen::NXObjectCreateAttributeTitleToNamingPatternMap (std::vector< NXString > &attributeTitles, std::vector< NXString > &titlePatterns)
 Creates a map object of attribute titles to their corresponding naming pattern. More...
 
NXOpen::PDM::LogicalObjectGetLogicalObject ()
 Gets the known logical object. More...
 
bool IsUnassigned ()
 Returns whether the run is unassigned
Created in NX12.0.0. More...
 
NXString LineTypePathId ()
 Returns the line type path ID of the run. More...
 
NXString ObjectApplication ()
 Returns the application name of the run. More...
 
NXString PipeSpecPathId ()
 Returns the pipe specification object of this run. More...
 
void SetLineTypePathId (const NXString &lineTypePathId)
 Sets the line type path ID of the run. More...
 
void SetLineTypePathId (const char *lineTypePathId)
 Sets the line type path ID of the run. More...
 
void SetObjectApplication (const NXString &objectApplication)
 Sets the application name of the run. More...
 
void SetObjectApplication (const char *objectApplication)
 Sets the application name of the run. More...
 
void SetPipeSpecPathId (const NXString &pipeSpecPathId)
 Sets the pipe specification object of this run. More...
 
void SetPipeSpecPathId (const char *pipeSpecPathId)
 Sets the pipe specification object of this run. More...
 
void SetUnassigned (bool isUnassigned)
 Sets whether the run is unassigned
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 a RunBuilder.


To create a new instance of this class, use NXOpen::PLAS::PlasManager::CreateRunBuilder

Created in NX11.0.1.

Member Function Documentation

virtual NXOpen::ErrorList* NXOpen::PLAS::RunBuilder::AutoAssignAttributes ( const std::vector< NXOpen::NXObject * > &  objects)
virtual

Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
objectsobjects

Implements NXOpen::IAttributeSourceObjectBuilder.

virtual NXOpen::ErrorList* NXOpen::PLAS::RunBuilder::AutoAssignAttributesWithNamingPattern ( const std::vector< NXOpen::NXObject * > &  objects,
const std::vector< NXOpen::NXObject * > &  properties 
)
virtual

Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.

properties needs to be created using CreateAttributeTitleToNamingPatternMap

Returns

Created in NX12.0.0.

License requirements : None
Parameters
objectsobjects
propertiesproperties

Implements NXOpen::IAttributeSourceObjectBuilder.

virtual NXOpen::NXObject* NXOpen::PLAS::RunBuilder::CreateAttributeTitleToNamingPatternMap ( std::vector< NXString > &  attributeTitles,
std::vector< NXString > &  titlePatterns 
)
virtual

Creates a map object of attribute titles to their corresponding naming pattern.

Returns

Created in NX12.0.0.

License requirements : None
Parameters
attributeTitlesattributetitles
titlePatternstitlepatterns

Implements NXOpen::IAttributeSourceObjectBuilder.

NXOpen::PDM::LogicalObject* NXOpen::PLAS::RunBuilder::GetLogicalObject ( )

Gets the known logical object.

Returns

Created in NX11.0.1.

License requirements : None
bool NXOpen::PLAS::RunBuilder::IsUnassigned ( )

Returns whether the run is unassigned
Created in NX12.0.0.



License requirements : None

NXString NXOpen::PLAS::RunBuilder::LineTypePathId ( )

Returns the line type path ID of the run.


Created in NX11.0.1.

License requirements : None

NXString NXOpen::PLAS::RunBuilder::ObjectApplication ( )

Returns the application name of the run.


Created in NX11.0.1.

License requirements : None

NXString NXOpen::PLAS::RunBuilder::PipeSpecPathId ( )

Returns the pipe specification object of this run.


Created in NX11.0.1.

License requirements : None

void NXOpen::PLAS::RunBuilder::SetLineTypePathId ( const NXString lineTypePathId)

Sets the line type path ID of the run.


Created in NX11.0.1.

License requirements : None

Parameters
lineTypePathIdlinetypepathid
void NXOpen::PLAS::RunBuilder::SetLineTypePathId ( const char *  lineTypePathId)

Sets the line type path ID of the run.


Created in NX11.0.1.

License requirements : None

Parameters
lineTypePathIdlinetypepathid
void NXOpen::PLAS::RunBuilder::SetObjectApplication ( const NXString objectApplication)

Sets the application name of the run.


Created in NX11.0.1.

License requirements : None

Parameters
objectApplicationobjectapplication
void NXOpen::PLAS::RunBuilder::SetObjectApplication ( const char *  objectApplication)

Sets the application name of the run.


Created in NX11.0.1.

License requirements : None

Parameters
objectApplicationobjectapplication
void NXOpen::PLAS::RunBuilder::SetPipeSpecPathId ( const NXString pipeSpecPathId)

Sets the pipe specification object of this run.


Created in NX11.0.1.

License requirements : None

Parameters
pipeSpecPathIdpipespecpathid
void NXOpen::PLAS::RunBuilder::SetPipeSpecPathId ( const char *  pipeSpecPathId)

Sets the pipe specification object of this run.


Created in NX11.0.1.

License requirements : None

Parameters
pipeSpecPathIdpipespecpathid
void NXOpen::PLAS::RunBuilder::SetUnassigned ( bool  isUnassigned)

Sets whether the run is unassigned
Created in NX12.0.0.



License requirements : None

Parameters
isUnassignedisunassigned

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