All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

DraftingInterfaces Class CATDimSystemDefinition

CATDimSystemDefinition
 

Usage: you must use this class as is. You should never derive it.


public class CATDimSystemDefinition

Class to initialize basic informations necessary to the dimension system creation.
To create a dimension system see CATIDrwAnnotationFactory.CreateDimSystem .


Constructor and Destructor Index


o CATDimSystemDefinition()
Constructor operator.
o CATDimSystemDefinition(CATDimSystemDefinition&)
Copy Constructor operator.
o ~CATDimSystemDefinition()
Destructor operator.

Method Index


o GetAutoFunnelMode(CATBoolean&)
Gets the automatically funnel mode.
o GetOffsetMode(CATDrwSystOffsetMode&)
Gets the offset mode.
o GetValueAlignmentMode(CATDrwSystValueAlignment&)
Gets the value alignment mode.
o GetValueAlignmentOffset(double&)
Gets offset to assign to dimension values.
o GetValueOffset(double&)
Gets offset between dimension lines.
o SetAutoFunnelMode(CATBoolean)
Manages the automatically funnel mode.
o SetOffsetMode(CATDrwSystOffsetMode)
Sets the offset mode.
o SetValueAlignmentMode(CATDrwSystValueAlignment)
Sets the value alignment mode.
o SetValueAlignmentOffset(double)
Sets offset to assign to dimension values.
o SetValueOffset(double)
Sets offset between dimension lines.
o operator =(CATDimSystemDefinition&)
Assignment operator.

Data Member Index


o SystemType
Dimensions system type.

Constructor and Destructor


o CATDimSystemDefinition
public CATDimSystemDefinition()
Constructor operator.
o CATDimSystemDefinition
public CATDimSystemDefinition( const CATDimSystemDefinition& )
Copy Constructor operator.
o ~CATDimSystemDefinition
public ~CATDimSystemDefinition()
Destructor operator.

Methods


o GetAutoFunnelMode
public const HRESULT GetAutoFunnelMode(CATBoolean& oAutoFunnel)
Gets the automatically funnel mode.
Returns:
S_OK : Method correctly executed.
No restriction.
S_FALSE : Method correctly executed.
The returned value is the default value initialized by the constructor. this value was not overloaded..
o GetOffsetMode
public const HRESULT GetOffsetMode(CATDrwSystOffsetMode& oOffsetMode)
Gets the offset mode.
Role: To retrieve the offset mode to apply to dimension lines line-up.
See also:
CATDrwSystOffsetMode
Returns:
S_OK : Method correctly executed.
No restriction.
S_FALSE : Method correctly executed.
The returned value is the default value initialized by the constructor. this value was not overloaded..
o GetValueAlignmentMode
public const HRESULT GetValueAlignmentMode(CATDrwSystValueAlignment& oAlignmentMode)
Gets the value alignment mode.
Role: To retrieve the alignment mode to apply to dimension value.
See also:
CATDrwSystOffsetMode
o GetValueAlignmentOffset
public const HRESULT GetValueAlignmentOffset(double& oValueAlignment)
Gets offset to assign to dimension values.
Role: to retrieve the offset of dimension values
Returns:
S_OK : Method correctly executed.
No restriction.
S_FALSE : Method correctly executed.
The returned value is the default value initialized by the constructor. this value was not overloaded..
o GetValueOffset
public const HRESULT GetValueOffset(double& oValueOffset)
Gets offset between dimension lines.
Role: to retrieve the eventual offset between dimension lines
Returns:
S_OK : Method correctly executed.
No restriction.
S_FALSE : Method correctly executed.
The returned value is the default value initialized by the constructor. this value was not overloaded..
o SetAutoFunnelMode
public HRESULT SetAutoFunnelMode( const CATBoolean iAutoFunnel)
Manages the automatically funnel mode.
Role: If this mode is activated, a funnel will be automatically added when dimension value is too large to be contained between extension lines
o SetOffsetMode
public HRESULT SetOffsetMode( const CATDrwSystOffsetMode iOffsetMode)
Sets the offset mode.
Precondition Stacked dimension system only.
Role: To define the offset mode to apply to dimension lines line-up.
See also:
CATDrwSystOffsetMode
o SetValueAlignmentMode
public HRESULT SetValueAlignmentMode( const CATDrwSystValueAlignment iAlignmentMode)
Sets the value alignment mode.
Precondition Stacked dimension system only.
Role: To define the alignment mode to apply to dimension value.
See also:
CATDrwSystOffsetMode
o SetValueAlignmentOffset
public HRESULT SetValueAlignmentOffset( const double iValueAlignment)
Sets offset to assign to dimension values.
Precondition Available only if OffsetMode is set to OnRefLineSide or OppToRefLineSide
Role: to define the offset of dimension values
Returns:
S_OK : Method correctly executed.
No restriction.
E_FAIL : Value out of range.
o SetValueOffset
public HRESULT SetValueOffset( const double iValueOffset)
Sets offset between dimension lines.
Precondition Available if OffsetMode is set to constant.
Role: to define the eventual offset between dimension lines
Returns:
S_OK : Method correctly executed.
No restriction.
E_FAIL : Value out of range.
o operator =
public CATDimSystemDefinition& operator =( const CATDimSystemDefinition& )
Assignment operator.
Role: Assignment operator.

Data Members


o SystemType
  public CATDrwDimSystemType SystemType
Dimensions system type.
Role: Define the type of the dimensions system.
Parameters:
SystemType
See also:
CATDrwDimSystemType

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

Copyright © 2003, Dassault Systèmes. All rights reserved.