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

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

#include <cadex/ModelData_PMISemanticElementComponent.hxx>

Inheritance diagram for cadex::ModelData_PMISurfaceFinishComponent:
cadex::ModelData_PMISemanticElementComponent cadex::ModelData_BaseObject

Public Types

enum  MaterialRemovalType { Any , Required , Prohibited }
 
enum  LayDirectionType {
  Undefined , Parallel , Multidirectional , Perpendicular ,
  Circular , Particulate , Crossed , Radial
}
 
typedef cadex::internal::ModelData_PMISurfaceFinishComponentImpl ImplType
 
- Public Types inherited from cadex::ModelData_BaseObject
typedef int IdType
 Defines a type identifier.
 

Public Member Functions

 ModelData_PMISurfaceFinishComponent ()
 Constructor.
 
 ModelData_PMISurfaceFinishComponent (ImplType *theImpl)
 
 ModelData_PMISurfaceFinishComponent (MaterialRemovalType theValue)
 
void SetMaterialRemoval (MaterialRemovalType theValue)
 Sets type of material removal.
 
MaterialRemovalType MaterialRemoval () const
 Returns type of material removal.
 
void SetLayDirection (LayDirectionType theDirection)
 Sets type of lay direction.
 
LayDirectionType LayDirection () const
 Returns type of lay direction.
 
void SetIsAllAround (bool theAllAroundFlag)
 
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 Base_UTF16String &theMethod)
 Sets a manufacturing method.
 
const Base_UTF16StringManufacturingMethod () const
 Returns a manufacturing method.
 
- Public Member Functions inherited from cadex::ModelData_PMISemanticElementComponent
void AddAttribute (const ModelData_PMISemanticAttribute &theAttribute)
 Adds an attribute.
 
bool HasAttributes () const
 Returns true if semantic attributes were added and false otherwise.
 
size_t NumberOfAttributes () const
 Returns number of added attributes.
 
void Accept (ModelData_PMISemanticAttributeVisitor &theVisitor) const
 Accepts an attribute visitor.
 
void Accept (ModelData_PMISemanticElementComponentVisitor &theVisitor) const
 Accepts the visitor.
 
- 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_PMISemanticElementComponent
 ModelData_PMISemanticElementComponent ()
 Constructor.
 
 ModelData_PMISemanticElementComponent (internal::ModelData_PMISemanticElementComponentImpl *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 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 ModelData_PMISurfaceTextureRequirementAttribute, so ModelData_PMISurfaceTextureRequirementAttribute::Precedence() method is used to determine the order of precedence (primary, secondary, tertiary, etc).
See also
ModelData_PMISemanticElement, ModelData_PMISurfaceTextureRequirementAttribute, ModelData_PMIMachiningAllowanceAttribute
Examples
exploring/pmi/Program.cs, and exploring/pmi/main.cxx.