OCC.Core.Units module¶
Units module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_units.html
-
class
SwigPyIterator
(*args, **kwargs)¶ Bases:
object
-
advance
()¶
-
copy
()¶
-
decr
()¶
-
distance
()¶
-
equal
()¶
-
incr
()¶
-
next
()¶
-
previous
()¶
-
property
thisown
¶ The membership flag
-
value
()¶
-
-
class
Units_Explorer
(*args)¶ Bases:
object
- Empty contructor of the class.
- rtype
None* Creates a new instance of the class, initialized with the UnitsSystem <aunitssystem>.
- param aunitssystem
- type aunitssystem
Units_UnitsSystem
- rtype
None* Creates a new instance of the class, initialized with the UnitsDictionary <aunitsdictionary>.
- param aunitsdictionary
- type aunitsdictionary
Units_UnitsDictionary
- rtype
None* Creates a new instance of the class, initialized with the UnitsSystem <aunitssystem> and positioned at the quantity <aquantity>.
- param aunitssystem
- type aunitssystem
Units_UnitsSystem
- param aquantity
- type aquantity
char *
- rtype
None* Creates a new instance of the class, initialized with the UnitsDictionary <aunitsdictionary> and positioned at the quantity <aquantity>.
- param aunitsdictionary
- type aunitsdictionary
Units_UnitsDictionary
- param aquantity
- type aquantity
char *
- rtype
None
-
Init
()¶ - Initializes the instance of the class with the UnitsSystem <aunitssystem>.
- param aunitssystem
- type aunitssystem
Units_UnitsSystem
- rtype
None* Initializes the instance of the class with the UnitsDictionary <aunitsdictionary>.
- param aunitsdictionary
- type aunitsdictionary
Units_UnitsDictionary
- rtype
None* Initializes the instance of the class with the UnitsSystem <aunitssystem> and positioned at the quantity <aquantity>.
- param aunitssystem
- type aunitssystem
Units_UnitsSystem
- param aquantity
- type aquantity
char *
- rtype
None* Initializes the instance of the class with the UnitsDictionary <aunitsdictionary> and positioned at the quantity <aquantity>.
- param aunitsdictionary
- type aunitsdictionary
Units_UnitsDictionary
- param aquantity
- type aquantity
char *
- rtype
None
-
IsActive
()¶ - If the units system to explore is a user system, returns True if the current unit is active, False otherwise. //! If the units system to explore is the units dictionary, returns True if the current unit is the S.I. unit.
- rtype
bool
-
MoreQuantity
()¶ - Returns True if there is another Quantity to explore, False otherwise.
- rtype
bool
-
MoreUnit
()¶ - Returns True if there is another Unit to explore, False otherwise.
- rtype
bool
-
NextQuantity
()¶ - Sets the next Quantity current.
- rtype
None
-
NextUnit
()¶ - Sets the next Unit current.
- rtype
None
-
Quantity
()¶ - Returns the name of the current Quantity.
- rtype
TCollection_AsciiString
-
Unit
()¶ - Returns the name of the current unit.
- rtype
TCollection_AsciiString
-
property
thisown
¶ The membership flag
-
class
Units_Lexicon
(*args)¶ Bases:
OCC.Core.Standard.Standard_Transient
- Creates an empty instance of Lexicon.
- rtype
None
-
AddToken
()¶ - Adds to the lexicon a new token with <aword>, <amean>, <avalue> as arguments. If there is already a token with the field <theword> equal to <aword>, the existing token is updated.
- param aword
- type aword
char *
- param amean
- type amean
char *
- param avalue
- type avalue
float
- rtype
None
-
Creates
()¶ - Reads the file <afilename> to create a sequence of tokens stored in <thesequenceoftokens>.
- rtype
None
-
static
DownCast
(t)¶
-
Dump
()¶ - Useful for debugging.
- rtype
None
-
Sequence
()¶ - Returns the first item of the sequence of tokens.
- rtype
opencascade::handle<Units_TokensSequence>
-
property
thisown
¶ The membership flag
-
class
Units_MathSentence
(*args)¶ Bases:
OCC.Core.Units.Units_Sentence
- Creates and returns a MathSentence object. The string <astring> describes an algebraic formula in natural language.
- param astring
- type astring
char *
- rtype
None
-
property
thisown
¶ The membership flag
-
class
Units_Measurement
(*args)¶ Bases:
object
- It is the empty constructor of the class.
- rtype
None* Returns an instance of this class. <avalue> defines the measurement, and <atoken> the token which defines the unit used.
- param avalue
- type avalue
float
- param atoken
- type atoken
Units_Token
- rtype
None* Returns an instance of this class. <avalue> defines the measurement, and <aunit> the unit used, described in natural language.
- param avalue
- type avalue
float
- param aunit
- type aunit
char *
- rtype
None
-
Add
()¶ - Returns (if it is possible) a measurement which is the addition of <self> and <ameasurement>. The chosen returned unit is the unit of <self>.
- param ameasurement
- type ameasurement
Units_Measurement
- rtype
Units_Measurement
-
Convert
()¶ - Converts (if possible) the measurement object into another unit. <aunit> must have the same dimensionality as the unit contained in the token <thetoken>.
- param aunit
- type aunit
char *
- rtype
None
-
Divide
()¶ - Returns a measurement which is the division of <self> by <ameasurement>.
- param ameasurement
- type ameasurement
Units_Measurement
- rtype
Units_Measurement* Returns a measurement which is the division of <self> by the constant <avalue>.
- param avalue
- type avalue
float
- rtype
Units_Measurement
-
Dump
()¶ - Useful for debugging.
- rtype
None
-
Fractional
()¶ - Returns a Measurement object with the fractional value of the measurement contained in <self>.
- rtype
Units_Measurement
-
Integer
()¶ - Returns a Measurement object with the integer value of the measurement contained in <self>.
- rtype
Units_Measurement
-
Measurement
()¶ - Returns the value of the measurement.
- rtype
float
-
Multiply
()¶ - Returns a measurement which is the multiplication of <self> and <ameasurement>.
- param ameasurement
- type ameasurement
Units_Measurement
- rtype
Units_Measurement* Returns a measurement which is the multiplication of <self> with the value <avalue>.
- param avalue
- type avalue
float
- rtype
Units_Measurement
-
Power
()¶ - Returns a measurement which is <self> powered <anexponent>.
- param anexponent
- type anexponent
float
- rtype
Units_Measurement
-
Subtract
()¶ - Returns (if it is possible) a measurement which is the subtraction of <self> and <ameasurement>. The chosen returned unit is the unit of <self>.
- param ameasurement
- type ameasurement
Units_Measurement
- rtype
Units_Measurement
-
Token
()¶ - Returns the token contained in <self>.
- rtype
opencascade::handle<Units_Token>
-
property
thisown
¶ The membership flag
-
class
Units_QtsSequence
(*args)¶ Bases:
object
-
Append
()¶
-
Assign
()¶
-
ChangeFirst
()¶
-
ChangeLast
()¶
-
ChangeValue
()¶
-
Clear
()¶
-
Exchange
()¶
-
First
()¶
-
InsertAfter
()¶
-
InsertBefore
()¶
-
IsEmpty
()¶
-
Last
()¶
-
Length
()¶
-
Lower
()¶
-
Prepend
()¶
-
Remove
()¶
-
Reverse
()¶
-
Set
()¶
-
SetValue
()¶
-
Size
()¶
-
Split
()¶
-
Upper
()¶
-
Value
()¶
-
begin
()¶
-
cbegin
()¶
-
cend
()¶
-
static
delNode
()¶
-
end
()¶
-
property
thisown
¶ The membership flag
-
-
class
Units_QuantitiesSequence
(*args)¶ Bases:
OCC.Core.Units.Units_QtsSequence
,OCC.Core.Standard.Standard_Transient
Empty constructor
- Return type
None* Copy constructor – does nothing
- Parameters
& (Standard_Transient) –
- Return type
-
Append
()¶
-
ChangeSequence
()¶
-
static
DownCast
(t)¶
-
Sequence
()¶
-
property
thisown
¶ The membership flag
-
class
Units_Sentence
(*args)¶ Bases:
object
- Creates and returns a Sentence, by analyzing the string <astring> with the lexicon <alexicon>.
- param alexicon
- type alexicon
Units_Lexicon
- param astring
- type astring
char *
- rtype
None
-
Dump
()¶ - Useful for debugging.
- rtype
None
-
Evaluate
()¶ - Computes and returns in a token the result of the expression.
- rtype
opencascade::handle<Units_Token>
-
IsDone
()¶ - Return True if number of created tokens > 0 (i.e creation of sentence is succesfull)
- rtype
bool
-
Sequence
()¶ - Returns <thesequenceoftokens>.
- rtype
opencascade::handle<Units_TokensSequence>* Sets the field <thesequenceoftokens> to <asequenceoftokens>.
- param asequenceoftokens
- type asequenceoftokens
Units_TokensSequence
- rtype
None
-
SetConstants
()¶ - For each constant encountered, sets the value.
- rtype
None
-
property
thisown
¶ The membership flag
-
class
Units_ShiftedToken
(*args)¶ Bases:
OCC.Core.Units.Units_Token
- Creates and returns a shifted token. <aword> is a string containing the available word, <amean> gives the signification of the token, <avalue> is the numeric value of the dimension, <amove> is the gap, and <adimensions> is the dimension of the given word <aword>.
- param aword
- type aword
char *
- param amean
- type amean
char *
- param avalue
- type avalue
float
- param amove
- type amove
float
- param adimensions
- type adimensions
Units_Dimensions
- rtype
None
-
static
DownCast
(t)¶
-
Move
()¶ - Returns the gap <themove>
- rtype
float
-
property
thisown
¶ The membership flag
-
class
Units_ShiftedUnit
(*args)¶ Bases:
OCC.Core.Units.Units_Unit
- Creates and returns a shifted unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit, <avalue> is the value in relation to the International System of Units, and <amove> is the gap in relation to another unit. //! For example Celcius dregee of temperature is an instance of ShiftedUnit with <avalue> equal to 1. and <amove> equal to 273.15.
- param aname
- type aname
char *
- param asymbol
- type asymbol
char *
- param avalue
- type avalue
float
- param amove
- type amove
float
- param aquantity
- type aquantity
Units_Quantity
- rtype
None* Creates and returns a unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit.
- param aname
- type aname
char *
- param asymbol
- type asymbol
char *
- rtype
None* Creates and returns a unit. <aname> is the name of the unit.
- param aname
- type aname
char *
- rtype
None
-
static
DownCast
(t)¶
-
Move
()¶ - Sets the field <themove> to <amove>
- param amove
- type amove
float
- rtype
None* Returns the shifted value <themove>.
- rtype
float
-
property
thisown
¶ The membership flag
-
class
Units_TksSequence
(*args)¶ Bases:
object
-
Append
()¶
-
Assign
()¶
-
ChangeFirst
()¶
-
ChangeLast
()¶
-
ChangeValue
()¶
-
Clear
()¶
-
Exchange
()¶
-
First
()¶
-
InsertAfter
()¶
-
InsertBefore
()¶
-
IsEmpty
()¶
-
Last
()¶
-
Length
()¶
-
Lower
()¶
-
Prepend
()¶
-
Remove
()¶
-
Reverse
()¶
-
Set
()¶
-
SetValue
()¶
-
Size
()¶
-
Split
()¶
-
Upper
()¶
-
Value
()¶
-
begin
()¶
-
cbegin
()¶
-
cend
()¶
-
static
delNode
()¶
-
end
()¶
-
property
thisown
¶ The membership flag
-
-
class
Units_Token
(*args)¶ Bases:
OCC.Core.Standard.Standard_Transient
- Creates and returns a empty token.
- rtype
None* Creates and returns a token. <aword> is a string containing the available word.
- param aword
- type aword
char *
- rtype
None* Creates and returns a token. <atoken> is copied in the returned token.
- param atoken
- type atoken
Units_Token
- rtype
None* Creates and returns a token. <aword> is a string containing the available word and <amean> gives the signification of the token.
- param aword
- type aword
char *
- param amean
- type amean
char *
- rtype
None* Creates and returns a token. <aword> is a string containing the available word, <amean> gives the signification of the token and <avalue> is the numeric value of the dimension.
- param aword
- type aword
char *
- param amean
- type amean
char *
- param avalue
- type avalue
float
- rtype
None* Creates and returns a token. <aword> is a string containing the available word, <amean> gives the signification of the token, <avalue> is the numeric value of the dimension, and <adimensions> is the dimension of the given word <aword>.
- param aword
- type aword
char *
- param amean
- type amean
char *
- param avalue
- type avalue
float
- param adimension
- type adimension
Units_Dimensions
- rtype
None
-
Add
()¶ - Parameters
aninteger –
- type aninteger
int
- rtype
opencascade::handle<Units_Token>* Returns a token which is the addition of <self> and another token <atoken>. The addition is possible if and only if the dimensions are the same.
- param atoken
- type atoken
Units_Token
- rtype
opencascade::handle<Units_Token>
-
Creates
()¶ - Creates and returns a token, which is a ShiftedToken.
- rtype
opencascade::handle<Units_Token>
-
Dimensions
()¶ - Returns the dimensions of the token <thedimensions>.
- rtype
opencascade::handle<Units_Dimensions>* Sets the field <thedimensions> to <adimensions>.
- param adimensions
- type adimensions
Units_Dimensions
- rtype
None
-
Divide
()¶ - Returns a token which is the division of <self> by another token <atoken>.
- param atoken
- type atoken
Units_Token
- rtype
opencascade::handle<Units_Token>
-
Divided
()¶ - This virtual method is called by the Measurement methods, to compute the measurement during a conversion.
- param avalue
- type avalue
float
- rtype
float
-
static
DownCast
(t)¶
-
Dump
()¶ - Useful for debugging
- param ashift
- type ashift
int
- param alevel
- type alevel
int
- rtype
void
-
IsEqual
()¶ - Returns true if the field <theword> and the string <astring> are the same, false otherwise.
- param astring
- type astring
char *
- rtype
bool* Returns true if the field <theword> and the string <theword> contained in the token <atoken> are the same, false otherwise.
- param atoken
- type atoken
Units_Token
- rtype
bool
-
IsGreater
()¶ - Returns false if the field <theword> is strictly contained at the beginning of the string <astring>, true otherwise.
- param astring
- type astring
char *
- rtype
bool* Returns false if the field <theword> is strictly contained at the beginning of the string <astring>, true otherwise.
- param atoken
- type atoken
Units_Token
- rtype
bool
-
IsGreaterOrEqual
()¶ - Returns true if the string <astring> is strictly contained at the beginning of the field <theword> false otherwise.
- param atoken
- type atoken
Units_Token
- rtype
bool
-
IsLessOrEqual
()¶ - Returns true if the field <theword> is strictly contained at the beginning of the string <astring>, false otherwise.
- param astring
- type astring
char *
- rtype
bool
-
IsNotEqual
()¶ - Returns false if the field <theword> and the string <astring> are the same, true otherwise.
- param astring
- type astring
char *
- rtype
bool* Returns false if the field <theword> and the string <theword> contained in the token <atoken> are the same, true otherwise.
- param atoken
- type atoken
Units_Token
- rtype
bool
-
Length
()¶ - Returns the length of the word.
- rtype
int
-
Mean
()¶ - Returns the significance of the word <theword>, which is in the field <themean>.
- rtype
TCollection_AsciiString* Sets the field <themean> to <amean>.
- param amean
- type amean
char *
- rtype
None
-
Multiplied
()¶ - This virtual method is called by the Measurement methods, to compute the measurement during a conversion.
- param avalue
- type avalue
float
- rtype
float
-
Multiply
()¶ - Returns a token which is the product of <self> and another token <atoken>.
- param atoken
- type atoken
Units_Token
- rtype
opencascade::handle<Units_Token>
-
Power
()¶ - Returns a token which is <self> to the power of another token <atoken>. The computation is possible only if <atoken> is a dimensionless constant.
- param atoken
- type atoken
Units_Token
- rtype
opencascade::handle<Units_Token>* Returns a token which is <self> to the power of <anexponent>.
- param anexponent
- type anexponent
float
- rtype
opencascade::handle<Units_Token>
-
Subtract
()¶ - Returns a token which is the subtraction of <self> and another token <atoken>. The subtraction is possible if and only if the dimensions are the same.
- param atoken
- type atoken
Units_Token
- rtype
opencascade::handle<Units_Token>
-
Update
()¶ - Updates the token <self> with the additional signification <amean> by concatenation of the two strings <themean> and <amean>. If the two significations are the same , an information message is written in the output device.
- param amean
- type amean
char *
- rtype
None
-
Value
()¶ - Returns the value stored in the field <thevalue>.
- rtype
float* Sets the field <thevalue> to <avalue>.
- param avalue
- type avalue
float
- rtype
None
-
Word
()¶ - Returns the string <theword>
- rtype
TCollection_AsciiString* Sets the field <theword> to <aword>.
- param aword
- type aword
char *
- rtype
None
-
property
thisown
¶ The membership flag
-
class
Units_TokensSequence
(*args)¶ Bases:
OCC.Core.Units.Units_TksSequence
,OCC.Core.Standard.Standard_Transient
Empty constructor
- Return type
None* Copy constructor – does nothing
- Parameters
& (Standard_Transient) –
- Return type
-
Append
()¶
-
ChangeSequence
()¶
-
static
DownCast
(t)¶
-
Sequence
()¶
-
property
thisown
¶ The membership flag
-
class
Units_Unit
(*args)¶ Bases:
OCC.Core.Standard.Standard_Transient
- Creates and returns a unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit, and <avalue> is the value in relation to the International System of Units.
- param aname
- type aname
char *
- param asymbol
- type asymbol
char *
- param avalue
- type avalue
float
- param aquantity
- type aquantity
Units_Quantity
- rtype
None* Creates and returns a unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit.
- param aname
- type aname
char *
- param asymbol
- type asymbol
char *
- rtype
None* Creates and returns a unit. <aname> is the name of the unit.
- param aname
- type aname
char *
- rtype
None
-
static
DownCast
(t)¶
-
Dump
()¶ - Useful for debugging
- param ashift
- type ashift
int
- param alevel
- type alevel
int
- rtype
void
-
IsEqual
()¶ - Compares all the symbols linked within <self> with the name of <atoken>, and returns True if there is one symbol equal to the name, False otherwise.
- param astring
- type astring
char *
- rtype
bool
-
Name
()¶ - Returns the name of the unit <thename>
- rtype
TCollection_AsciiString
-
Quantity
()¶ - Returns <thequantity> contained in <self>.
- rtype
opencascade::handle<Units_Quantity>* Sets the physical Quantity <aquantity> to <self>.
- param aquantity
- type aquantity
Units_Quantity
- rtype
None
-
Symbol
()¶ - Adds a new symbol <asymbol> attached to <self>.
- param asymbol
- type asymbol
char *
- rtype
None
-
SymbolsSequence
()¶ - Returns the sequence of symbols <thesymbolssequence>
- rtype
opencascade::handle<TColStd_HSequenceOfHAsciiString>
-
Token
()¶ - Starting with <self>, returns a new Token object.
- rtype
opencascade::handle<Units_Token>
-
Value
()¶ - Returns the value in relation with the International System of Units.
- rtype
float* Sets the value <avalue> to <self>.
- param avalue
- type avalue
float
- rtype
None
-
property
thisown
¶ The membership flag
-
class
Units_UnitSentence
(*args)¶ Bases:
OCC.Core.Units.Units_Sentence
- Creates and returns a UnitSentence. The string <astring> describes in natural language the unit or the composed unit to be analysed.
- param astring
- type astring
char *
- rtype
None* Creates and returns a UnitSentence. The string <astring> describes in natural language the unit to be analysed. The sequence of physical quantities <asequenceofquantities> describes the available dictionary of units you want to use.
- param astring
- type astring
char *
- param aquantitiessequence
- type aquantitiessequence
Units_QuantitiesSequence
- rtype
None
-
Analyse
()¶ - Analyzes the sequence of tokens created by the constructor to find the true significance of each token.
- rtype
None
-
SetUnits
()¶ - For each token which represents a unit, finds in the sequence of physical quantities all the characteristics of the unit found.
- param aquantitiessequence
- type aquantitiessequence
Units_QuantitiesSequence
- rtype
None
-
property
thisown
¶ The membership flag
-
class
Units_UnitsDictionary
(*args)¶ Bases:
OCC.Core.Standard.Standard_Transient
- Returns an empty instance of UnitsDictionary.
- rtype
None
-
ActiveUnit
()¶ - Returns for <aquantity> the active unit.
- param aquantity
- type aquantity
char *
- rtype
TCollection_AsciiString
-
Creates
()¶ - Returns a UnitsDictionary object which contains the sequence of all the units you want to consider, physical quantity by physical quantity.
- rtype
None
-
static
DownCast
(t)¶
-
Dump
()¶ - Dumps only the sequence of quantities without the units if <alevel> is equal to zero, and for each quantity all the units stored if <alevel> is equal to one.
- param alevel
- type alevel
int
- rtype
None* Dumps for a designated physical dimensions <adimensions> all the previously stored units.
- param adimensions
- type adimensions
Units_Dimensions
- rtype
None
-
Sequence
()¶ - Returns the head of the sequence of physical quantities.
- rtype
opencascade::handle<Units_QuantitiesSequence>
-
property
thisown
¶ The membership flag
-
class
Units_UnitsLexicon
(*args)¶ Bases:
OCC.Core.Units.Units_Lexicon
- Returns an empty instance of UnitsLexicon
- rtype
None
-
Creates
()¶ - Reads the files <afilename1> and <afilename2> to create a sequence of tokens stored in <thesequenceoftokens>.
- param amode
default value is Standard_True
- type amode
bool
- rtype
None
-
static
DownCast
(t)¶
-
Dump
()¶ - Useful for debugging.
- rtype
None
-
property
thisown
¶ The membership flag
-
class
Units_UnitsSequence
(*args)¶ Bases:
OCC.Core.Units.Units_UtsSequence
,OCC.Core.Standard.Standard_Transient
Empty constructor
- Return type
None* Copy constructor – does nothing
- Parameters
& (Standard_Transient) –
- Return type
-
Append
()¶
-
ChangeSequence
()¶
-
static
DownCast
(t)¶
-
Sequence
()¶
-
property
thisown
¶ The membership flag
-
class
Units_UnitsSystem
(*args)¶ Bases:
OCC.Core.Standard.Standard_Transient
- Returns an instance of UnitsSystem initialized to the S.I. units system.
- rtype
None* Returns an instance of UnitsSystem initialized to the S.I. units system upgraded by the base system units decription file. Attempts to find the four following files: $CSF_`aName`Defaults/.aName $CSF_`aName`SiteDefaults/.aName $CSF_`aName`GroupDefaults/.aName $CSF_`aName`UserDefaults/.aName See : Resource_Manager for the description of this file.
- param aName
- type aName
char *
- param Verbose
default value is Standard_False
- type Verbose
bool
- rtype
None
-
Activate
()¶ - Specifies for <aquantity> the unit <aunit> used.
- param aquantity
- type aquantity
char *
- param aunit
- type aunit
char *
- rtype
None
-
Activates
()¶ - Activates the first unit of all defined system quantities
- rtype
None
-
ActiveUnit
()¶ - Returns for <aquantity> the active unit.
- param aquantity
- type aquantity
char *
- rtype
TCollection_AsciiString
-
ActiveUnitsSequence
()¶ - Returns a sequence of integer in correspondance with the sequence of quantities, which indicates, for each redefined quantity, the index into the sequence of units, of the active unit.
- rtype
opencascade::handle<TColStd_HSequenceOfInteger>
-
ConvertSIValueToUserSystem
()¶ - Converts the real value <avalue> from the S.I. system of units to the user system of units. <aquantity> is the physical dimensions of the measurement.
- param aquantity
- type aquantity
char *
- param avalue
- type avalue
float
- rtype
float
-
ConvertUserSystemValueToSI
()¶ - Converts the real value <avalue> from the user system of units to the S.I. system of units. <aquantity> is the physical dimensions of the measurement.
- param aquantity
- type aquantity
char *
- param avalue
- type avalue
float
- rtype
float
-
ConvertValueToUserSystem
()¶ - Converts a real value <avalue> from the unit <aunit> belonging to the physical dimensions <aquantity> to the corresponding unit of the user system.
- param aquantity
- type aquantity
char *
- param avalue
- type avalue
float
- param aunit
- type aunit
char *
- rtype
float
-
static
DownCast
(t)¶
-
IsEmpty
()¶ - Returns True if no units has been defined in the system.
- rtype
bool
-
QuantitiesSequence
()¶ - Returns the sequence of refined quantities.
- rtype
opencascade::handle<Units_QuantitiesSequence>
-
Remove
()¶ - Removes for <aquantity> the unit <aunit> used.
- param aquantity
- type aquantity
char *
- param aunit
- type aunit
char *
- rtype
None
-
Specify
()¶ - Specifies for <aquantity> the unit <aunit> used.
- param aquantity
- type aquantity
char *
- param aunit
- type aunit
char *
- rtype
None
-
property
thisown
¶ The membership flag
-
class
Units_UtsSequence
(*args)¶ Bases:
object
-
Append
()¶
-
Assign
()¶
-
ChangeFirst
()¶
-
ChangeLast
()¶
-
ChangeValue
()¶
-
Clear
()¶
-
Exchange
()¶
-
First
()¶
-
InsertAfter
()¶
-
InsertBefore
()¶
-
IsEmpty
()¶
-
Last
()¶
-
Length
()¶
-
Lower
()¶
-
Prepend
()¶
-
Remove
()¶
-
Reverse
()¶
-
Set
()¶
-
SetValue
()¶
-
Size
()¶
-
Split
()¶
-
Upper
()¶
-
Value
()¶
-
begin
()¶
-
cbegin
()¶
-
cend
()¶
-
static
delNode
()¶
-
end
()¶
-
property
thisown
¶ The membership flag
-
-
class
units
¶ Bases:
object
-
static
Convert
()¶ - Converts <avalue> expressed in <afirstunit> into the <asecondunit>.
- param avalue
- type avalue
float
- param afirstunit
- type afirstunit
char *
- param asecondunit
- type asecondunit
char *
- rtype
float
-
static
DictionaryOfUnits
()¶ - Returns a unique instance of the dictionary of units. If <amode> is True, then it forces the recomputation of the dictionary of units.
- param amode
default value is Standard_False
- type amode
bool
- rtype
opencascade::handle<Units_UnitsDictionary>
-
static
Dimensions
()¶ - return the dimension associated to the Type
- param aType
- type aType
char *
- rtype
opencascade::handle<Units_Dimensions>
-
static
FirstQuantity
()¶ - Returns the first quantity string founded from the unit <aUnit>.
- param aunit
- type aunit
char *
- rtype
char *
-
static
FromSI
()¶ - Parameters
aData –
- type aData
float
- param aUnit
- type aUnit
char *
- rtype
float:param aData:
- type aData
float
- param aUnit
- type aUnit
char *
- param aDim
- type aDim
Units_Dimensions
- rtype
float
-
static
LexiconFile
()¶ - Defines the location of the file containing the lexicon useful in manipulating composite units.
- param afile
- type afile
char *
- rtype
void
-
static
LexiconFormula
()¶ - Return a unique instance of LexiconFormula.
- rtype
opencascade::handle<Units_Lexicon>
-
static
LexiconUnits
()¶ - Returns a unique instance of the Units_Lexicon. If <amode> is True, it forces the recomputation of the dictionary of units, and by consequence the completion of the Units_Lexicon.
- param amode
default value is Standard_True
- type amode
bool
- rtype
opencascade::handle<Units_Lexicon>
-
static
NullDimensions
()¶ - Returns always the same instance of Dimensions.
- rtype
opencascade::handle<Units_Dimensions>
-
static
Quantity
()¶ - Returns a unique quantity instance corresponding to <aquantity>.
- param aquantity
- type aquantity
char *
- rtype
opencascade::handle<Units_Quantity>
-
static
ToSI
()¶ - Parameters
aData –
- type aData
float
- param aUnit
- type aUnit
char *
- rtype
float:param aData:
- type aData
float
- param aUnit
- type aUnit
char *
- param aDim
- type aDim
Units_Dimensions
- rtype
float
-
static
UnitsFile
()¶ - Defines the location of the file containing all the information useful in creating the dictionary of all the units known to the system.
- param afile
- type afile
char *
- rtype
void
-
property
thisown
¶ The membership flag
-
static