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

This class is a collection of NXOpen::CAE::SimCondition . More...

Inheritance diagram for NXOpen::CAE::SimConditionCollection:
NXOpen::TaggedObjectCollection

Classes

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

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
NXOpen::CAE::SimConditionCreate (const NXString &name, int label)
 Adds a NXOpen::CAE::SimCondition . More...
 
NXOpen::CAE::SimConditionCreate (const char *name, int label)
 Adds a NXOpen::CAE::SimCondition . More...
 
NXOpen::CAE::SimConditionCreate (const NXString &name)
 Adds a NXOpen::CAE::SimCondition . More...
 
NXOpen::CAE::SimConditionCreate (const char *name)
 Adds a NXOpen::CAE::SimCondition . More...
 
NXOpen::CAE::SimConditionCreate (int label)
 Adds a NXOpen::CAE::SimCondition . More...
 
NXOpen::CAE::SimConditionCreate ()
 Adds a NXOpen::CAE::SimCondition . More...
 
int Delete (NXOpen::CAE::SimCondition *condition)
 Deletes the specified NXOpen::CAE::SimCondition . More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::CAE::SimConditionFind (const NXString &label)
 Collection's object finder. More...
 
NXOpen::CAE::SimConditionFind (const char *label)
 Collection's object finder. More...
 
NXOpen::CAE::SimConditionGet (int label)
 Returns the NXOpen::CAE::SimCondition with the specified label or NULL if such a condition doesn't exist. More...
 
std::vector
< NXOpen::CAE::SimCondition * > 
GetAll ()
 Returns all NXOpen::CAE::SimCondition. More...
 
bool IsLabelValid (int label)
 Returns if a specified NXOpen::CAE::SimCondition label is valid. More...
 
int NextLabel ()
 Returns the next available NXOpen::CAE::SimCondition label. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

This class is a collection of NXOpen::CAE::SimCondition .


To obtain an instance of this class, refer to NXOpen::CAE::SimConditionSeqMgr

Created in NX9.0.0.

Member Function Documentation

iterator NXOpen::CAE::SimConditionCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Create ( const NXString name,
int  label 
)

Adds a NXOpen::CAE::SimCondition .

Name can be anything, even empty. Label must be unique and can be tested with NXOpen::CAE::SimConditionCollection::IsLabelValid .

Returns
Added NXOpen::CAE::SimCondition
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
namename
labellabel
NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Create ( const char *  name,
int  label 
)

Adds a NXOpen::CAE::SimCondition .

Name can be anything, even empty. Label must be unique and can be tested with NXOpen::CAE::SimConditionCollection::IsLabelValid .

Returns
Added NXOpen::CAE::SimCondition
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
namename
labellabel
NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Create ( const NXString name)

Adds a NXOpen::CAE::SimCondition .

Name can be anything, even empty. A unique label will automatically be set.

Returns
Added NXOpen::CAE::SimCondition
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
namename
NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Create ( const char *  name)

Adds a NXOpen::CAE::SimCondition .

Name can be anything, even empty. A unique label will automatically be set.

Returns
Added NXOpen::CAE::SimCondition
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
namename
NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Create ( int  label)

Adds a NXOpen::CAE::SimCondition .

Name will be automatically set. Label must be unique and can be tested with NXOpen::CAE::SimConditionCollection::IsLabelValid .

Returns
Added NXOpen::CAE::SimCondition
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
labellabel
NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Create ( )

Adds a NXOpen::CAE::SimCondition .

Name and label will be automatically set.

Returns
Added NXOpen::CAE::SimCondition
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
int NXOpen::CAE::SimConditionCollection::Delete ( NXOpen::CAE::SimCondition condition)

Deletes the specified NXOpen::CAE::SimCondition .

If that NXOpen::CAE::SimCondition is referenced in a NXOpen::CAE::SimConditionTimeStep , the NXOpen::CAE::SimConditionTimeStep will no longer reference any NXOpen::CAE::SimCondition . Will return the number of NXOpen::CAE::SimCondition actually deleted.

Returns

Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
conditioncondition
iterator NXOpen::CAE::SimConditionCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Find ( const NXString label)

Collection's object finder.

Returns
The NXOpen::CAE::SimCondition
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
labellabel of the NXOpen::CAE::SimCondition
NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Find ( const char *  label)

Collection's object finder.

Returns
The NXOpen::CAE::SimCondition
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
labellabel of the NXOpen::CAE::SimCondition
NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Get ( int  label)

Returns the NXOpen::CAE::SimCondition with the specified label or NULL if such a condition doesn't exist.

Returns
the corresponding NXOpen::CAE::SimCondition
Created in NX9.0.0.

License requirements : None
Parameters
labellabel
std::vector<NXOpen::CAE::SimCondition *> NXOpen::CAE::SimConditionCollection::GetAll ( )

Returns all NXOpen::CAE::SimCondition.

Returns
all NXOpen::CAE::SimCondition
Created in NX9.0.0.

License requirements : None
bool NXOpen::CAE::SimConditionCollection::IsLabelValid ( int  label)

Returns if a specified NXOpen::CAE::SimCondition label is valid.

Returns

Created in NX9.0.0.

License requirements : None
Parameters
labellabel
int NXOpen::CAE::SimConditionCollection::NextLabel ( )

Returns the next available NXOpen::CAE::SimCondition label.

Returns

Created in NX9.0.0.

License requirements : None
tag_t NXOpen::CAE::SimConditionCollection::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.