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

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

Inheritance diagram for NXOpen::CAE::SimConditionTimeStepCollection:
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::SimConditionTimeStepCreate (double time, NXOpen::CAE::SimCondition *condition, const NXString &description)
 Creates a NXOpen::CAE::SimConditionTimeStep at specified time referencing specified NXOpen::CAE::SimCondition and insert it in time history. More...
 
NXOpen::CAE::SimConditionTimeStepCreate (double time, NXOpen::CAE::SimCondition *condition, const char *description)
 Creates a NXOpen::CAE::SimConditionTimeStep at specified time referencing specified NXOpen::CAE::SimCondition and insert it in time history. More...
 
void Delete (NXOpen::CAE::SimConditionTimeStep *step)
 Deletes a NXOpen::CAE::SimConditionTimeStep from time history
Created in NX9.0.0. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::CAE::SimConditionTimeStepFind (const NXString &time)
 Collection's object finder. More...
 
NXOpen::CAE::SimConditionTimeStepFind (const char *time)
 Collection's object finder. More...
 
NXOpen::CAE::SimConditionTimeStepGet (double time)
 Returns the NXOpen::CAE::SimConditionTimeStep at the specified time or NULL if it doesn't exist. More...
 
std::vector
< NXOpen::CAE::SimConditionTimeStep * > 
GetAll ()
 Returns a time ordered array of all NXOpen::CAE::SimConditionTimeStep. More...
 
std::vector
< NXOpen::CAE::SimConditionTimeStep * > 
GetInRange (double fromTime, double toTime)
 Returns all NXOpen::CAE::SimConditionTimeStep falling inside the specified inclusive time range. More...
 
std::vector
< NXOpen::CAE::SimConditionTimeStep * > 
GetWithReferenceToCondition (NXOpen::CAE::SimCondition *condition)
 Returns all NXOpen::CAE::SimConditionTimeStep referencing the specified NXOpen::CAE::SimCondition. More...
 
void ModifyTime (NXOpen::CAE::SimConditionTimeStep *step, double time)
 Modifies the time of a NXOpen::CAE::SimConditionTimeStep in time history
Created in NX9.0.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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


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

Created in NX9.0.0.

Member Function Documentation

iterator NXOpen::CAE::SimConditionTimeStepCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::CAE::SimConditionTimeStep* NXOpen::CAE::SimConditionTimeStepCollection::Create ( double  time,
NXOpen::CAE::SimCondition condition,
const NXString description 
)

Creates a NXOpen::CAE::SimConditionTimeStep at specified time referencing specified NXOpen::CAE::SimCondition and insert it in time history.

A conditionless NXOpen::CAE::SimConditionTimeStep may be added by passing NULL as the NXOpen::CAE::SimCondition .

Returns
the added Time Step NXOpen::CAE::SimConditionTimeStep
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
timetime
conditioncondition
descriptiondescription
NXOpen::CAE::SimConditionTimeStep* NXOpen::CAE::SimConditionTimeStepCollection::Create ( double  time,
NXOpen::CAE::SimCondition condition,
const char *  description 
)

Creates a NXOpen::CAE::SimConditionTimeStep at specified time referencing specified NXOpen::CAE::SimCondition and insert it in time history.

A conditionless NXOpen::CAE::SimConditionTimeStep may be added by passing NULL as the NXOpen::CAE::SimCondition .

Returns
the added Time Step NXOpen::CAE::SimConditionTimeStep
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
timetime
conditioncondition
descriptiondescription
void NXOpen::CAE::SimConditionTimeStepCollection::Delete ( NXOpen::CAE::SimConditionTimeStep step)

Deletes a NXOpen::CAE::SimConditionTimeStep from time history
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
stepstep
iterator NXOpen::CAE::SimConditionTimeStepCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::CAE::SimConditionTimeStep* NXOpen::CAE::SimConditionTimeStepCollection::Find ( const NXString time)

Collection's object finder.

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

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
timetime of the NXOpen::CAE::SimConditionTimeStep
NXOpen::CAE::SimConditionTimeStep* NXOpen::CAE::SimConditionTimeStepCollection::Find ( const char *  time)

Collection's object finder.

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

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
timetime of the NXOpen::CAE::SimConditionTimeStep
NXOpen::CAE::SimConditionTimeStep* NXOpen::CAE::SimConditionTimeStepCollection::Get ( double  time)

Returns the NXOpen::CAE::SimConditionTimeStep at the specified time or NULL if it doesn't exist.

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

License requirements : None
Parameters
timetime
std::vector<NXOpen::CAE::SimConditionTimeStep *> NXOpen::CAE::SimConditionTimeStepCollection::GetAll ( )

Returns a time ordered array of all NXOpen::CAE::SimConditionTimeStep.

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

License requirements : None
std::vector<NXOpen::CAE::SimConditionTimeStep *> NXOpen::CAE::SimConditionTimeStepCollection::GetInRange ( double  fromTime,
double  toTime 
)

Returns all NXOpen::CAE::SimConditionTimeStep falling inside the specified inclusive time range.

Returns
all NXOpen::CAE::SimConditionTimeStep within range
Created in NX9.0.0.

License requirements : None
Parameters
fromTimefromtime
toTimetotime
std::vector<NXOpen::CAE::SimConditionTimeStep *> NXOpen::CAE::SimConditionTimeStepCollection::GetWithReferenceToCondition ( NXOpen::CAE::SimCondition condition)

Returns all NXOpen::CAE::SimConditionTimeStep referencing the specified NXOpen::CAE::SimCondition.

Returns
all NXOpen::CAE::SimConditionTimeStep referencing specified NXOpen::CAE::SimCondition
Created in NX9.0.0.

License requirements : None
Parameters
conditioncondition
void NXOpen::CAE::SimConditionTimeStepCollection::ModifyTime ( NXOpen::CAE::SimConditionTimeStep step,
double  time 
)

Modifies the time of a NXOpen::CAE::SimConditionTimeStep in time history
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
stepstep
timetime
tag_t NXOpen::CAE::SimConditionTimeStepCollection::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.