NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::CAE::PreTestExciterConfigCollection Class Reference

Represents a collection of exciter selection configuration
To obtain an instance of this class, refer to NXOpen::CAE::PreTestExciterSelectionControl

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::CAE::PreTestExciterConfigCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

int ActiveExciterConfig ()
 Returns the pre-test active exciter configuration
Created in NX8.0.0. More...
 
iterator begin ()
 Returns an iterator addressing the first element. More...
 
NXOpen::CAE::PreTestExciterConfigCloneExciterConfig (NXOpen::CAE::PreTestExciterConfig *source)
 Clone a pre-test exciter configuration. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::CAE::PreTestExciterConfigFindObject (const NXString &name)
 Finds a exciter selection configuration with specified name. More...
 
NXOpen::CAE::PreTestExciterConfigFindObject (const char *name)
 Finds a exciter selection configuration with specified name. More...
 
void RemoveExciterConfig (int toRemove)
 Removes and deletes a exciter selection configuration
Created in NX8.0.0. More...
 
void SetActiveExciterConfig (int activeConfig)
 Sets the pre-test active exciter configuration
Created in NX8.0.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of exciter selection configuration
To obtain an instance of this class, refer to NXOpen::CAE::PreTestExciterSelectionControl

Created in NX8.0.0.


Member Function Documentation

int NXOpen::CAE::PreTestExciterConfigCollection::ActiveExciterConfig ( )

Returns the pre-test active exciter configuration
Created in NX8.0.0.



License requirements : None

iterator NXOpen::CAE::PreTestExciterConfigCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::CAE::PreTestExciterConfig* NXOpen::CAE::PreTestExciterConfigCollection::CloneExciterConfig ( NXOpen::CAE::PreTestExciterConfig source)

Clone a pre-test exciter configuration.

Returns
Cloned Pre-Test exciter configuration
Created in NX8.0.0.

License requirements : nx_correl_base ("FE Correlation")
Parameters
sourcePre-Test exciter configuration to be cloned
iterator NXOpen::CAE::PreTestExciterConfigCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::CAE::PreTestExciterConfig* NXOpen::CAE::PreTestExciterConfigCollection::FindObject ( const NXString name)

Finds a exciter selection configuration with specified name.

Returns
exciter selection configuration found
Created in NX8.0.0.

License requirements : None
Parameters
nameexciter selection configuration name to be found
NXOpen::CAE::PreTestExciterConfig* NXOpen::CAE::PreTestExciterConfigCollection::FindObject ( const char *  name)

Finds a exciter selection configuration with specified name.

Returns
exciter selection configuration found
Created in NX8.0.0.

License requirements : None
Parameters
nameexciter selection configuration name to be found
void NXOpen::CAE::PreTestExciterConfigCollection::RemoveExciterConfig ( int  toRemove)

Removes and deletes a exciter selection configuration
Created in NX8.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters
toRemoveIndex of the exciter selection configuration to remove
void NXOpen::CAE::PreTestExciterConfigCollection::SetActiveExciterConfig ( int  activeConfig)

Sets the pre-test active exciter configuration
Created in NX8.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters
activeConfigactive config
tag_t NXOpen::CAE::PreTestExciterConfigCollection::Tag ( ) const

Returns the tag of this object.


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