Hide menu
Loading...
Searching...
No Matches
cadex::ModelData_PMISurfaceTextureRequirementAttribute Class Reference

Defines a surface texture requirement. More...

#include <cadex/ModelData_PMISemanticAttribute.hxx>

Inheritance diagram for cadex::ModelData_PMISurfaceTextureRequirementAttribute:
cadex::ModelData_PMISemanticAttribute cadex::ModelData_BaseObject

Public Types

enum  SpecificationLimitType { UndefinedLimit , Upper , Lower }
 
enum  SurfaceParameterType {
  UndefinedParameter , Rp , Rv , Rz ,
  Rc , Rt , Ra , Rq ,
  Rsk , Rku , Wp = 100 , Wv ,
  Wz , Wc , Wt , Wa ,
  Wq , Wsk , Wku , Pp = 200 ,
  Pv , Pz , Pc , Pt ,
  Pa , Pq , Psk , Pku ,
  N1 = 300 , N2 , N3 , N4 ,
  N5 , N6 , N7 , N8 ,
  N9 , N10 , N11 , N12
}
 
enum  ComparisonRuleType { SixteenPercent , Max }
 
typedef cadex::internal::ModelData_PMISurfaceTextureRequirementAttributeImpl ImplType
 
- Public Types inherited from cadex::ModelData_BaseObject
typedef int IdType
 Defines a type identifier.
 

Public Member Functions

 ModelData_PMISurfaceTextureRequirementAttribute ()
 Constructor.
 
 ModelData_PMISurfaceTextureRequirementAttribute (ImplType *theImpl)
 
 ModelData_PMISurfaceTextureRequirementAttribute (size_t thePrecedence, SurfaceParameterType theParameter, double theLimitValue)
 
void SetPrecedence (size_t thePrecedence)
 
size_t Precedence () const
 Returns precedence value.
 
void SetSpecificationLimit (SpecificationLimitType theLimit)
 
SpecificationLimitType SpecificationLimit () const
 
void SetFilterName (const Base_UTF16String &theFilterName)
 
const Base_UTF16StringFilterName () const
 Returns filter name.
 
void SetShortWaveFilter (double theValue)
 
double ShortWaveFilter () const
 Returns short wave filter value.
 
void SetLongWaveFilter (double theValue)
 
double LongWaveFilter () const
 Returns long wave filter value.
 
void SetSurfaceParameter (SurfaceParameterType theParameter)
 
SurfaceParameterType SurfaceParameter () const
 
void SetEvaluationLength (double theValue)
 
double EvaluationLength () const
 Returns evaluation length value.
 
void SetComparisonRule (ComparisonRuleType theRule)
 
ComparisonRuleType ComparisonRule () const
 Returns comparison rule.
 
void SetLimitValue (double theValue)
 Sets limit value.
 
double LimitValue () const
 Returns limit value.
 
- Public Member Functions inherited from cadex::ModelData_PMISemanticAttribute
void Accept (ModelData_PMISemanticAttributeVisitor &theVisitor) const
 
- Public Member Functions inherited from cadex::ModelData_BaseObject
 ModelData_BaseObject ()
 Constructor.
 
IdType TypeId () const
 Returns an object type id.
 
template<typename T >
bool IsOfType () const
 Returns true if the object has a type T.
 
void SetName (const Base_UTF16String &theName)
 Sets an object name.
 
Base_UTF16String Name () const
 
void SetUuid (const Base_Uuid &theUuid)
 
Base_Uuid Uuid () const
 
void Nullify ()
 Resets reference to implementation object.
 
bool IsNull () const
 Returns true if the object is nullified.
 
 operator bool () const
 Casts the object to the bool type.
 
internal::ModelData_BaseObjectImpl * Impl () const
 Return a handle to backend (reserved for internal use).
 

Static Public Member Functions

static IdType GetTypeId ()
 

Additional Inherited Members

- Protected Member Functions inherited from cadex::ModelData_PMISemanticAttribute
 ModelData_PMISemanticAttribute ()
 Constructor.
 
 ModelData_PMISemanticAttribute (internal::ModelData_PMISemanticAttributeImpl *theImpl)
 Constructor.
 
- Protected Member Functions inherited from cadex::ModelData_BaseObject
 ModelData_BaseObject (const internal::ModelData_BaseObjectImpl *theImpl)
 Constructor (reserved for internal use).
 
 ModelData_BaseObject (const internal::ModelData_BaseObjectImpl *theImpl, const Base_UTF16String &theName)
 Constructor (reserved for internal use).
 
template<typename T >
T * GetOrCreateImpl ()
 Reserved for internal use.
 

Detailed Description

Defines a surface texture requirement.

A surface texture requirement is built from several different control elements, which can be part of the indication on the drawing or the textual indication. The elements are shown in the image below.

Control elements in indication of surface texture requirements

Experience has shown that all these elements are not necessary to form an unambiguous relation between the surface texture requirement and the function of the surface. The majority of them may be omitted if this does not introduce discrepancies (some characteristics have default values). There are no mandatory elements, all are optional, but at least one element should be specified.

In some cases it is necessary to indicate requirements for more than one surface texture parameter (profile or characteristic or both) in order to establish an unambiguous relation between the requirement on the drawing and the function of the surface. Thus, a surface finish component can have multiple surface texture requirement attributes. In this case the order (primary, secondary, etc) of surface texture requirement in surface finish component is controlled by Precedence() method.

Note
The development of data structures of surface texture requirement was carried out under the influence of ISO 1302:2002.

Examples of surface texture requirement in textual indication:

  • 0.0025-0.8/Rz 6.8
  • U Gaussian 0.08-0.8/Rz8max 3.3
See also
ModelData_PMISemanticAttribute, ModelData_PMISurfaceFinishComponent
Examples
exploring/pmi/Program.cs, and exploring/pmi/main.cxx.

Member Function Documentation

◆ ComparisonRule()

ModelData_PMISurfaceTextureRequirementAttribute::ComparisonRuleType cadex::ModelData_PMISurfaceTextureRequirementAttribute::ComparisonRule ( ) const

Returns comparison rule.

Returns 16%-rule by default.

Examples
exploring/pmi/Program.cs, and exploring/pmi/main.cxx.

◆ EvaluationLength()

double cadex::ModelData_PMISurfaceTextureRequirementAttribute::EvaluationLength ( ) const

Returns evaluation length value.

Returns 5 by default.

Examples
exploring/pmi/Program.cs, and exploring/pmi/main.cxx.

◆ FilterName()

const Base_UTF16String & cadex::ModelData_PMISurfaceTextureRequirementAttribute::FilterName ( ) const

Returns filter name.

Returns 0 by default.

Examples
exploring/pmi/Program.cs, and exploring/pmi/main.cxx.

◆ LimitValue()

double cadex::ModelData_PMISurfaceTextureRequirementAttribute::LimitValue ( ) const

Returns limit value.

The returned value is given in micrometers or microinches (depends on the value of ModelData_PMILengthUnitAttribute). Returns 0 by default.

Examples
exploring/pmi/Program.cs, and exploring/pmi/main.cxx.

◆ LongWaveFilter()

double cadex::ModelData_PMISurfaceTextureRequirementAttribute::LongWaveFilter ( ) const

Returns long wave filter value.

Returns 0 by default.

Examples
exploring/pmi/Program.cs, and exploring/pmi/main.cxx.

◆ Precedence()

size_t cadex::ModelData_PMISurfaceTextureRequirementAttribute::Precedence ( ) const

Returns precedence value.

Returns 1 by default.

Examples
exploring/pmi/Program.cs, and exploring/pmi/main.cxx.

◆ ShortWaveFilter()

double cadex::ModelData_PMISurfaceTextureRequirementAttribute::ShortWaveFilter ( ) const

Returns short wave filter value.

Returns 0 by default.

Examples
exploring/pmi/Program.cs, and exploring/pmi/main.cxx.