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

Represents a NXOpen::CAE::BcLabelManagerBuilder builder which can be used to renumber NXOpen::CAE::SimBC id. More...

Inheritance diagram for NXOpen::CAE::BcLabelManagerBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  RenumberType { RenumberTypeRenumber, RenumberTypeOffset }
 Renumber Method. More...
 

Public Member Functions

void GetBcTags (std::vector< NXOpen::CAE::SimBC * > &bcTags)
 A value indicating the list of tags of BC to renumber
Created in NX11.0.0. More...
 
int NumOfBc ()
 Returns a value indicating the number of BC to renumber
Created in NX11.0.0. More...
 
NXOpen::CAE::BcLabelManagerBuilder::RenumberType RenumberMethod ()
 Returns a value indicating renumber method
Created in NX11.0.0. More...
 
int RenumberStartValue ()
 Returns a value indicating the number to offset by or renumber from
Created in NX11.0.0. More...
 
void SetBcTags (const std::vector< NXOpen::CAE::SimBC * > &bcTags)
 Sets tags of BC to renumber
Created in NX11.0.0. More...
 
void SetNumOfBc (int numOfBc)
 Sets a value indicating the number of BC to renumber
Created in NX11.0.0. More...
 
void SetRenumberMethod (NXOpen::CAE::BcLabelManagerBuilder::RenumberType renumberMethod)
 Sets a value indicating renumber method
Created in NX11.0.0. More...
 
void SetRenumberStartValue (int renumberStartValue)
 Sets a value indicating the number to offset by or renumber from
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

Represents a NXOpen::CAE::BcLabelManagerBuilder builder which can be used to renumber NXOpen::CAE::SimBC id.

This is limited to NXOpen::CAE::SimBC objects in the active solution.
To create a new instance of this class, use NXOpen::CAE::SimSimulation::CreateBcLabelManagerBuilder

Created in NX11.0.0.

Member Enumeration Documentation

Renumber Method.

Enumerator
RenumberTypeRenumber 

All the selected BC ID will be renumbered strarting from this number.

RenumberTypeOffset 

All the selected BC ID will offset by this number.

Member Function Documentation

void NXOpen::CAE::BcLabelManagerBuilder::GetBcTags ( std::vector< NXOpen::CAE::SimBC * > &  bcTags)

A value indicating the list of tags of BC to renumber
Created in NX11.0.0.



License requirements : None

Parameters
bcTagsbctags
int NXOpen::CAE::BcLabelManagerBuilder::NumOfBc ( )

Returns a value indicating the number of BC to renumber
Created in NX11.0.0.



License requirements : None

NXOpen::CAE::BcLabelManagerBuilder::RenumberType NXOpen::CAE::BcLabelManagerBuilder::RenumberMethod ( )

Returns a value indicating renumber method
Created in NX11.0.0.



License requirements : None

int NXOpen::CAE::BcLabelManagerBuilder::RenumberStartValue ( )

Returns a value indicating the number to offset by or renumber from
Created in NX11.0.0.



License requirements : None

void NXOpen::CAE::BcLabelManagerBuilder::SetBcTags ( const std::vector< NXOpen::CAE::SimBC * > &  bcTags)

Sets tags of BC to renumber
Created in NX11.0.0.



License requirements : None

Parameters
bcTagsbctags
void NXOpen::CAE::BcLabelManagerBuilder::SetNumOfBc ( int  numOfBc)

Sets a value indicating the number of BC to renumber
Created in NX11.0.0.



License requirements : None

Parameters
numOfBcnumofbc
void NXOpen::CAE::BcLabelManagerBuilder::SetRenumberMethod ( NXOpen::CAE::BcLabelManagerBuilder::RenumberType  renumberMethod)

Sets a value indicating renumber method
Created in NX11.0.0.



License requirements : None

Parameters
renumberMethodrenumbermethod
void NXOpen::CAE::BcLabelManagerBuilder::SetRenumberStartValue ( int  renumberStartValue)

Sets a value indicating the number to offset by or renumber from
Created in NX11.0.0.



License requirements : None

Parameters
renumberStartValuerenumberstartvalue

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