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

Inheritance diagram for NXOpen::CAE::SimConditionTimeStepCollection:

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

Public Member Functions
iterator	begin ()
	Returns an iterator addressing the first element.

NXOpen::CAE::SimConditionTimeStep *	Create (double time, NXOpen::CAE::SimCondition *condition, const NXString &description)
	Creates a CAE::SimConditionTimeStep at specified time referencing specified CAE::SimCondition and insert it in time history.

NXOpen::CAE::SimConditionTimeStep *	Create (double time, NXOpen::CAE::SimCondition condition, const char description)
	Creates a CAE::SimConditionTimeStep at specified time referencing specified CAE::SimCondition and insert it in time history.

void	Delete (NXOpen::CAE::SimConditionTimeStep *step)
	Deletes a CAE::SimConditionTimeStep from time history Created in NX9.0.0.

iterator	end ()
	Returns an iterator addressing one past the last element.

NXOpen::CAE::SimConditionTimeStep *	Find (const NXString &time)
	Collection's object finder.

NXOpen::CAE::SimConditionTimeStep *	Find (const char *time)
	Collection's object finder.

NXOpen::CAE::SimConditionTimeStep *	Get (double time)
	Returns the CAE::SimConditionTimeStep at the specified time or NULL if it doesn't exist.

std::vector < NXOpen::CAE::SimConditionTimeStep * >	GetAll ()
	Returns a time ordered array of all CAE::SimConditionTimeStep.

std::vector < NXOpen::CAE::SimConditionTimeStep * >	GetInRange (double fromTime, double toTime)
	Returns all CAE::SimConditionTimeStep falling inside the specified inclusive time range.

std::vector < NXOpen::CAE::SimConditionTimeStep * >	GetWithReferenceToCondition (NXOpen::CAE::SimCondition *condition)
	Returns all CAE::SimConditionTimeStep referencing the specified CAE::SimCondition.

void	ModifyTime (NXOpen::CAE::SimConditionTimeStep *step, double time)
	Modifies the time of a CAE::SimConditionTimeStep in time history Created in NX9.0.0.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

This class is a collection of CAE::SimConditionTimeStep .

To obtain an instance of this class, refer to 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 CAE::SimConditionTimeStep at specified time referencing specified CAE::SimCondition and insert it in time history.

       A conditionless @link CAE::SimConditionTimeStep CAE::SimConditionTimeStep@endlink  may be added by passing NULL 
       as the @link CAE::SimCondition CAE::SimCondition@endlink . @return  the added Time Step @link CAE::SimConditionTimeStep CAE::SimConditionTimeStep@endlink

Created in NX9.0.0.

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

Parameters

time	time
condition	condition
description	NOTE: The full Unicode character set is not supported for this parameter.

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

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

       A conditionless @link CAE::SimConditionTimeStep CAE::SimConditionTimeStep@endlink  may be added by passing NULL 
       as the @link CAE::SimCondition CAE::SimCondition@endlink . @return  the added Time Step @link CAE::SimConditionTimeStep CAE::SimConditionTimeStep@endlink

Created in NX9.0.0.

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

Parameters

time	time
condition	condition
description	NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::CAE::SimConditionTimeStepCollection::Delete ( NXOpen::CAE::SimConditionTimeStep * step )

Deletes a 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

step step

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 CAE::SimConditionTimeStep
Created in NX9.0.0.

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

Parameters

time	time of the CAE::SimConditionTimeStep

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

Collection's object finder.

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

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

Parameters

time	time of the CAE::SimConditionTimeStep

NXOpen::CAE::SimConditionTimeStep* NXOpen::CAE::SimConditionTimeStepCollection::Get ( double time )

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

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

License requirements : None

Parameters

time time

std::vector<NXOpen::CAE::SimConditionTimeStep *> NXOpen::CAE::SimConditionTimeStepCollection::GetAll ( )

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

Returns: all 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 CAE::SimConditionTimeStep falling inside the specified inclusive time range.

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

License requirements : None

Parameters

fromTime	fromtime
toTime	totime

std::vector<NXOpen::CAE::SimConditionTimeStep *> NXOpen::CAE::SimConditionTimeStepCollection::GetWithReferenceToCondition ( NXOpen::CAE::SimCondition * condition )

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

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

License requirements : None

Parameters

condition condition

void NXOpen::CAE::SimConditionTimeStepCollection::ModifyTime	(	NXOpen::CAE::SimConditionTimeStep *	step,
		double	time
	)

Modifies the time of a 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

step	step
time	time

tag_t NXOpen::CAE::SimConditionTimeStepCollection::Tag ( ) const

Returns the tag of this object.

The documentation for this class was generated from the following file:

CAE_SimConditionTimeStepCollection.hxx

Classes

Public Member Functions

Detailed Description

Member Function Documentation