NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
NXOpen::CAE::SelRecipeAttributeStrategy Class Reference

Selection Recipe Attribute Strategy
Use the NXOpen::CAE::SelRecipeBuilder class to add strategy. More...

Inheritance diagram for NXOpen::CAE::SelRecipeAttributeStrategy:
NXOpen::CAE::SelRecipeStrategy NXOpen::CAE::SelRecipeBaseStrategy NXOpen::TaggedObject

Public Member Functions

void ClearAllAttributes ()
 Clear all attributes
Created in NX1847.0.0. More...
 
int ColorAttribute ()
 Returns the color attribute. More...
 
bool GetHasUserAttributes (const NXString &attributeName)
 Gets the presence of the user attribute with given name. More...
 
bool GetHasUserAttributes (const char *attributeName)
 Gets the presence of the user attribute with given name. More...
 
void GetUserAttributeNames (std::vector< NXString > &userAttributeNames)
 Gets the names of all set user attributes. More...
 
void GetUserAttributes (const NXString &attributeName, std::vector< NXOpen::NXObject::AttributeInformation > &lowValueAttribute, std::vector< NXOpen::NXObject::AttributeInformation > &highValueAttribute)
 Gets the low and high value of user attribute with given name. More...
 
void GetUserAttributes (const char *attributeName, std::vector< NXOpen::NXObject::AttributeInformation > &lowValueAttribute, std::vector< NXOpen::NXObject::AttributeInformation > &highValueAttribute)
 Gets the low and high value of user attribute with given name. More...
 
bool HasColorAttribute ()
 Returns the presence of the color attribute. More...
 
bool HasNameAttribute ()
 Returns the presence of the name attribute. More...
 
NXString NameAttribute ()
 Returns the name attribute. More...
 
void RemoveColorAttribute ()
 Removes the color attribute. More...
 
void RemoveNameAttribute ()
 Removes the name attribute. More...
 
void RemoveUserAttributes (const NXString &attributeName)
 Removes the user attribute with given name. More...
 
void RemoveUserAttributes (const char *attributeName)
 Removes the user attribute with given name. More...
 
void SetColorAttribute (int color)
 Sets or adds the color attribute. More...
 
void SetNameAttribute (const NXString &name)
 Sets or adds the name attribute. More...
 
void SetNameAttribute (const char *name)
 Sets or adds the name attribute. More...
 
void SetUserAttributes (const NXString &attributeName, const std::vector< NXOpen::NXObject::AttributeInformation > &lowValueAttributes, const std::vector< NXOpen::NXObject::AttributeInformation > &highValueAttributes)
 Sets or adds the low and high value of user attribute with given name. More...
 
void SetUserAttributes (const char *attributeName, const std::vector< NXOpen::NXObject::AttributeInformation > &lowValueAttributes, const std::vector< NXOpen::NXObject::AttributeInformation > &highValueAttributes)
 Sets or adds the low and high value of user attribute with given name. More...
 
void SetUserAttributes (bool setNameAttribute, const NXString &nameAttribute, bool setColorAttribute, int colorAttribute, const std::vector< NXOpen::NXObject::AttributeInformation > &lowValueAttributes, const std::vector< NXOpen::NXObject::AttributeInformation > &highValueAttributes)
 Convenience method to set multiple attributes at once. More...
 
void SetUserAttributes (bool setNameAttribute, const char *nameAttribute, bool setColorAttribute, int colorAttribute, const std::vector< NXOpen::NXObject::AttributeInformation > &lowValueAttributes, const std::vector< NXOpen::NXObject::AttributeInformation > &highValueAttributes)
 Convenience method to set multiple attributes at once. More...
 
- Public Member Functions inherited from NXOpen::CAE::SelRecipeStrategy
NXOpen::TaggedObjectInputFilter ()
 Returns the input filter
Created in NX1847.0.0. More...
 
void SetInputFilter (NXOpen::TaggedObject *inpFilter)
 Sets the input filter
Created in NX1847.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::SelRecipeBaseStrategy
NXOpen::CAE::SelRecipeBaseStrategy::Type StrategyType ()
 Returns the strategy type
Created in NX1847.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen::CAE::SelRecipeBaseStrategy
enum  Type {
  TypeInvalid = -1, TypeBoundingVolume, TypeAttribute, TypeLabelRange,
  TypeSingleLabel, TypeCoordinate, TypePoint, TypeProximity,
  TypeAdjacentFaces, TypeCircularEdges, TypeCylinderFaces, TypeFeatureEdgeNodes,
  TypeFeatureElements, TypeFeatureElementEdges, TypeFeatureElementFaces, TypeFeatureNodes,
  TypeFeatureShellElements, TypeFilletFaces, TypeFilterBodies, TypeFilterEdges,
  TypeFilterElements, TypeFilterFaces, TypeHoleElementEdges, TypeRelatedEdges,
  TypeRelatedElementEdges, TypeRelatedElementFaces, TypeRelatedElements, TypeRelatedCurves,
  TypeRelatedFaces, TypeRelatedNodes, TypeRelatedVertices, TypeSliverFaces,
  TypeTangentContinuousEdges, TypeTangentFaces
}
 the strategy type More...
 

Detailed Description

Selection Recipe Attribute Strategy
Use the NXOpen::CAE::SelRecipeBuilder class to add strategy.



Created in NX1847.0.0.

Member Function Documentation

void NXOpen::CAE::SelRecipeAttributeStrategy::ClearAllAttributes ( )

Clear all attributes
Created in NX1847.0.0.



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

int NXOpen::CAE::SelRecipeAttributeStrategy::ColorAttribute ( )

Returns the color attribute.


Created in NX1847.0.0.

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

bool NXOpen::CAE::SelRecipeAttributeStrategy::GetHasUserAttributes ( const NXString attributeName)

Gets the presence of the user attribute with given name.


Created in NX1847.0.0.

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

Parameters
attributeNameattributename
bool NXOpen::CAE::SelRecipeAttributeStrategy::GetHasUserAttributes ( const char *  attributeName)

Gets the presence of the user attribute with given name.


Created in NX1847.0.0.

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

Parameters
attributeNameattributename
void NXOpen::CAE::SelRecipeAttributeStrategy::GetUserAttributeNames ( std::vector< NXString > &  userAttributeNames)

Gets the names of all set user attributes.


Created in NX1847.0.0.

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

Parameters
userAttributeNamesuserattributenames
void NXOpen::CAE::SelRecipeAttributeStrategy::GetUserAttributes ( const NXString attributeName,
std::vector< NXOpen::NXObject::AttributeInformation > &  lowValueAttribute,
std::vector< NXOpen::NXObject::AttributeInformation > &  highValueAttribute 
)

Gets the low and high value of user attribute with given name.


Created in NX1847.0.0.

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

Parameters
attributeNameattributename
lowValueAttributelowvalueattribute
highValueAttributehighvalueattribute
void NXOpen::CAE::SelRecipeAttributeStrategy::GetUserAttributes ( const char *  attributeName,
std::vector< NXOpen::NXObject::AttributeInformation > &  lowValueAttribute,
std::vector< NXOpen::NXObject::AttributeInformation > &  highValueAttribute 
)

Gets the low and high value of user attribute with given name.


Created in NX1847.0.0.

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

Parameters
attributeNameattributename
lowValueAttributelowvalueattribute
highValueAttributehighvalueattribute
bool NXOpen::CAE::SelRecipeAttributeStrategy::HasColorAttribute ( )

Returns the presence of the color attribute.


Created in NX1847.0.0.

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

bool NXOpen::CAE::SelRecipeAttributeStrategy::HasNameAttribute ( )

Returns the presence of the name attribute.


Created in NX1847.0.0.

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

NXString NXOpen::CAE::SelRecipeAttributeStrategy::NameAttribute ( )

Returns the name attribute.


Created in NX1847.0.0.

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

void NXOpen::CAE::SelRecipeAttributeStrategy::RemoveColorAttribute ( )

Removes the color attribute.


Created in NX1847.0.0.

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

void NXOpen::CAE::SelRecipeAttributeStrategy::RemoveNameAttribute ( )

Removes the name attribute.


Created in NX1847.0.0.

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

void NXOpen::CAE::SelRecipeAttributeStrategy::RemoveUserAttributes ( const NXString attributeName)

Removes the user attribute with given name.


Created in NX1847.0.0.

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

Parameters
attributeNameattributename
void NXOpen::CAE::SelRecipeAttributeStrategy::RemoveUserAttributes ( const char *  attributeName)

Removes the user attribute with given name.


Created in NX1847.0.0.

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

Parameters
attributeNameattributename
void NXOpen::CAE::SelRecipeAttributeStrategy::SetColorAttribute ( int  color)

Sets or adds the color attribute.


Created in NX1847.0.0.

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

Parameters
colorcolor
void NXOpen::CAE::SelRecipeAttributeStrategy::SetNameAttribute ( const NXString name)

Sets or adds the name attribute.


Created in NX1847.0.0.

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

Parameters
namename
void NXOpen::CAE::SelRecipeAttributeStrategy::SetNameAttribute ( const char *  name)

Sets or adds the name attribute.


Created in NX1847.0.0.

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

Parameters
namename
void NXOpen::CAE::SelRecipeAttributeStrategy::SetUserAttributes ( const NXString attributeName,
const std::vector< NXOpen::NXObject::AttributeInformation > &  lowValueAttributes,
const std::vector< NXOpen::NXObject::AttributeInformation > &  highValueAttributes 
)

Sets or adds the low and high value of user attribute with given name.


Created in NX1847.0.0.

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

Parameters
attributeNameattributename
lowValueAttributeslowvalueattributes
highValueAttributeshighvalueattributes
void NXOpen::CAE::SelRecipeAttributeStrategy::SetUserAttributes ( const char *  attributeName,
const std::vector< NXOpen::NXObject::AttributeInformation > &  lowValueAttributes,
const std::vector< NXOpen::NXObject::AttributeInformation > &  highValueAttributes 
)

Sets or adds the low and high value of user attribute with given name.


Created in NX1847.0.0.

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

Parameters
attributeNameattributename
lowValueAttributeslowvalueattributes
highValueAttributeshighvalueattributes
void NXOpen::CAE::SelRecipeAttributeStrategy::SetUserAttributes ( bool  setNameAttribute,
const NXString nameAttribute,
bool  setColorAttribute,
int  colorAttribute,
const std::vector< NXOpen::NXObject::AttributeInformation > &  lowValueAttributes,
const std::vector< NXOpen::NXObject::AttributeInformation > &  highValueAttributes 
)

Convenience method to set multiple attributes at once.

The name and color are optional. It's recommended to use this method in case of setting multiple attributes, to avoid having the recipe resolve multiple times.
Created in NX1847.0.0.

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

Parameters
setNameAttributesetnameattribute
nameAttributenameattribute
setColorAttributesetcolorattribute
colorAttributecolorattribute
lowValueAttributeslowvalueattributes
highValueAttributeshighvalueattributes
void NXOpen::CAE::SelRecipeAttributeStrategy::SetUserAttributes ( bool  setNameAttribute,
const char *  nameAttribute,
bool  setColorAttribute,
int  colorAttribute,
const std::vector< NXOpen::NXObject::AttributeInformation > &  lowValueAttributes,
const std::vector< NXOpen::NXObject::AttributeInformation > &  highValueAttributes 
)

Convenience method to set multiple attributes at once.

The name and color are optional. It's recommended to use this method in case of setting multiple attributes, to avoid having the recipe resolve multiple times.
Created in NX1847.0.0.

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

Parameters
setNameAttributesetnameattribute
nameAttributenameattribute
setColorAttributesetcolorattribute
colorAttributecolorattribute
lowValueAttributeslowvalueattributes
highValueAttributeshighvalueattributes

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