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

Represents a NXOpen::Mechatronics::GenericSensor builder. More...

Inheritance diagram for NXOpen::Mechatronics::GenericSensorBuilder:
NXOpen::Mechatronics::PhysicsConstraintBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  OutputMeasureType { OutputMeasureTypeConstant, OutputMeasureTypeVoltage, OutputMeasureTypeCurrent }
 the Measure types. More...
 

Public Member Functions

NXOpen::ExpressionLowerOutputRange ()
 Returns. More...
 
NXOpen::ExpressionLowerTrimRange ()
 Returns. More...
 
NXOpen::Mechatronics::GenericSensorBuilder::OutputMeasureType MeasureType ()
 Returns. More...
 
int PersistentTag ()
 Returns. More...
 
NXOpen::SelectNXObjectSelectedPhysicsObject ()
 Returns. More...
 
void SetMeasureType (NXOpen::Mechatronics::GenericSensorBuilder::OutputMeasureType measureType)
 Sets. More...
 
void SetPersistentTag (int persistentTag)
 Sets. More...
 
void SetUseScale (bool useScale)
 Sets. More...
 
void SetUseTrim (bool useTrim)
 Sets. More...
 
NXOpen::ExpressionUpperOutputRange ()
 Returns. More...
 
NXOpen::ExpressionUpperTrimRange ()
 Returns. More...
 
bool UseScale ()
 Returns. More...
 
bool UseTrim ()
 Returns. More...
 
- Public Member Functions inherited from NXOpen::Mechatronics::PhysicsConstraintBuilder
NXString Name ()
 Returns the name. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. 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::Mechatronics::GenericSensor builder.


To create a new instance of this class, use NXOpen::Mechatronics::GenericSensorCollection::CreateGenericSensorBuilder

Created in NX11.0.0.

Member Enumeration Documentation

the Measure types.

Enumerator
OutputMeasureTypeConstant 

MEASURE_UNITLESS.

OutputMeasureTypeVoltage 

MEASURE_VOLTAGE.

OutputMeasureTypeCurrent 

MEASURE_ELECTRIC_CURRENT.

Member Function Documentation

NXOpen::Expression* NXOpen::Mechatronics::GenericSensorBuilder::LowerOutputRange ( )

Returns.

the lower output range used to scale the generic data. Its measure type contains constant, voltage, current


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::GenericSensorBuilder::LowerTrimRange ( )

Returns.

the lower trim range used to trim the generic data.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::GenericSensorBuilder::OutputMeasureType NXOpen::Mechatronics::GenericSensorBuilder::MeasureType ( )

Returns.

the measure type.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

int NXOpen::Mechatronics::GenericSensorBuilder::PersistentTag ( )

Returns.

the Persistent Tag used in the physics object


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::SelectNXObject* NXOpen::Mechatronics::GenericSensorBuilder::SelectedPhysicsObject ( )

Returns.

the physics select. This can be a physics object.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::GenericSensorBuilder::SetMeasureType ( NXOpen::Mechatronics::GenericSensorBuilder::OutputMeasureType  measureType)

Sets.

the measure type.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
measureTypemeasuretype
void NXOpen::Mechatronics::GenericSensorBuilder::SetPersistentTag ( int  persistentTag)

Sets.

the Persistent Tag used in the physics object


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
persistentTagpersistenttag
void NXOpen::Mechatronics::GenericSensorBuilder::SetUseScale ( bool  useScale)

Sets.

the use scale flag, which is used to control if the generic sensor includes scale parameters.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
useScaleusescale
void NXOpen::Mechatronics::GenericSensorBuilder::SetUseTrim ( bool  useTrim)

Sets.

the use trim flag, which is used to control if the generic sensor includes trim parameters.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
useTrimusetrim
NXOpen::Expression* NXOpen::Mechatronics::GenericSensorBuilder::UpperOutputRange ( )

Returns.

the upper output range used to scale the generic data.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::GenericSensorBuilder::UpperTrimRange ( )

Returns.

the upper trim range used to trim the generic data.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

bool NXOpen::Mechatronics::GenericSensorBuilder::UseScale ( )

Returns.

the use scale flag, which is used to control if the generic sensor includes scale parameters.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

bool NXOpen::Mechatronics::GenericSensorBuilder::UseTrim ( )

Returns.

the use trim flag, which is used to control if the generic sensor includes trim parameters.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")


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