NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::Motion::ProfileBuilder Class Reference

Represents a builder class for creating and editing an NXOpen::Fields::Field . More...

Inheritance diagram for NXOpen::Motion::ProfileBuilder:
NXOpen::Motion::MotionBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ExternalFileTypeChoices { ExternalFileTypeChoicesTabularData, ExternalFileTypeChoicesTimeSeries }
 type of the external file profile More...
 
enum  TypeChoices { TypeChoicesSketch, TypeChoicesExternalFile }
 type attribute of the profile. More...
 

Public Member Functions

NXOpen::Fields::ExternalFileProfileBuilderExternalFileProfile ()
 Returns. More...
 
NXOpen::Motion::ProfileBuilder::ExternalFileTypeChoices FormatType ()
 Returns the external file type (TabularData or TimeSeries)
Created in NX1847.0.0. More...
 
NXOpen::Motion::ProfileBuilder::TypeChoices InputType ()
 Returns. More...
 
NXString Name ()
 Returns. More...
 
void SetFormatType (NXOpen::Motion::ProfileBuilder::ExternalFileTypeChoices formatType)
 Sets the external file type (TabularData or TimeSeries)
Created in NX1847.0.0. More...
 
void SetInputType (NXOpen::Motion::ProfileBuilder::TypeChoices inputType)
 Sets. More...
 
void SetName (const NXString &name)
 Sets. More...
 
void SetName (const char *name)
 Sets. More...
 
NXOpen::Fields::SketchProfileBuilderSketchProfile ()
 Returns. More...
 
NXOpen::Fields::TimeSeriesProfileBuilderTimeSeriesProfile ()
 Returns. More...
 
- Public Member Functions inherited from NXOpen::Motion::MotionBuilder
double DisplayScale ()
 Returns the icon display scale
Created in NX5.0.0. More...
 
NXString GroupName ()
 Returns the group name
Created in NX5.0.0. More...
 
NXOpen::Motion::MotionObject::GroupType GroupType ()
 Returns the group type
Created in NX5.0.0. More...
 
void SetDisplayScale (double displayScale)
 Sets the icon display scale
Created in NX5.0.0. More...
 
void SetGroupName (const NXString &groupName)
 Sets the group name
Created in NX5.0.0. More...
 
void SetGroupName (const char *groupName)
 Sets the group name
Created in NX5.0.0. More...
 
void SetGroupType (NXOpen::Motion::MotionObject::GroupType groupType)
 Sets the group type
Created in NX5.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 builder class for creating and editing an NXOpen::Fields::Field .

This builder allows you to define an NXOpen::Fields::Field by an NXOpen::Motion::ProfileBuilder::TypeChoicesSketch or a reference to an NXOpen::Motion::ProfileBuilder::TypeChoicesExternalFile .


To create a new instance of this class, use NXOpen::Motion::FieldDataCollection::CreateProfileBuilder

Created in NX1847.0.0.

Member Enumeration Documentation

type of the external file profile

Enumerator
ExternalFileTypeChoicesTabularData 

tabular data

ExternalFileTypeChoicesTimeSeries 

time series

type attribute of the profile.

Enumerator
TypeChoicesSketch 

Sketch.

TypeChoicesExternalFile 

External File Reference.

Member Function Documentation

NXOpen::Fields::ExternalFileProfileBuilder* NXOpen::Motion::ProfileBuilder::ExternalFileProfile ( )

Returns.

the external file profile.

This is only used when NXOpen::Motion::ProfileBuilder::InputType and NXOpen::Motion::ProfileBuilder::SetInputType is set to NXOpen::Motion::ProfileBuilder::TypeChoicesExternalFile


Created in NX1847.0.0.

License requirements : None

NXOpen::Motion::ProfileBuilder::ExternalFileTypeChoices NXOpen::Motion::ProfileBuilder::FormatType ( )

Returns the external file type (TabularData or TimeSeries)
Created in NX1847.0.0.



License requirements : None

NXOpen::Motion::ProfileBuilder::TypeChoices NXOpen::Motion::ProfileBuilder::InputType ( )

Returns.

the profile input type.


Created in NX1847.0.0.

License requirements : None

NXString NXOpen::Motion::ProfileBuilder::Name ( )

Returns.

the name of the profile object selected from motion objects.


Created in NX1847.0.0.

License requirements : None

void NXOpen::Motion::ProfileBuilder::SetFormatType ( NXOpen::Motion::ProfileBuilder::ExternalFileTypeChoices  formatType)

Sets the external file type (TabularData or TimeSeries)
Created in NX1847.0.0.



License requirements : None

Parameters
formatTypeformattype
void NXOpen::Motion::ProfileBuilder::SetInputType ( NXOpen::Motion::ProfileBuilder::TypeChoices  inputType)

Sets.

the profile input type.


Created in NX1847.0.0.

License requirements : None

Parameters
inputTypeinputtype
void NXOpen::Motion::ProfileBuilder::SetName ( const NXString name)

Sets.

the name of the profile object selected from motion objects.


Created in NX1847.0.0.

License requirements : None

Parameters
namename
void NXOpen::Motion::ProfileBuilder::SetName ( const char *  name)

Sets.

the name of the profile object selected from motion objects.


Created in NX1847.0.0.

License requirements : None

Parameters
namename
NXOpen::Fields::SketchProfileBuilder* NXOpen::Motion::ProfileBuilder::SketchProfile ( )

Returns.

the sketch profile.

This is only used when NXOpen::Motion::ProfileBuilder::InputType and NXOpen::Motion::ProfileBuilder::SetInputType is set to NXOpen::Motion::ProfileBuilder::TypeChoicesSketch


Created in NX1847.0.0.

License requirements : None

NXOpen::Fields::TimeSeriesProfileBuilder* NXOpen::Motion::ProfileBuilder::TimeSeriesProfile ( )

Returns.

the time series profile component. This is a builder for the Time Series Profile UI component.


Created in NX1847.0.0.

License requirements : None


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