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

This class is a collection of CAE::SimConditionParam which represents a measurable environment. More...

Inheritance diagram for NXOpen::CAE::SimConditionParamCollection:
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.
 
NXOpen::CAE::SimConditionParamCreate (const NXString &name, NXOpen::Unit *units)
 Creates a CAE::SimConditionParam with the specified name and units.
 
NXOpen::CAE::SimConditionParamCreate (const char *name, NXOpen::Unit *units)
 Creates a CAE::SimConditionParam with the specified name and units.
 
int Delete (NXOpen::CAE::SimConditionParam *param)
 Deletes a CAE::SimConditionParam .
 
iterator end ()
 Returns an iterator addressing one past the last element.
 
NXOpen::CAE::SimConditionParamFind (const NXString &name)
 Collection's object finder.
 
NXOpen::CAE::SimConditionParamFind (const char *name)
 Collection's object finder.
 
NXOpen::CAE::SimConditionParamGet (const NXString &name)
 Returns the CAE::SimConditionParam with the specified name or NULL if such a parameter doesn't exist.
 
NXOpen::CAE::SimConditionParamGet (const char *name)
 Returns the CAE::SimConditionParam with the specified name or NULL if such a parameter doesn't exist.
 
std::vector
< NXOpen::CAE::SimConditionParam * > 
GetAll ()
 Returns all CAE::SimConditionParam.
 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

This class is a collection of CAE::SimConditionParam which represents a measurable environment.


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

Created in NX9.0.0.

Member Function Documentation

iterator NXOpen::CAE::SimConditionParamCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::CAE::SimConditionParam* NXOpen::CAE::SimConditionParamCollection::Create ( const NXString name,
NXOpen::Unit units 
)

Creates a CAE::SimConditionParam with the specified name and units.

       Will error out if a @link CAE::SimConditionParam CAE::SimConditionParam@endlink  with specified name already exists.
       Specified name cannot be empty.  @return  Created @link CAE::SimConditionParam CAE::SimConditionParam@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.
unitsunits
NXOpen::CAE::SimConditionParam* NXOpen::CAE::SimConditionParamCollection::Create ( const char *  name,
NXOpen::Unit units 
)

Creates a CAE::SimConditionParam with the specified name and units.

       Will error out if a @link CAE::SimConditionParam CAE::SimConditionParam@endlink  with specified name already exists.
       Specified name cannot be empty.  @return  Created @link CAE::SimConditionParam CAE::SimConditionParam@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.
unitsunits
int NXOpen::CAE::SimConditionParamCollection::Delete ( NXOpen::CAE::SimConditionParam param)

Deletes a CAE::SimConditionParam .

       All values in @link CAE::SimCondition CAE::SimCondition@endlink  for that @link CAE::SimConditionParam CAE::SimConditionParam@endlink  will also be deleted.
       Will return the number of @link CAE::SimConditionParam CAE::SimConditionParam@endlink  actually deleted.  @return  


Created in NX9.0.0.

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

Parameters
paramparam
iterator NXOpen::CAE::SimConditionParamCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::CAE::SimConditionParam* NXOpen::CAE::SimConditionParamCollection::Find ( const NXString name)

Collection's object finder.

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

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
namename of the CAE::SimConditionParam
NXOpen::CAE::SimConditionParam* NXOpen::CAE::SimConditionParamCollection::Find ( const char *  name)

Collection's object finder.

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

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
namename of the CAE::SimConditionParam
NXOpen::CAE::SimConditionParam* NXOpen::CAE::SimConditionParamCollection::Get ( const NXString name)

Returns the CAE::SimConditionParam with the specified name or NULL if such a parameter doesn't exist.

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

License requirements : None
Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.
NXOpen::CAE::SimConditionParam* NXOpen::CAE::SimConditionParamCollection::Get ( const char *  name)

Returns the CAE::SimConditionParam with the specified name or NULL if such a parameter doesn't exist.

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

License requirements : None
Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.
std::vector<NXOpen::CAE::SimConditionParam *> NXOpen::CAE::SimConditionParamCollection::GetAll ( )

Returns all CAE::SimConditionParam.

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

License requirements : None
tag_t NXOpen::CAE::SimConditionParamCollection::Tag ( ) const

Returns the tag of this object.


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