NX Open C++ Reference Guide: NXOpen::CAE::SimConditionCollection Class Reference

NX Open C++ Reference Guide

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

Inheritance diagram for NXOpen::CAE::SimConditionCollection:

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::SimCondition *	Create (const NXString &name, int label)
	Adds a CAE::SimCondition .

NXOpen::CAE::SimCondition *	Create (const char *name, int label)
	Adds a CAE::SimCondition .

NXOpen::CAE::SimCondition *	Create (const NXString &name)
	Adds a CAE::SimCondition .

NXOpen::CAE::SimCondition *	Create (const char *name)
	Adds a CAE::SimCondition .

NXOpen::CAE::SimCondition *	Create (int label)
	Adds a CAE::SimCondition .

NXOpen::CAE::SimCondition *	Create ()
	Adds a CAE::SimCondition .

int	Delete (NXOpen::CAE::SimCondition *condition)
	Deletes the specified CAE::SimCondition .

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

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

NXOpen::CAE::SimCondition *	Find (const char *label)
	Collection's object finder.

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

std::vector < NXOpen::CAE::SimCondition * >	GetAll ()
	Returns all CAE::SimCondition.

bool	IsLabelValid (int label)
	Returns if a specified CAE::SimCondition label is valid.

int	NextLabel ()
	Returns the next available CAE::SimCondition label.

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

Detailed Description

This class is a collection of CAE::SimCondition .

To obtain an instance of this class, refer to 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 CAE::SimCondition .

       Name can be anything, even empty.
       Label must be unique and can be tested with @link CAE::SimConditionCollection::IsLabelValid CAE::SimConditionCollection::IsLabelValid@endlink .  @return  Added @link CAE::SimCondition CAE::SimCondition@endlink

Created in NX9.0.0.

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

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
label	label

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

Adds a CAE::SimCondition .

       Name can be anything, even empty.
       Label must be unique and can be tested with @link CAE::SimConditionCollection::IsLabelValid CAE::SimConditionCollection::IsLabelValid@endlink .  @return  Added @link CAE::SimCondition CAE::SimCondition@endlink

Created in NX9.0.0.

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

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
label	label

NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Create ( const NXString & name )

Adds a CAE::SimCondition .

       Name can be anything, even empty.
       A unique label will automatically be set.  @return  Added @link CAE::SimCondition CAE::SimCondition@endlink

Created in NX9.0.0.

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

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Create ( const char * name )

Adds a CAE::SimCondition .

       Name can be anything, even empty.
       A unique label will automatically be set.  @return  Added @link CAE::SimCondition CAE::SimCondition@endlink

Created in NX9.0.0.

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

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Create ( int label )

Adds a CAE::SimCondition .

       Name will be automatically set.
       Label must be unique and can be tested with @link CAE::SimConditionCollection::IsLabelValid CAE::SimConditionCollection::IsLabelValid@endlink .  @return  Added @link CAE::SimCondition CAE::SimCondition@endlink

Created in NX9.0.0.

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

Parameters

label label

NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Create ( )

Adds a CAE::SimCondition .

       Name and label will be automatically set.  @return  Added @link CAE::SimCondition CAE::SimCondition@endlink

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 CAE::SimCondition .

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

Created in NX9.0.0.

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

Parameters

condition condition

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

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

Parameters

label label of the CAE::SimCondition

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

Collection's object finder.

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

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

Parameters

label label of the CAE::SimCondition

NXOpen::CAE::SimCondition* NXOpen::CAE::SimConditionCollection::Get ( int label )

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

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

License requirements : None

Parameters

label label

std::vector<NXOpen::CAE::SimCondition *> NXOpen::CAE::SimConditionCollection::GetAll ( )

Returns all CAE::SimCondition.

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

License requirements : None

bool NXOpen::CAE::SimConditionCollection::IsLabelValid ( int label )

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

Returns: Created in NX9.0.0.

License requirements : None

Parameters

label label

int NXOpen::CAE::SimConditionCollection::NextLabel ( )

Returns the next available 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:

CAE_SimConditionCollection.hxx

Copyright 2013 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.