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::DiscreteDrivetrainReportBuilder Class Reference

Represents a Motion::DiscreteDrivetrainReport builder. More...

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

Public Types

enum  ElementTypeOption {
  ElementTypeOptionAnalyticalContact, ElementTypeOptionBushing, ElementTypeOptionSpring, ElementTypeOptionDamper,
  ElementTypeOptionBeamForce
}
 Discrete Drivetrain Report element type. More...
 
enum  ReportType { ReportTypeSpan, ReportTypeSpatial }
 Discrete Drivetrain Report type. More...
 
enum  ShapeType { ShapeTypeBox, ShapeTypeCylinder }
 Discrete Drivetrain Report shape type. More...
 

Public Member Functions

NXOpen::SelectNXObjectListAnalyticalContacts ()
 Returns the analytical contacts selection. More...
 
NXOpen::Motion::LinkAttachmentDataAttachment ()
 Returns the attachement for the discrete drivetrain report. More...
 
NXOpen::SelectNXObjectListBeamForces ()
 Returns the beam forces selection. More...
 
NXOpen::SelectNXObjectListBushings ()
 Returns the bushings selection. More...
 
NXOpen::SelectNXObjectListDampers ()
 Returns the dampers selection. More...
 
NXOpen::ExpressionDepth ()
 Returns the depth defined for the discrete drivetrain report. More...
 
NXOpen::Motion::DiscreteDrivetrainReportBuilder::ElementTypeOption ElementType ()
 Returns the element type of discrete drivetrain report. More...
 
NXOpen::ExpressionEndAngle ()
 Returns the end angle defined for the discrete drivetrain report. More...
 
NXString Name ()
 Returns the discrete drivetrain report name. More...
 
int NumberOfBins ()
 Returns the number of bins
Created in NX1847.0.0. More...
 
NXOpen::ExpressionRadius ()
 Returns the radius defined for the discrete drivetrain report. More...
 
void SetElementType (NXOpen::Motion::DiscreteDrivetrainReportBuilder::ElementTypeOption type)
 Sets the element type of discrete drivetrain report. More...
 
void SetName (const NXString &name)
 Sets the discrete drivetrain report name. More...
 
void SetName (const char *name)
 Sets the discrete drivetrain report name. More...
 
void SetNumberOfBins (int numberOfBins)
 Sets the number of bins
Created in NX1847.0.0. More...
 
void SetShape (NXOpen::Motion::DiscreteDrivetrainReportBuilder::ShapeType type)
 Sets the shape type of discrete drivetrain report. More...
 
void SetShowVisualization (bool showVisualization)
 Sets the flag of show visualization
Created in NX1847.0.0. More...
 
void SetType (NXOpen::Motion::DiscreteDrivetrainReportBuilder::ReportType type)
 Sets the type of discrete drivetrain report. More...
 
NXOpen::Motion::DiscreteDrivetrainReportBuilder::ShapeType Shape ()
 Returns the shape type of discrete drivetrain report. More...
 
bool ShowVisualization ()
 Returns the flag of show visualization
Created in NX1847.0.0. More...
 
NXOpen::SelectNXObjectListSprings ()
 Returns the springs selection. More...
 
NXOpen::ExpressionStartAngle ()
 Returns the start angle defined for the discrete drivetrain report. More...
 
NXOpen::Motion::DiscreteDrivetrainReportBuilder::ReportType Type ()
 Returns the type of discrete drivetrain report. More...
 
NXOpen::ExpressionXLength ()
 Returns the X legnth defined for the discrete drivetrain report. More...
 
NXOpen::ExpressionYLength ()
 Returns the Y legnth defined for the discrete drivetrain report. More...
 
NXOpen::ExpressionZLength ()
 Returns the Z legnth defined for the discrete drivetrain report. 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 Motion::DiscreteDrivetrainReport builder.


To create a new instance of this class, use NXOpen::Motion::DiscreteDrivetrainBuilder::CreateDiscreteDrivetrainReportBuilder

Created in NX1847.0.0.

Member Enumeration Documentation

Discrete Drivetrain Report element type.

Enumerator
ElementTypeOptionAnalyticalContact 

analytical contact

ElementTypeOptionBushing 

bushing

ElementTypeOptionSpring 

spring

ElementTypeOptionDamper 

damper

ElementTypeOptionBeamForce 

beam force

Discrete Drivetrain Report type.

Enumerator
ReportTypeSpan 

span

ReportTypeSpatial 

spatial

Discrete Drivetrain Report shape type.

Enumerator
ShapeTypeBox 

box

ShapeTypeCylinder 

cylinder

Member Function Documentation

NXOpen::SelectNXObjectList* NXOpen::Motion::DiscreteDrivetrainReportBuilder::AnalyticalContacts ( )

Returns the analytical contacts selection.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::LinkAttachmentData* NXOpen::Motion::DiscreteDrivetrainReportBuilder::Attachment ( )

Returns the attachement for the discrete drivetrain report.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::SelectNXObjectList* NXOpen::Motion::DiscreteDrivetrainReportBuilder::BeamForces ( )

Returns the beam forces selection.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::SelectNXObjectList* NXOpen::Motion::DiscreteDrivetrainReportBuilder::Bushings ( )

Returns the bushings selection.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::SelectNXObjectList* NXOpen::Motion::DiscreteDrivetrainReportBuilder::Dampers ( )

Returns the dampers selection.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::DiscreteDrivetrainReportBuilder::Depth ( )

Returns the depth defined for the discrete drivetrain report.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::DiscreteDrivetrainReportBuilder::ElementTypeOption NXOpen::Motion::DiscreteDrivetrainReportBuilder::ElementType ( )

Returns the element type of discrete drivetrain report.

Analytical contacts is the default value.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::DiscreteDrivetrainReportBuilder::EndAngle ( )

Returns the end angle defined for the discrete drivetrain report.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::DiscreteDrivetrainReportBuilder::Name ( )

Returns the discrete drivetrain report name.

Must be unique across all motion elements.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

int NXOpen::Motion::DiscreteDrivetrainReportBuilder::NumberOfBins ( )

Returns the number of bins
Created in NX1847.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::DiscreteDrivetrainReportBuilder::Radius ( )

Returns the radius defined for the discrete drivetrain report.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::DiscreteDrivetrainReportBuilder::SetElementType ( NXOpen::Motion::DiscreteDrivetrainReportBuilder::ElementTypeOption  type)

Sets the element type of discrete drivetrain report.

Analytical contacts is the default value.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
typetype
void NXOpen::Motion::DiscreteDrivetrainReportBuilder::SetName ( const NXString name)

Sets the discrete drivetrain report name.

Must be unique across all motion elements.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Sets the discrete drivetrain report name.

Must be unique across all motion elements.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::DiscreteDrivetrainReportBuilder::SetNumberOfBins ( int  numberOfBins)

Sets the number of bins
Created in NX1847.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
numberOfBinsnumberofbins
void NXOpen::Motion::DiscreteDrivetrainReportBuilder::SetShape ( NXOpen::Motion::DiscreteDrivetrainReportBuilder::ShapeType  type)

Sets the shape type of discrete drivetrain report.

Box is the default value.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
typetype
void NXOpen::Motion::DiscreteDrivetrainReportBuilder::SetShowVisualization ( bool  showVisualization)

Sets the flag of show visualization
Created in NX1847.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
showVisualizationshowvisualization
void NXOpen::Motion::DiscreteDrivetrainReportBuilder::SetType ( NXOpen::Motion::DiscreteDrivetrainReportBuilder::ReportType  type)

Sets the type of discrete drivetrain report.

Span is the default value.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
typetype
NXOpen::Motion::DiscreteDrivetrainReportBuilder::ShapeType NXOpen::Motion::DiscreteDrivetrainReportBuilder::Shape ( )

Returns the shape type of discrete drivetrain report.

Box is the default value.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

bool NXOpen::Motion::DiscreteDrivetrainReportBuilder::ShowVisualization ( )

Returns the flag of show visualization
Created in NX1847.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::SelectNXObjectList* NXOpen::Motion::DiscreteDrivetrainReportBuilder::Springs ( )

Returns the springs selection.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::DiscreteDrivetrainReportBuilder::StartAngle ( )

Returns the start angle defined for the discrete drivetrain report.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::DiscreteDrivetrainReportBuilder::ReportType NXOpen::Motion::DiscreteDrivetrainReportBuilder::Type ( )

Returns the type of discrete drivetrain report.

Span is the default value.
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::DiscreteDrivetrainReportBuilder::XLength ( )

Returns the X legnth defined for the discrete drivetrain report.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::DiscreteDrivetrainReportBuilder::YLength ( )

Returns the Y legnth defined for the discrete drivetrain report.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::DiscreteDrivetrainReportBuilder::ZLength ( )

Returns the Z legnth defined for the discrete drivetrain report.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")


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