pycatia.drafting_interfaces.drawing_dim_value

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.drafting_interfaces.drawing_dim_value.DrawingDimValue(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
DrawingDimValue

Manages dimension value of a dimension in drawing view.

This interface is obtained from DrawingDimension.GetValue
method.
property fake_dim_type: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property FakeDimType() As CatDimFake

Returns or sets fake dimension type of value.

Example:
This example retrieves fake dimension type of value MyDimValue drawing
dimension.

oFakeType = MyDimValue.FakeDimType
Returns:

enum cat_dim_fake

Return type:

int

get_bault_text(i_index: int, o_before: str, o_after: str, o_upper: str, o_lower: str) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub GetBaultText(long iIndex,
CATBSTR oBefore,
CATBSTR oAfter,
CATBSTR oUpper,
CATBSTR oLower)

Get bault text of dimension value.

Parameters:

iIndex
1: main value 2: dual value
oBefore
before text.
oAfter
after text
oUpper
upper text
oLower
lower text
Example:
This example gets bault text of MyValue path.

MyValue.GetBaultText(iIndex, oBefore, oAfter, oUpper,
oLower)
Parameters:

  • i_index (int) –

  • o_before (str) –

  • o_after (str) –

  • o_upper (str) –

  • o_lower (str) –

Return type:

None

get_display_unit(i_index: int) → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetDisplayUnit(long iIndex) As long

Get display unit of dimension value.

Parameters:

Index
1: main value 2: dual value
oDisplUnit
before text.
Example:
This example gets format unit of MyValue path.

FrmUnit = MyValue.GetDisplayUnit(iIndex)
Parameters:

i_index (int) –

Return type:

int

get_fake_dim_value(i_index: int) → str

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetFakeDimValue(long iIndex) As CATBSTR

Get fake value of dimension.

Parameters:

iIndex
1: main value 2: dual value
oFakeDimValue
before text.
Example:
This example gets fake value of MyValue path.

FakeDimValue = MyValue.GetFakeDimValue(iIndex)
Parameters:

i_index (int) –

Return type:

str

get_format_display_factor(i_index: int) → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetFormatDisplayFactor(long iIndex) As long

Get format display factor of dimension value.

Parameters:

iIndex
1: main value 2: dual value
oFrmDspFact
before text.
Example:
This example gets format display factor of MyValue
path.

FrmDspFact = MyValue.GetFormatDisplayFactor(iIndex)
Parameters:

i_index (int) –

Return type:

int

get_format_name(i_index: int) → str

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetFormatName(long iIndex) As CATBSTR

Get format name of dimension value.

Parameters:

iIndex
1: main value 2: dual value
oFmName
before text.
Example:
This example gets format name of MyValue path.

FmName = MyValue.GetFormatName(iIndex)
Parameters:

i_index (int) –

Return type:

str

get_format_precision(index: int) → float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetFormatPrecision(long Index) As double

Get format precision of dimension value.

Parameters:

iIndex
1: main value 2: dual value
oFrmPrecision
before text.
Example:
This example gets format precision of MyValue
path.

FrmPrecision = MyValue.GetFormatPrecision(iIndex)
Parameters:

index (int) –

Return type:

float

get_format_type(i_index: int) → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetFormatType(long iIndex) As long

Get format type of dimension value.

Parameters:

iIndex
1: main value 2: dual value
oFrmType
before text.
Example:
This example gets format type of MyValue path.

FrmType = MyValue.GetFormatType(iIndex)
Parameters:

i_index (int) –

Return type:

int

get_format_unit(i_index: int) → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetFormatUnit(long iIndex) As long

Get format unit of dimension value.

Parameters:

Index
1: main value 2: dual value
oFrmUnit
before text.
Example:
This example gets format unit of MyValue path.

FrmUnit = MyValue.GetFormatUnit(iIndex)
Parameters:

i_index (int) –

Return type:

int

get_ps_text(i_index: int, o_prefix: str, o_suffix: str) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub GetPSText(long iIndex,
CATBSTR oPrefix,
CATBSTR oSuffix)

Get PS text to dimension value.

Parameters:

iIndex
1: main value 2: dual value
oPrefix
prefix text.
oSuffix
suffix text
Example:
This example gets PS text of MyValue path.

MyValue.GetBaultText(iIndex, oPrefix, oSuffix)
Parameters:

  • i_index (int) –

  • o_prefix (str) –

  • o_suffix (str) –

Return type:

None

get_scored_element(i_index: int) → bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetScoredElement(long iIndex) As boolean

Get dimension scored element.

Parameters:

iIndex
1: main value 2: dual value
oScoredElement
TRUE: Scoring is applied to the all bloc text. FALSE: Scoring is
only applied to the value.
Example:
This example gets dimension scored element of MyValue
path.

ScoredElement = MyValue.GetScoredElement(iIndex)
Parameters:

i_index (int) –

Return type:

bool

property scoring_mode: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property ScoringMode() As CatDimScore

Get dimension scoring mode.
Example:
This example gets dimension scoring mode of MyValue path.

ValueScoreType = MyValue.ScoringMode
Returns:

enum cat_dim_score

Return type:

int

set_bault_text(i_index: int, i_before: str, i_after: str, i_upper: str, i_lower: str) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetBaultText(long iIndex,
CATBSTR iBefore,
CATBSTR iAfter,
CATBSTR iUpper,
CATBSTR iLower)

Set bault text to dimension value.

Parameters:

iIndex
1: main value 2: dual value
iBefore
before text.
iAfter
after text
iUpper
upper text
iLower
lower text
Example:
This example sets bault text of MyValue path.

MyValue.SetBaultText(iIndex, iBefore, iAfter, iUpper,
iLower)
Parameters:

  • i_index (int) –

  • i_before (str) –

  • i_after (str) –

  • i_upper (str) –

  • i_lower (str) –

Return type:

None

set_fake_dim_value(i_index: int, i_fake_dim_value: str) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetFakeDimValue(long iIndex,
CATBSTR iFakeDimValue)

Set fake value of dimension value.

Parameters:

iIndex
1: main value 2: dual value
iFakeDimValue
before text.
Example:
This example gets fake value of MyValue path.

MyValue.SetFakeDimValue(iIndex, iFakeDimValue)
Parameters:

  • i_index (int) –

  • i_fake_dim_value (str) –

Return type:

None

set_format_display_factor(i_index: int, i_frm_dsp_fact: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetFormatDisplayFactor(long iIndex,
long iFrmDspFact)

Set format display factor of dimension value.

Parameters:

iIndex
1: main value 2: dual value
iFrmDspFact
before text.
Example:
This example gets format display factor of MyValue
path.

MyValue.SetFormatDisplayFactor(iIndex,
iFrmDspFact)
Parameters:

  • i_index (int) –

  • i_frm_dsp_fact (int) –

Return type:

None

set_format_name(i_index: int, i_frm_name: str) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetFormatName(long iIndex,
CATBSTR iFrmName)

Set format name of dimension value.

Parameters:

iIndex
1: main value 2: dual value
iFrmName
before text.
Example:
This example gets format name of MyValue path.

MyValue.SetFormatName(iIndex, iFrmName)
Parameters:

  • i_index (int) –

  • i_frm_name (str) –

Return type:

None

set_format_precision(i_index: int, i_frm_precision: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetFormatPrecision(long iIndex,
double iFrmPrecision)

Set format precision of dimension value.

Parameters:

iIndex
1: main value 2: dual value
iFrmPrecision
before text.
Example:
This example gets format precision of MyValue
path.

MyValue.SetFormatPrecision(iIndex, iFrmPrecision)
Parameters:

  • i_index (int) –

  • i_frm_precision (float) –

Return type:

None

set_format_type(i_index: int, i_frm_type: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetFormatType(long iIndex,
long iFrmType)

Set format type of dimension value.

Parameters:

iIndex
1: main value 2: dual value
iFrmType
before text.
Example:
This example gets format type of MyValue path.

MyValue.SetFormatType(iIndex, iFrmType)
Parameters:

  • i_index (int) –

  • i_frm_type (int) –

Return type:

None

set_format_unit(i_index: int, i_frm_unit: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetFormatUnit(long iIndex,
long iFrmUnit)

Set format unit of dimension value.

Parameters:

iIndex
1: main value 2: dual value
iFrmUnit
before text.
Example:
This example gets format unit of MyValue path.

MyValue.SetFormatUnit(iIndex, iFrmUnit)
Parameters:

  • i_index (int) –

  • i_frm_unit (int) –

Return type:

None

set_ps_text(i_index: int, i_prefix: str, i_suffix: str) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetPSText(long iIndex,
CATBSTR iPrefix,
CATBSTR iSuffix)

Set PS text to dimension value.

Parameters:

iIndex
1: main value 2: dual value
iPrefix
prefix text.
iSuffix
suffix text
Example:
This example sets PS text of MyValue path.

MyValue.SetBaultText(iIndex, iPrefix, iSuffix)
Parameters:

  • i_index (int) –

  • i_prefix (str) –

  • i_suffix (str) –

Return type:

None

set_scored_element(i_index: int, i_scored_element: bool) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetScoredElement(long iIndex,
boolean iScoredElement)

Set dimension scored element.

Parameters:

iIndex
1: main value 2: dual value
iScoredElement
TRUE: Scoring is applied to the all bloc text. FALSE: Scoring is
only applied to the value.
Example:
This example gets dimension scored element of MyValue
path.

MyValue.SetScoredElement(iIndex, iScoredElement)
Parameters:

  • i_index (int) –

  • i_scored_element (bool) –

Return type:

None

property value: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property Value() As double (Read Only)

Returns value of dimension.

Example:
This example retrieves value of dimension MyDimValue drawing
dimension.

oValue = MyDimValue.Value
Return type:

float

property value_framed_element: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property ValueFramedElement() As CatDimFramedElement

Get dimension framed element.
Example:
This example gets dimension framed element of MyValue
path.

ValueFramedElement = MyValue.ValueFramedElement
Returns:

enum cat_dim_frame_element

Return type:

int

property value_framed_group: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property ValueFramedGroup() As CatDimFramedGroup

Returns or sets dimension framed group.

Example:
This example retrieves dimension framed group MyDimValue drawing
dimension.

oValueFramedGroup = MyDimValue.FakeDimType
Returns:

enum cat_dim_framed_group

Return type:

int