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

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

Inheritance diagram for NXOpen::Mechatronics::ExpressionBlockBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Classes

struct  Slot
 Represents Slot definition structure. More...
 

Public Types

enum  DataType { DataTypeBool, DataTypeInt, DataTypeDouble }
 Represents the data type. More...
 
enum  SlotType {
  SlotTypeNone = -1, SlotTypeInput, SlotTypeOutput, SlotTypeParam,
  SlotTypeState, SlotTypeCustom, SlotTypeNum
}
 Represents the Slot type. More...
 

Public Member Functions

std::vector< NXStringGetDescription ()
 Gets description lines. More...
 
std::vector
< NXOpen::Mechatronics::ExpressionBlockBuilder::Slot
GetSlots ()
 Gets all Slots. More...
 
void LoadFromXmlFile (const NXString &templateFile)
 Load data from xml file. More...
 
void LoadFromXmlFile (const char *templateFile)
 Load data from xml file. More...
 
NXString Name ()
 Returns. More...
 
void SaveToXmlFile (const NXString &templateFile)
 Save data to xml file. More...
 
void SaveToXmlFile (const char *templateFile)
 Save data to xml file. More...
 
void SetDescription (std::vector< NXString > &descLines)
 Sets description lines. More...
 
void SetName (const NXString &name)
 Sets. More...
 
void SetName (const char *name)
 Sets. More...
 
void SetSlots (const std::vector< NXOpen::Mechatronics::ExpressionBlockBuilder::Slot > &slots)
 Sets all Slots. 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::ExpressionBlockBuilder builder.

ExpressionBlockBuilder is used to maintain the NXOpen::Mechatronics::ExpressionBlockObject which is used store related expressions that work for same task.


To create a new instance of this class, use NXOpen::Mechatronics::ExpressionBlockCollection::CreateExpressionBlockBuilder

Created in NX11.0.0.

Member Enumeration Documentation

Represents the data type.

Enumerator
DataTypeBool 

bool

DataTypeInt 

int

DataTypeDouble 

double

Represents the Slot type.

Enumerator
SlotTypeNone 

None.

SlotTypeInput 

Input that should connect to runtime parameter as input value.

SlotTypeOutput 

Output that should connect to runtime parameter to output value.

SlotTypeParam 

Param that is used to configure the block to differentiate mode.

SlotTypeState 

State that is change during runtime based on internal data.

SlotTypeCustom 

Custom that represents the user created temporary variable.

SlotTypeNum 

Total Num.

Member Function Documentation

std::vector<NXString> NXOpen::Mechatronics::ExpressionBlockBuilder::GetDescription ( )

Gets description lines.

Returns

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
std::vector<NXOpen::Mechatronics::ExpressionBlockBuilder::Slot> NXOpen::Mechatronics::ExpressionBlockBuilder::GetSlots ( )

Gets all Slots.

Returns
Array of Slots
Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
void NXOpen::Mechatronics::ExpressionBlockBuilder::LoadFromXmlFile ( const NXString templateFile)

Load data from xml file.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
templateFiletemplatefile
void NXOpen::Mechatronics::ExpressionBlockBuilder::LoadFromXmlFile ( const char *  templateFile)

Load data from xml file.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
templateFiletemplatefile
NXString NXOpen::Mechatronics::ExpressionBlockBuilder::Name ( )

Returns.

the name.


Created in NX11.0.0.

License requirements : None

void NXOpen::Mechatronics::ExpressionBlockBuilder::SaveToXmlFile ( const NXString templateFile)

Save data to xml file.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
templateFiletemplatefile
void NXOpen::Mechatronics::ExpressionBlockBuilder::SaveToXmlFile ( const char *  templateFile)

Save data to xml file.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
templateFiletemplatefile
void NXOpen::Mechatronics::ExpressionBlockBuilder::SetDescription ( std::vector< NXString > &  descLines)

Sets description lines.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
descLinesdesclines
void NXOpen::Mechatronics::ExpressionBlockBuilder::SetName ( const NXString name)

Sets.

the name.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename
void NXOpen::Mechatronics::ExpressionBlockBuilder::SetName ( const char *  name)

Sets.

the name.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename
void NXOpen::Mechatronics::ExpressionBlockBuilder::SetSlots ( const std::vector< NXOpen::Mechatronics::ExpressionBlockBuilder::Slot > &  slots)

Sets all Slots.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
slotsArray of Slots

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