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

This class represents a Condition which defines a state where all or some values of CAE::SimConditionParam are known. More...

Inheritance diagram for NXOpen::CAE::SimCondition:
NXOpen::TaggedObject

Public Member Functions

double GetValue (NXOpen::CAE::SimConditionParam *param)
 Returns the condition specified parameter value.
 
bool IsValueDefined (NXOpen::CAE::SimConditionParam *param)
 Returns if the condition specified parameter value is defined.
 
int Label ()
 Returns the condition's label.
 
NXString Name ()
 Returns the condition's name
Created in NX9.0.0.
 
void SetName (const NXString &name)
 Sets the condition's name
Created in NX9.0.0.
 
void SetName (const char *name)
 Sets the condition's name
Created in NX9.0.0.
 
void SetValue (NXOpen::CAE::SimConditionParam *param, double value)
 Sets the condition specified parameter value.
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t GetTag () const
 
<b>Deprecated</b>:<br>

   Use Tag instead.

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

Detailed Description

This class represents a Condition which defines a state where all or some values of CAE::SimConditionParam are known.


An instance of this class can be obtained from CAE::SimConditionSeqMgr .

Created in NX9.0.0.

Member Function Documentation

double NXOpen::CAE::SimCondition::GetValue ( NXOpen::CAE::SimConditionParam param)

Returns the condition specified parameter value.

       Use the parameter's object as a key in for the value.
       Errors out if parameter doesn't exist.
       Errors out if value is undefined.
       Same units as specified @link CAE::SimConditionParam CAE::SimConditionParam@endlink . @return  the condition parameter value 


Created in NX9.0.0.

License requirements : None

Parameters
paramparam
bool NXOpen::CAE::SimCondition::IsValueDefined ( NXOpen::CAE::SimConditionParam param)

Returns if the condition specified parameter value is defined.

       Use the parameter's object as a key in.
       Errors out if parameter doesn't exist.  @return  


Created in NX9.0.0.

License requirements : None

Parameters
paramparam
int NXOpen::CAE::SimCondition::Label ( )

Returns the condition's label.

Label is unique and greater than zero. It can only be set at creation of a condition and cannot be changed. The label is the key used to locate a specific condition.
Created in NX9.0.0.

License requirements : None

NXString NXOpen::CAE::SimCondition::Name ( )

Returns the condition's name
Created in NX9.0.0.



License requirements : None

void NXOpen::CAE::SimCondition::SetName ( const NXString name)

Sets the condition's name
Created in NX9.0.0.



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

Parameters
namename
void NXOpen::CAE::SimCondition::SetName ( const char *  name)

Sets the condition's name
Created in NX9.0.0.



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

Parameters
namename
void NXOpen::CAE::SimCondition::SetValue ( NXOpen::CAE::SimConditionParam param,
double  value 
)

Sets the condition specified parameter value.

       Use the parameter's object as a key in for the value.
       Errors out if parameter doesn't exist.
       Same units as specified @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
paramparam
valuevalue

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