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

Describes a machining pocket. More...

Inheritance diagram for cadex::Machining_Pocket:
cadex::MTKBase_ShapeFeature cadex::MTKBase_Feature

Public Member Functions

 Machining_Pocket ()
 Constructor.
 
 Machining_Pocket (double theWidth, double theLength, double theDepth, Machining_PocketType theType)
 Constructor.
 
double Width () const
 Returns the pocket width in mm.
 
void SetWidth (double theWidth)
 Sets width for pocket in mm.
 
double Length () const
 Returns the pocket length in mm .
 
void SetLength (double theLength)
 Sets length for pocket in mm.
 
double Depth () const
 Returns the pocket depth in mm .
 
void SetDepth (double theDepth)
 Sets depth for pocket in mm.
 
bool HasAxis () const
 Returns true if z-axis is determined for pocket.
 
const Geom::Axis1dAxis () const
 Returns z-axis of a pocket - the axis along which the depth is determined.
 
void SetAxis (const Geom::Axis1d &theAxis)
 Sets z-axis for pocket.
 
Machining_PocketType Type () const
 Returns the pocket type.
 
void SetType (Machining_PocketType theType)
 Sets type for pocket.
 
double MaxCutterRadius () const
 Returns the maximum cutter radius in mm .
 
void SetMaxCutterRadius (double theRadius)
 Sets maximal cutter radius in mm.
 
- Public Member Functions inherited from cadex::MTKBase_ShapeFeature
 MTKBase_ShapeFeature ()
 Constructor.
 
 MTKBase_ShapeFeature (const ModelData::Shape &theShape)
 Constructor.
 
const ModelData::ShapeShape () const
 Returns shape of the feature.
 
void SetShape (const ModelData::Shape &theShape)
 Sets shape of the feature.
 
- Public Member Functions inherited from cadex::MTKBase_Feature
 MTKBase_Feature ()
 Constructor.
 
 ~MTKBase_Feature ()
 Destructor.
 
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.
 
template<typename T >
bool IsOfType () const
 
ImplType * Impl () const
 
template<typename T >
T * Impl () const
 Reserved for internal use.
 
bool operator== (const MTKBase_Feature &theObject) const
 
bool operator!= (const MTKBase_Feature &theObject) const
 

Static Public Member Functions

static bool CompareType (const MTKBase_Feature &theFeature)
 Returns true if theFeature is a machining Pocket.
 
- Static Public Member Functions inherited from cadex::MTKBase_ShapeFeature
static bool CompareType (const MTKBase_Feature &theFeature)
 Returnstrue if theFeature is a shape feature.
 

Additional Inherited Members

- Public Types inherited from cadex::MTKBase_ShapeFeature
typedef cadex::internal::MTKBaseImpl_ShapeFeature ImplType
 
typedef std::shared_ptr< ImplType > ImplPtrType
 
- Public Types inherited from cadex::MTKBase_Feature
typedef cadex::internal::MTKBaseImpl_Feature ImplType
 
typedef std::shared_ptr< ImplType > ImplPtrType
 
- Protected Member Functions inherited from cadex::MTKBase_ShapeFeature
 MTKBase_ShapeFeature (ImplPtrType theImpl)
 Reserved for internal use.
 
- Protected Member Functions inherited from cadex::MTKBase_Feature
 MTKBase_Feature (ImplPtrType theImpl)
 Reserved for internal use.
 
- Protected Attributes inherited from cadex::MTKBase_Feature
ImplPtrType myImpl
 

Detailed Description

Describes a machining pocket.

A pocket is a feature obtained by milling the material inside an arbitrarily closed boundary on a flat surface of a workpiece removed to a fixed depth.

Shape() method returns ModelData::Shell for this class.

Pocket

Pocket have the following basic parameters: width in mm, length in mm, depth in mm and axis.

Pocket parameters
Examples
machining/feature_recognizer/Program.cs, and machining/feature_recognizer/main.cxx.

Constructor & Destructor Documentation

◆ Machining_Pocket() [1/2]

cadex::Machining_Pocket::Machining_Pocket ( )

Constructor.

◆ Machining_Pocket() [2/2]

cadex::Machining_Pocket::Machining_Pocket ( double theWidth,
double theLength,
double theDepth,
Machining_PocketType theType )

Constructor.

Creates a machining Pocket from width, length, depth and type.

Member Function Documentation

◆ Axis()

const Geom::Axis1d & cadex::Machining_Pocket::Axis ( ) const

Returns z-axis of a pocket - the axis along which the depth is determined.

See also
HasAxis(), SetAxis()
Examples
machining/feature_recognizer/Program.cs.

◆ CompareType()

bool cadex::Machining_Pocket::CompareType ( const MTKBase_Feature & theFeature)
static

Returns true if theFeature is a machining Pocket.

Examples
machining/feature_recognizer/Program.cs.

◆ Depth()

double cadex::Machining_Pocket::Depth ( ) const

Returns the pocket depth in mm .

See also
SetDepth()
Examples
machining/feature_recognizer/Program.cs.

◆ HasAxis()

bool cadex::Machining_Pocket::HasAxis ( ) const

Returns true if z-axis is determined for pocket.

See also
Axis(), SetAxis()

◆ Length()

double cadex::Machining_Pocket::Length ( ) const

Returns the pocket length in mm .

See also
SetLength()
Examples
machining/feature_recognizer/Program.cs.

◆ MaxCutterRadius()

double cadex::Machining_Pocket::MaxCutterRadius ( ) const

Returns the maximum cutter radius in mm .

Returns the maximum cutter radius allowed by the pocket geometry. Considers internal fillets radii and minimum wall-to-wall clearance. Returns 0 if non-zero radius fits (e.g. a sharp interior corner parallel to the pocket axis.

See also
SetMaxCutterRadius()
Examples
machining/feature_recognizer/Program.cs.

◆ SetAxis()

void cadex::Machining_Pocket::SetAxis ( const Geom::Axis1d & theAxis)

Sets z-axis for pocket.

See also
HasAxis(), Axis()

◆ SetDepth()

void cadex::Machining_Pocket::SetDepth ( double theDepth)

Sets depth for pocket in mm.

The value must be more than zero.

See also
Depth()

◆ SetLength()

void cadex::Machining_Pocket::SetLength ( double theLength)

Sets length for pocket in mm.

The value must be more than zero.

See also
Length()

◆ SetMaxCutterRadius()

void cadex::Machining_Pocket::SetMaxCutterRadius ( double theRadius)

Sets maximal cutter radius in mm.

The value must not be less than zero.

See also
MaxCutterRadius()

◆ SetType()

void cadex::Machining_Pocket::SetType ( Machining_PocketType theType)

Sets type for pocket.

See also
Type()

◆ SetWidth()

void cadex::Machining_Pocket::SetWidth ( double theWidth)

Sets width for pocket in mm.

The value must be more than zero.

See also
Width()

◆ Type()

Machining_PocketType cadex::Machining_Pocket::Type ( ) const

Returns the pocket type.

See also
SetType()

◆ Width()

double cadex::Machining_Pocket::Width ( ) const

Returns the pocket width in mm.

See also
SetWidth()
Examples
machining/feature_recognizer/Program.cs.