All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUseFill

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIGSMUseFill

Interface to surface fill feature.
Role: Allows you to access data of the Fill feature created by using boundaries (curves, lines), supports, and a continuity value

See also:

Method Index

o AddBound(CATIMmiMechanicalFeature_var&): Adds a boundary to the Fill.
o AddInnerBoundary(): Adds an Inner Boundary to the Fill.
o AddSupport(CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&): Adds a support to the Fill.
o AddSupportOnInnerWire(CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&,int): Adds a support to a wire of an Inner Boundary.
o AddWireOnInnerBoundary(CATIMmiMechanicalFeature_var&,int): Adds a wire on the 'Inner Boundary' of the Fill.
o AppendConstraint(CATIMmiMechanicalFeature_var): Append a constraint
o GetAllBoundaries(CATLISTV(CATIMmiMechanicalFeature_var)&,CATLISTV(CATIMmiMechanicalFeature_var)&): Gets all elements in the list of boundaries.
o GetAllBoundaryContinuites(CATListOfInt&): Gets all continuities set on the boundaries.
o GetAllWiresOnInnerBoundary(CATLISTV(CATIMmiMechanicalFeature_var)&,CATLISTV(CATIMmiMechanicalFeature_var)&,int): Gets all elements (wires/supports) in an Inner Boundary.
o GetBoundAtPosition(CATIMmiMechanicalFeature_var&,int): Gets the boundary which is at the given position.
o GetBoundPosition(CATIMmiMechanicalFeature_var&,int&): Gets the position of a boundary in the list.
o GetBoundSize(int&): Gets the size of the list (number of boundaries).
o GetBoundaryContinuity(enum CATGSMContinuity&,int): Gets the continuity mode for a particular boundary.
o GetCanonicalDetectionMode(CATGSMCanonicalSurfaceDetection&): Gets information about detection of canonical surfaces of the output surface.
o GetConstraint(CATIMmiMechanicalFeature_var&): Gets the constraint element.
o GetConstraints(CATLISTV(CATIMmiMechanicalFeature_var)&): Gets the list of constraint elements.
o GetContinuity(enum CATGSMContinuity&): Gets the continuity mode.
o GetDeviation(CATICkeParm_var&): Gets the deviation value.
o GetNbInnerBoundaries(int&): Gets the number of Inner Boundaries.
o GetPlaneOnlyMode(CATBoolean&): Gets the Plane Only mode.
o GetSizeOfInnerBoundary(int,int&): Gets the number of wires in an Inner Boundary.
o GetSupportAtPosOnInnerBoundary(CATIMmiMechanicalFeature_var&,int,int): Gets the Support at a given position, of an inner boundary.
o GetSupportAtPosition(CATIMmiMechanicalFeature_var&,int): Gets the Support which is at the given position.
o GetTolerantMode(CATBoolean&): Gets the tolerant fill Mode.
o GetWireAtPosOnInnerBoundary(CATIMmiMechanicalFeature_var&,int&,int&): Gets the the wire in the list of wires belonging to an Inner Boundary at a position.
o GetWireContOnInnerBoundary(enum CATGSMContinuity&,int,int): Gets the continuity mode between the wire and the support from an Inner Boundary.
o GetWirePosOnInnerBoundary(CATIMmiMechanicalFeature_var&,int&,int&): Gets the position of a wire in the list of wires belonging to an Inner Boundary.
o InsertBoundAfterPosition(CATIMmiMechanicalFeature_var&,int): Inserts a boundary after another at a given position.
o InsertBoundBeforePosition(CATIMmiMechanicalFeature_var&,int): Inserts a boundary before another at a given position.
o InsertWirBeforePosOnInnnerBoundary(CATIMmiMechanicalFeature_var&,int,int): Inserts a wire before another wire at a given position on the 'Inner Boundary'.
o InsertWireAfterPosOnInnnerBoundary(CATIMmiMechanicalFeature_var&,int,int): Inserts a wire after another wire at a given position on the 'Inner Boundary'.
o RemoveAllBound(): Removes all elements in the list of boundaries.
o RemoveAllConstraints(): Remove all constraints
o RemoveBoundAtPosition(int): Removes the boundary at the given position.
o RemoveConstraint(int): Remove a constaint
o RemoveInnerBoundary(int): Removes all wires from an Inner Boundary.
o RemoveSupportAtPosOnInnerBoundary(int,int): Removes the Support at the given position from an Inner Boundary.
o RemoveSupportAtPosition(int): Removes the Support at the given position.
o RemoveWireAtPositionOnInnerBoundary(int,int): Removes the wire from an Inner Boundary at the given position.
o ReplaceBoundAtPosition(CATIMmiMechanicalFeature_var&,int): Replaces a boundary in the list at the given position.
o ReplaceConstraint(int,CATIMmiMechanicalFeature_var&): Replace a constraint
o ReplaceSupportAtPosOnInnerBoundary(CATIMmiMechanicalFeature_var&,int,int): Replaces the Support at the given position from an Inner Boundary.
o ReplaceSupportAtPosition(CATIMmiMechanicalFeature_var&,int): Replaces the Support at the given position.
o ReplaceWireAtPosOnInnerBoundary(CATIMmiMechanicalFeature_var&,int,int): Replaces a wire in the list of wires of an Inner Boundary.
o SetBoundaryContinuity(enum CATGSMContinuity,int): Sets the continuity mode for a particular boundary.
o SetCanonicalDetectionMode(CATGSMCanonicalSurfaceDetection): Sets information about detection of canonical surfaces of the output surface.
o SetConstraint(CATIMmiMechanicalFeature_var): Sets the constraint elementt.
o SetContinuity(enum CATGSMContinuity): Sets the continuity mode.
o SetDeviation(CATICkeParm_var&): Sets the deviation value.
o SetPlaneOnlyMode(CATBoolean): Sets the Plane Only mode.
o SetTolerantMode(CATBoolean): Sets the tolerant fill Mode.
o SetWireContOnInnerBoundary(enum CATGSMContinuity,int,int): Sets the continuity mode between the wire and the support from an Inner Boundary.

Methods

o AddBound

public virtual AddBound( iBoundary)

Adds a boundary to the Fill. The boundary is added at the end of the list.

Parameters:

iBoundary: curve boundary

o AddInnerBoundary

public virtual AddInnerBoundary(

)

Adds an Inner Boundary to the Fill. User can add wires to this Inner Boundary later on.

o AddSupport

public virtual AddSupport(		`iBoundary`,
		`iSupport`)

Adds a support to the Fill.
The support is added at the end of the list.

Parameters:

iBoundary: boundary
iSupport: support

o AddSupportOnInnerWire

public virtual AddSupportOnInnerWire(		`iWire`,
		`iSupport`,
		`iBoundaryNo`)

Adds a support to a wire of an Inner Boundary.
The support is added at the end of the list.

Parameters:

iWire: Wire on which support is added
iSupport: Support
iBoundaryNo: The inner boundary number

o AddWireOnInnerBoundary

public virtual AddWireOnInnerBoundary(		`iWire`,
		`iBoundaryNo`	`= -1`)

Adds a wire on the 'Inner Boundary' of the Fill. The wire is added on the specified Inner Boundary at the end of the list.

Parameters:

iWire: wire for inner boundary
iBoundaryNo: The inner boundary number If iBoundNo is not specified, the wire is added to the last location of the last Inner Boundary.

o AppendConstraint

public virtual AppendConstraint( const ihSpecObject)

Append a constraint

Parameters:

ihSpecObject: the constraint to append ======== ONLY USE IN FSS ==============

o GetAllBoundaries

public virtual GetAllBoundaries(		`oBoundary`,
		`oSupport`)

Gets all elements in the list of boundaries.

Parameters:

CATLISTV: oBoundary list of boundaries
CATLISTV: oSupport list of supports

o GetAllBoundaryContinuites

public virtual GetAllBoundaryContinuites( oContinuity)

Gets all continuities set on the boundaries.

Parameters:

CATListOfInt: oContinuity list of continuites

o GetAllWiresOnInnerBoundary

public virtual GetAllWiresOnInnerBoundary(		`oWires`,
		`oSupports`,
		`iBoundaryNo`)

Gets all elements (wires/supports) in an Inner Boundary.

Parameters:

CATLISTV: oWires List of wires of the inner boundary
CATLISTV: oSupports List of supports of the inner boundary
iBoundaryNo: The inner boundary number

o GetBoundAtPosition

public virtual GetBoundAtPosition(		`oBoundary`,
		`iPos`)

Gets the boundary which is at the given position.

Parameters:

oBoundary: curve boundary
iPos: position of the curve boundary in the list of boundaries

o GetBoundPosition

public virtual GetBoundPosition(		`oBoundary`,
		`Pos`)

Gets the position of a boundary in the list.

Parameters:

oBoundary: curve boundary
Pos: position of the curve boundary in the list of boundaries

o GetBoundSize

public virtual GetBoundSize( oSize)

Gets the size of the list (number of boundaries).

Parameters:

oSize: size of the list of boundaries

o GetBoundaryContinuity

public virtual GetBoundaryContinuity(		`oContinuity`,
		`iPos`)

Gets the continuity mode for a particular boundary.

Parameters:

oContinuity: continuity between the support and the fill
iPos: position of the curve boundary in the list of boundaries

o GetCanonicalDetectionMode

public virtual GetCanonicalDetectionMode( oDetection)

Gets information about detection of canonical surfaces of the output surface.

Parameters:

oDetection: If canonical surfaces are detected or not; Possible values are CATGSMNoDetection and CATGSMCanonicalDetection.

See also:

o GetConstraint

public virtual GetConstraint( oConstraint)

Gets the constraint element.

Parameters:

oConstraint: new constraint element

o GetConstraints

public virtual GetConstraints( oSpecObjectsList)

Gets the list of constraint elements.

Parameters:

CATLISTV: oSpecObjectsList list of new constraint elements ======== ONLY USE IN FSS ==============

o GetContinuity

public virtual GetContinuity( oContinuity)

Gets the continuity mode.

Parameters:

oContinuity: continuity between the support and the fill

o GetDeviation

public virtual GetDeviation( ohDeviation)

Gets the deviation value.

Parameters:

ohDeviation: The deviation value

o GetNbInnerBoundaries

public virtual GetNbInnerBoundaries( ioNbInnerBoundaries)

Gets the number of Inner Boundaries.

Parameters:

ioNbInnerBoundaries: The total number of Inner Boundaries Each Inner Boundary will have inner wire/s which defines a closed contour.

o GetPlaneOnlyMode

public virtual GetPlaneOnlyMode( oPlaneOnly)

Gets the Plane Only mode.

Parameters:

oPlaneOnly: Fill type if planar boundaries

o GetSizeOfInnerBoundary

public virtual GetSizeOfInnerBoundary(		`iBoundaryNo`,
		`oSize`)

Gets the number of wires in an Inner Boundary.

Parameters:

iBoundaryNo: The inner boundary number
oSize: Size of the list of wires in an Inner Boundary

o GetSupportAtPosOnInnerBoundary

public virtual GetSupportAtPosOnInnerBoundary(		`oSupport`,
		`iBoundaryNo`,
		`iPos`)

Gets the Support at a given position, of an inner boundary.

Parameters:

oSupport: Support
iBoundaryNo: The inner boundary number
iPos: Position of the wire in the list of boundaries of an Inner Boundary

o GetSupportAtPosition

public virtual GetSupportAtPosition(		`oSupport`,
		`iPos`)

Gets the Support which is at the given position.

Parameters:

oSupport: support
iPos: position of the curve boundary in the list of boundaries

o GetTolerantMode

public virtual GetTolerantMode( oMode)

Gets the tolerant fill Mode.

Parameters:

oMode: Current status of Tolerant Mode TRUE/FALSE

o GetWireAtPosOnInnerBoundary

public virtual GetWireAtPosOnInnerBoundary(		`oWire`,
		`iBoundaryNo`,
		`iPos`)

Gets the the wire in the list of wires belonging to an Inner Boundary at a position.

Parameters:

oWire: wire at iPos on the Inner boundary
iBoundaryNo: The inner boundary number
iPos: Position of the wire in the list of wires of an 'Inner Boundary'

o GetWireContOnInnerBoundary

public virtual GetWireContOnInnerBoundary(		`oContinuity`,
		`iBoundaryNo`,
		`iPos`)

Gets the continuity mode between the wire and the support from an Inner Boundary.

Parameters:

oContinuity: Continuity between the support and the fill
iBoundaryNo: The inner boundary number
iPos: Position of the wire in the list of boundaries of an Inner Boundary

o GetWirePosOnInnerBoundary

public virtual GetWirePosOnInnerBoundary(		`iWire`,
		`iBoundaryNo`,
		`oPos`)

Gets the position of a wire in the list of wires belonging to an Inner Boundary.

Parameters:

iWire: wire in the Inner boundary
iBoundaryNo: The inner boundary number
oPos: Position of the wire in the list of wires of an 'Inner Boundary'

o InsertBoundAfterPosition

public virtual InsertBoundAfterPosition(		`iBoundary`,
		`iPos`)

Inserts a boundary after another at a given position.

Parameters:

iBoundary: curve boundary
iPos: position of the curve boundary in the list of boundaries

o InsertBoundBeforePosition

public virtual InsertBoundBeforePosition(		`iBoundary`,
		`iPos`)

Inserts a boundary before another at a given position.

Parameters:

iBoundary: curve boundary
Pos: position of the curve boundary in the list of boundaries

o InsertWirBeforePosOnInnnerBoundary

public virtual InsertWirBeforePosOnInnnerBoundary(		`iWire`,
		`iBoundaryNo`,
		`iPos`)

Inserts a wire before another wire at a given position on the 'Inner Boundary'.

Parameters:

iWire: wire to insert in the inner boundary
iBoundaryNo: The inner boundary number
iPos: Position of the wire in the list of wires of an 'Inner Boundary'

o InsertWireAfterPosOnInnnerBoundary

public virtual InsertWireAfterPosOnInnnerBoundary(		`iWire`,
		`iBoundaryNo`,
		`iPos`)

Inserts a wire after another wire at a given position on the 'Inner Boundary'.

Parameters:

iWire: wire to insert in the inner boundary
iBoundNo: The inner boundary number
iPos: Position of the wire in the list of wires of an 'Inner Boundary'

o RemoveAllBound

public virtual RemoveAllBound(

)

Removes all elements in the list of boundaries.

o RemoveAllConstraints

public virtual RemoveAllConstraints(

)

Remove all constraints

o RemoveBoundAtPosition

public virtual RemoveBoundAtPosition( iPos)

Removes the boundary at the given position.

Parameters:

iPos: position of the curve boundary in the list of boundaries

o RemoveConstraint

public virtual RemoveConstraint( i)

Remove a constaint

Parameters:

i: the position of the constraint to remove ======== ONLY USE IN FSS ==============

o RemoveInnerBoundary

public virtual RemoveInnerBoundary( iBoundaryNo)

Removes all wires from an Inner Boundary.

Parameters:

iBoundaryNo: The inner boundary number

o RemoveSupportAtPosOnInnerBoundary

public virtual RemoveSupportAtPosOnInnerBoundary(		`iBoundaryNo`,
		`iPos`)

Removes the Support at the given position from an Inner Boundary.

Parameters:

iBoundaryNo: The inner boundary number
iPos: Position of the wire in the list of boundaries of an Inner Boundary

o RemoveSupportAtPosition

public virtual RemoveSupportAtPosition( iPos)

Removes the Support at the given position.

Parameters:

iPos: position of the curve boundary in the list of boundaries

o RemoveWireAtPositionOnInnerBoundary

public virtual RemoveWireAtPositionOnInnerBoundary(		`iBoundaryNo`,
		`iPos`)

Removes the wire from an Inner Boundary at the given position.

Parameters:

iBoundaryNo: The inner boundary number
iPos: Position of the wire in the list of wires of an 'Inner Boundary'

o ReplaceBoundAtPosition

public virtual ReplaceBoundAtPosition(		`iBoundary`,
		`iPos`)

Replaces a boundary in the list at the given position.

Parameters:

iBoundary: curve boundary
iPos: position of the curve boundary in the list of boundaries

o ReplaceConstraint

public virtual ReplaceConstraint(		`i`,
	const	`ihSpecObject`)

Replace a constraint

Parameters:

i: the position of the constraint to replace
ihSpecObject: the new constraint ======== ONLY USE IN FSS ==============

o ReplaceSupportAtPosOnInnerBoundary

public virtual ReplaceSupportAtPosOnInnerBoundary(		`iSupport`,
		`iBoundaryNo`,
		`iPos`)

Replaces the Support at the given position from an Inner Boundary.

Parameters:

iSupport: the support to replace
iBoundaryNo: The inner boundary number
iPos: Position of the wire in the list of boundaries of an Inner Boundary

o ReplaceSupportAtPosition

public virtual ReplaceSupportAtPosition(		`iSupport`,
		`iPos`)

Replaces the Support at the given position.

Parameters:

iSupport: support
iPos: position of the curve boundary in the list of boundaries

o ReplaceWireAtPosOnInnerBoundary

public virtual ReplaceWireAtPosOnInnerBoundary(		`iWire`,
		`iBoundaryNo`,
		`iPos`)

Replaces a wire in the list of wires of an Inner Boundary.

Parameters:

iWire: wire to replace
iBoundaryNo: The inner boundary number
iPos: Position of the wire in the list of wires of an 'Inner Boundary'

o SetBoundaryContinuity

public virtual SetBoundaryContinuity(	const	`iContinuity`,
		`iPos`)

Sets the continuity mode for a particular boundary.

Parameters:

iContinuity: continuity between the support and the fill
iPos: position of the curve boundary in the list of boundaries

o SetCanonicalDetectionMode

public virtual SetCanonicalDetectionMode( iDetection = CATGSMNoDetection)

Sets information about detection of canonical surfaces of the output surface.

Parameters:

iDetection: If canonical surfaces are detected or not; Possible values are CATGSMNoDetection and CATGSMCanonicalDetection.

See also:

o SetConstraint

public virtual SetConstraint( const iConstraint)

Sets the constraint elementt.

Parameters:

iConstraint: new constraint element

o SetContinuity

public virtual SetContinuity( const iContinuity)

Sets the continuity mode.

Parameters:

iContinuity: continuity between the support and the fill

o SetDeviation

public virtual SetDeviation( const ihDeviation)

Sets the deviation value. This value is used only if tolerant mode is set to TRUE. The value of this parameter should lie within resolution and 100*resolution.

Parameters:

ihDeviation: The deviation value

o SetPlaneOnlyMode

public virtual SetPlaneOnlyMode( PlaneOnly)

Sets the Plane Only mode.

Parameters:

PlaneOnly: Fill type if planar boundaries

o SetTolerantMode

public virtual SetTolerantMode( iMode)

Sets the tolerant fill Mode.

Parameters:

iMode: Tolerant Mode - TRUE/FALSE

o SetWireContOnInnerBoundary

public virtual SetWireContOnInnerBoundary(	const	`iContinuity`,
		`iBoundaryNo`,
		`iPos`)

Sets the continuity mode between the wire and the support from an Inner Boundary.

Parameters:

iContinuity: Continuity between the support and the fill
iBoundaryNo: The inner boundary number
iPos: Position of the wire in the list of boundaries of an Inner Boundary

This object is included in the file: CATIGSMUseFill.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf