Hide menu
Loading...
Searching...
No Matches
cadex::PMI::SurfaceFinishComponent Class Reference

Defines a component represented by a suface texture. More...

#include <cadex/PMI/SemanticComponent.hxx>

Inheritance diagram for cadex::PMI::SurfaceFinishComponent:
cadex::PMI::SemanticComponent cadex::BaseObject

Public Types

enum class  MaterialRemovalType { Any , Required , Prohibited }
 
enum class  LayDirectionType {
  Undefined , Parallel , Multidirectional , Perpendicular ,
  Circular , Particulate , Crossed , Radial
}
 
- Public Types inherited from cadex::BaseObject
typedef std::shared_ptr< internal::BaseObjectImpl > ImplType
 

Public Member Functions

 SurfaceFinishComponent ()
 Constructor.
 
 SurfaceFinishComponent (MaterialRemovalType theValue)
 Constructor.
 
 SurfaceFinishComponent (MaterialRemovalType theValue, LayDirectionType theDirection, bool theAllAroundFlag, const UTF16String &theMethod)
 Constructor.
 
void SetMaterialRemoval (MaterialRemovalType theValue)
 Sets the type of the material removal.
 
MaterialRemovalType MaterialRemoval () const
 Returns the type of the material removal.
 
void SetLayDirection (LayDirectionType theDirection)
 Sets the type of the lay direction.
 
LayDirectionType LayDirection () const
 Returns the type of the lay direction.
 
void SetIsAllAround (bool theAllAroundFlag)
 Sets the all around flag.
 
bool IsAllAround () const
 Returns true if the same surface texture is required on all surfaces around a workpiece outline and false otherwise.
 
void SetManufacturingMethod (const UTF16String &theMethod)
 Sets the manufacturing method.
 
UTF16String ManufacturingMethod () const
 Returns the manufacturing method.
 
- Public Member Functions inherited from cadex::PMI::SemanticComponent
void AddAttribute (const SemanticAttribute &theAttribute)
 Adds the attribute.
 
const std::vector< PMI::SemanticAttribute > & Attributes () const
 Returns the attributes.
 
bool HasAttributes () const
 Returns true if semantic attributes were added and false otherwise.
 
size_t NumberOfAttributes () const
 Returns the number of added attributes.
 
void Accept (SemanticAttributeVisitor &theVisitor) const
 Accepts an attribute visitor.
 
void Accept (SemanticComponentVisitor &theVisitor) const
 Accepts the visitor.
 
- Public Member Functions inherited from cadex::BaseObject
size_t Id () const
 Return unique identifier of public object.
 
internal::BaseObjectImpl * Impl () const
 
bool IsNull () const
 
 operator bool () const
 
template<typename T >
bool IsOfType () const
 
template<typename T >
T * Impl () const
 Reserved for internal use.
 

Static Public Member Functions

static bool CompareType (const BaseObject &theObject)
 Returns true if theObject has the SurfaceFinishComponent type.
 
- Static Public Member Functions inherited from cadex::PMI::SemanticComponent
static bool CompareType (const BaseObject &theObject)
 Returns true if theObject has the SemanticComponent type.
 

Additional Inherited Members

- Protected Member Functions inherited from cadex::PMI::SemanticComponent
 SemanticComponent (const ImplType &theImpl)
 
- Protected Member Functions inherited from cadex::BaseObject
 BaseObject (const ImplType &theImpl)
 

Detailed Description

Defines a component represented by a suface texture.

Specifies the texture of a surface through surface texture requirements, manufacturing method, surface lay and its orientation, possible machining allowance, etc.

Note
The component can store multiple SurfaceTextureRequirementAttribute, so SurfaceTextureRequirementAttribute::Precedence() method is used to determine the order of precedence (primary, secondary, tertiary, etc).
See also
SemanticElement, SurfaceTextureRequirementAttribute, MachiningAllowanceAttribute
Examples
exploring/pmi/Program.cs, and exploring/pmi/main.cxx.