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

Represents a NXOpen::Features::MathIntegration builder
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateMathIntegrationBuilder
Default values. More...

Inheritance diagram for NXOpen::Features::MathIntegrationBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  AssociativityTypes { AssociativityTypesNone, AssociativityTypesNew, AssociativityTypesExisting }
 the associativity More...
 
enum  LocationTypes { LocationTypesOperatingSystem, LocationTypesTeamcenter, LocationTypesEmbedded }
 The option to specify where the Symbolica or Maple worksheet exists. More...
 

Public Member Functions

bool Associative ()
 Returns the associativity of the expression in the feature to the Symbolica or Maple worksheet
Created in NX12.0.0. More...
 
NXOpen::Features::MathIntegrationBuilder::AssociativityTypes AssociativityType ()
 Returns the option to control associativity to the equation
Created in NX12.0.0. More...
 
int EmbeddedWorksheet ()
 Returns the currently selected embedded worksheet index. More...
 
bool EmbedWorksheet ()
 Returns the option to embed worksheet in the feature
Created in NX12.0.0. More...
 
NXString FileBrowser ()
 Returns the file name returned by the Browser
Created in NX12.0.0. More...
 
std::vector< NXOpen::Expression * > GetExpressions ()
 The array of expressions. More...
 
std::vector< NXStringGetMathNames ()
 The array of math names. More...
 
int Inputs ()
 Returns the number of input expressions
Created in NX12.0.0. More...
 
NXOpen::Features::MathIntegrationBuilder::LocationTypes Location ()
 Returns the source location of the Symbolica or Maple worksheet. More...
 
NXString NativeFileBrowser ()
 Returns the native OS file name returned by the Browser. More...
 
void SetAssociative (bool associative)
 Sets the associativity of the expression in the feature to the Symbolica or Maple worksheet
Created in NX12.0.0. More...
 
void SetAssociativityType (NXOpen::Features::MathIntegrationBuilder::AssociativityTypes associativityType)
 Sets the option to control associativity to the equation
Created in NX12.0.0. More...
 
void SetEmbeddedWorksheet (int embeddedWorksheet)
 Sets the currently selected embedded worksheet index. More...
 
void SetEmbedWorksheet (bool embedWorksheet)
 Sets the option to embed worksheet in the feature
Created in NX12.0.0. More...
 
void SetExpressions (const std::vector< NXOpen::Expression * > &expressions)
 Set the expressions in the Math Interface Builder
Created in NX12.0.0. More...
 
void SetFileBrowser (const NXString &filename)
 Sets the file name returned by the Browser
Created in NX12.0.0. More...
 
void SetFileBrowser (const char *filename)
 Sets the file name returned by the Browser
Created in NX12.0.0. More...
 
void SetInputs (int numInputExpressions)
 Sets the number of input expressions
Created in NX12.0.0. More...
 
void SetLocation (NXOpen::Features::MathIntegrationBuilder::LocationTypes location)
 Sets the source location of the Symbolica or Maple worksheet. More...
 
void SetMathNames (const std::vector< NXString > &names)
 Set the math names corresponding to expressions in the Math Interface Builder
Created in NX12.0.0. More...
 
void SetNativeFileBrowser (const NXString &filename)
 Sets the native OS file name returned by the Browser. More...
 
void SetNativeFileBrowser (const char *filename)
 Sets the native OS file name returned by the Browser. More...
 
void SetShowInformationWindow (bool showInformationWindow)
 Sets the option to show the information window
Created in NX12.0.0. More...
 
bool ShowInformationWindow ()
 Returns the option to show the information window
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.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::Features::MathIntegration builder
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateMathIntegrationBuilder
Default values.

Property Value

Associative

0

AssociativityType

None

EmbedWorksheet

0

ShowInformationWindow

0


Created in NX12.0.0.

Member Enumeration Documentation

the associativity

Enumerator
AssociativityTypesNone 

No associativity to the worksheet.

AssociativityTypesNew 

Make associative to the worksheet.

AssociativityTypesExisting 

Maintain associativity to the worksheet.

The option to specify where the Symbolica or Maple worksheet exists.

Enumerator
LocationTypesOperatingSystem 

Worksheet is on the native OS file system.

LocationTypesTeamcenter 

Worksheet is in Teamcenter.

LocationTypesEmbedded 

Worksheet is embedded in part.

Member Function Documentation

bool NXOpen::Features::MathIntegrationBuilder::Associative ( )

Returns the associativity of the expression in the feature to the Symbolica or Maple worksheet
Created in NX12.0.0.



License requirements : None

NXOpen::Features::MathIntegrationBuilder::AssociativityTypes NXOpen::Features::MathIntegrationBuilder::AssociativityType ( )

Returns the option to control associativity to the equation
Created in NX12.0.0.



License requirements : None

int NXOpen::Features::MathIntegrationBuilder::EmbeddedWorksheet ( )

Returns the currently selected embedded worksheet index.


Created in NX12.0.0.

License requirements : None

bool NXOpen::Features::MathIntegrationBuilder::EmbedWorksheet ( )

Returns the option to embed worksheet in the feature
Created in NX12.0.0.



License requirements : None

NXString NXOpen::Features::MathIntegrationBuilder::FileBrowser ( )

Returns the file name returned by the Browser
Created in NX12.0.0.



License requirements : None

std::vector<NXOpen::Expression *> NXOpen::Features::MathIntegrationBuilder::GetExpressions ( )

The array of expressions.

Returns
array of expressions
Created in NX12.0.0.

License requirements : None
std::vector<NXString> NXOpen::Features::MathIntegrationBuilder::GetMathNames ( )

The array of math names.

Returns
array of names
Created in NX12.0.0.

License requirements : None
int NXOpen::Features::MathIntegrationBuilder::Inputs ( )

Returns the number of input expressions
Created in NX12.0.0.



License requirements : None

NXOpen::Features::MathIntegrationBuilder::LocationTypes NXOpen::Features::MathIntegrationBuilder::Location ( )

Returns the source location of the Symbolica or Maple worksheet.


Created in NX12.0.0.

License requirements : None

NXString NXOpen::Features::MathIntegrationBuilder::NativeFileBrowser ( )

Returns the native OS file name returned by the Browser.

Used when the session is Teamcenter, but the location is NXOpen::Features::MathIntegrationBuilder::LocationTypesOperatingSystem .
Created in NX12.0.0.

License requirements : None

void NXOpen::Features::MathIntegrationBuilder::SetAssociative ( bool  associative)

Sets the associativity of the expression in the feature to the Symbolica or Maple worksheet
Created in NX12.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
associativeassociative
void NXOpen::Features::MathIntegrationBuilder::SetAssociativityType ( NXOpen::Features::MathIntegrationBuilder::AssociativityTypes  associativityType)

Sets the option to control associativity to the equation
Created in NX12.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
associativityTypeassociativitytype
void NXOpen::Features::MathIntegrationBuilder::SetEmbeddedWorksheet ( int  embeddedWorksheet)

Sets the currently selected embedded worksheet index.


Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
embeddedWorksheetembeddedworksheet
void NXOpen::Features::MathIntegrationBuilder::SetEmbedWorksheet ( bool  embedWorksheet)

Sets the option to embed worksheet in the feature
Created in NX12.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
embedWorksheetembedworksheet
void NXOpen::Features::MathIntegrationBuilder::SetExpressions ( const std::vector< NXOpen::Expression * > &  expressions)

Set the expressions in the Math Interface Builder
Created in NX12.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
expressionsarray of expressions
void NXOpen::Features::MathIntegrationBuilder::SetFileBrowser ( const NXString filename)

Sets the file name returned by the Browser
Created in NX12.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
filenamefilename
void NXOpen::Features::MathIntegrationBuilder::SetFileBrowser ( const char *  filename)

Sets the file name returned by the Browser
Created in NX12.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
filenamefilename
void NXOpen::Features::MathIntegrationBuilder::SetInputs ( int  numInputExpressions)

Sets the number of input expressions
Created in NX12.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
numInputExpressionsnum input expressions
void NXOpen::Features::MathIntegrationBuilder::SetLocation ( NXOpen::Features::MathIntegrationBuilder::LocationTypes  location)

Sets the source location of the Symbolica or Maple worksheet.


Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
locationlocation
void NXOpen::Features::MathIntegrationBuilder::SetMathNames ( const std::vector< NXString > &  names)

Set the math names corresponding to expressions in the Math Interface Builder
Created in NX12.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
namesarray of names
void NXOpen::Features::MathIntegrationBuilder::SetNativeFileBrowser ( const NXString filename)

Sets the native OS file name returned by the Browser.

Used when the session is Teamcenter, but the location is NXOpen::Features::MathIntegrationBuilder::LocationTypesOperatingSystem .
Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
filenamefilename
void NXOpen::Features::MathIntegrationBuilder::SetNativeFileBrowser ( const char *  filename)

Sets the native OS file name returned by the Browser.

Used when the session is Teamcenter, but the location is NXOpen::Features::MathIntegrationBuilder::LocationTypesOperatingSystem .
Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
filenamefilename
void NXOpen::Features::MathIntegrationBuilder::SetShowInformationWindow ( bool  showInformationWindow)

Sets the option to show the information window
Created in NX12.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
showInformationWindowshowinformationwindow
bool NXOpen::Features::MathIntegrationBuilder::ShowInformationWindow ( )

Returns the option to show the information window
Created in NX12.0.0.



License requirements : None


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