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

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

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

Classes

struct  Symbol
 Represents Symbol definition structure. More...
 

Public Types

enum  DataType { DataTypeBool, DataTypeInt, DataTypeDouble }
 Represents the data type. More...
 
enum  IOType { IOTypeInput, IOTypeOutput, IOTypeInout }
 Represents the IO type. More...
 

Public Member Functions

std::vector
< NXOpen::Mechatronics::SymbolTableBuilder::Symbol
GetSymbols ()
 Gets all Symbols. More...
 
NXString Name ()
 Returns. More...
 
void SetName (const NXString &name)
 Sets. More...
 
void SetName (const char *name)
 Sets. More...
 
void SetSymbols (const std::vector< NXOpen::Mechatronics::SymbolTableBuilder::Symbol > &symbols)
 Sets all Symbols. 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::SymbolTableBuilder builder.

SymbolTableBuilder is used to maintain the NXOpen::Mechatronics::SymbolTable which is used for Signal creation.


To create a new instance of this class, use NXOpen::Mechatronics::SymbolTableCollection::CreateSymbolTableBuilder

Created in NX11.0.0.

Member Enumeration Documentation

Represents the data type.

Enumerator
DataTypeBool 

bool

DataTypeInt 

int

DataTypeDouble 

double

Represents the IO type.

Enumerator
IOTypeInput 

Input.

IOTypeOutput 

Output.

IOTypeInout 

Input/Output.

Member Function Documentation

std::vector<NXOpen::Mechatronics::SymbolTableBuilder::Symbol> NXOpen::Mechatronics::SymbolTableBuilder::GetSymbols ( )

Gets all Symbols.

Returns
Array of Symbols
Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
NXString NXOpen::Mechatronics::SymbolTableBuilder::Name ( )

Returns.

the name.


Created in NX11.0.0.

License requirements : None

void NXOpen::Mechatronics::SymbolTableBuilder::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::SymbolTableBuilder::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::SymbolTableBuilder::SetSymbols ( const std::vector< NXOpen::Mechatronics::SymbolTableBuilder::Symbol > &  symbols)

Sets all Symbols.

Each Symbol name must be unique in the context of input Symbol list. Or the builder will raise an exception.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
symbolsArray of Symbols

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