Units Class

Entisoft Tools 2.0 Object Library
Version 2.1 Build 208
<-- Previous || Index || Main || Topics || Next -->

Declarations Section, InstallationInstructionsHelp Sub, SystemRequirementsHelp Sub, DistributionFilesHelp Sub, OrderingInformationHelp Sub, EntisoftUnitsOrderFormSample Sub, FunctionCallInterfaceHelp Sub, ProgramOverviewHelp Sub, TipsWindowHelp Sub, DefinitionsWindowHelp Sub, ProgramWindowHelp Sub, RecallWindowHelp Sub, CalculatorWindowHelp Sub, SearchDetailsHelp Sub, CurrencyConversionsHelp Sub, ResistorColorCodesHelp Sub, TemperatureConversionsHelp Sub, SupplementalDataFileHelp Sub, SISystemBaseUnitsHelp Sub, AddPrefix Function, AddPrefixSub Sub, AddReplacement Function, AddReplacementSub Sub, AddUnit Function, AddUnitSub Sub, CGIToHTML Function, ClearAll Sub, ClearPrefixes Sub, ClearReplacements Sub, ClearUnits Sub, ConvertMeasure Function, ConvertSimple Function, ConvertSpecial Function, ConvertSpecialSample Sub, ConvertString Function, ConvertTest Function, ConvertTextFilesTest Function, ConvertToBaseUnits Property, ConvertToExpr Function, DefaultHTMLTemplate Function, DescribeUnit Function, Draw1String Function, Draw2Strings Function, Draw3Strings Function, DrawSimple Function, EnumerateUnits Function, FindBaseCategories Function, FindCategory Function, FormatNumeric Function, GeneralTip Function, GetPrefix Function, GetPrefixCount Function, GetReplacement Function, GetReplacementCount Function, GetUnit Function, GetUnitCount Function, HTMLTemplate Property, HTMLUnitsList Sub, InitializeDone Property, InitializeMandatory Sub, InitializeMaybe Sub, LoadFiles Function, LoadMultipleLines Function, LoadOneFile Function, LoadOneLine Function, NotFound Function, ParseExpression Sub, PrefixTest Function, PrepHTMLTemplate Function, RelatedUnits Function, SampleConversions Function, TypeBase Property, TypeCategory Property, TypeDerived Property, TypeOther Property, TypeSynonym Property, UnitCategoryTest Function, UnitCategoryUnknownTest Function, UnitDuplicateTest Function, UnitTest Function, SetupA Sub, SetupC Sub, SetupD Sub, SetupE Sub, SetupF Sub, SetupH Sub, SetupI Sub, SetupK Sub, SetupL Sub, SetupM Sub, SetupN Sub, SetupP Sub, SetupR Sub, SetupS Sub, SetupT Sub, SetupU Sub, SetupV Sub, SetupW Sub, SetupUnits Sub

Declarations Section
Installation Instructions Help Sub
System Requirements Help Sub
Distribution Files Help Sub
Ordering Information Help Sub
Entisoft Units Order Form Sample Sub
Function Call Interface Help Sub
Program Overview Help Sub
Tips Window Help Sub
Definitions Window Help Sub
Program Window Help Sub
Recall Window Help Sub
Calculator Window Help Sub
Search Details Help Sub
Currency Conversions Help Sub
Resistor Color Codes Help Sub
Temperature Conversions Help Sub
Supplemental Data File Help Sub
SI System Base Units Help Sub
Add Prefix Function
"Add Prefix Definition" Add a prefix such as "kilo" into the units conversion program table, or replace an existing definition. Prefixes can be used to modify any of the known units within measurement expressions. Function returns an empty string upon success. Function returns the error message as a string when errors occur.
Add Prefix Sub Sub
"Add Prefix Definition Subroutine" Add a prefix definition, displaying any error messages in the debug window. Used to avoid having to handle return values while installing the built-in prefix definitions.
Add Replacement Function
"Add Replacement Definition" Add a global text replacement definition. Defines text which will be replaced by something else wherever it occurs within measurement expressions. Function returns an empty string upon success. Function returns the error message as a string when errors occur.
Add Replacement Sub Sub
"Add Replacement Definition Subroutine" Add a global text replacement definition, displaying any error messages in the debug window. Used to avoid having to handle return values while installing the built-in text replacements.
Add Unit Function
"Add Unit Definition" Registers a new measurement definition. Add a unit such as "foot = 12 inch" into the units conversion program table, or replace an existing definition. Also used to add measurement categories and measurement synonyms. Function returns an empty string upon success. Function returns the error message as a string when errors occur.
Add Unit Sub Sub
"Add Unit Definition Subroutine" Add a unit/measurement definition, displaying any error messages in the debug window. Used to avoid having to handle return values while installing the built-in unit definitions.
CGI To HTML Function
Clear All Sub
"Clear All Definition" Initialize or reset the program by clearing the definitions within the conversion-related tables. This clears the unit, prefix, and text replacement definitions.
Clear Prefixes Sub
"Clear Prefix Definition" Clear out the conversion prefix related tables.
Clear Replacements Sub
"Clear Replacement Definition" Clear out the global replacements.
Clear Units Sub
"Clear Unit Definition" Clear out the conversion unit related tables.
Convert Measure Function
"Convert Measurement" Convert a measurement to some other type of measurement. For example, convert 1/5 ft/s (feet per second) to mph (miles per hour).
Convert Simple Function
"Simple Convert Measurement" Simple numeric conversion between certain important measurements. This function is mainly for people who want to use the ConvertSpecial high-level conversion function with a simple lower-level conversion function for support. As is, this function converts between inches, feet, and meters.
Convert Special Function
"Special Convert Measurement" Perform measurement conversions to and/or from combinations of major and minor units. Also supports the input and output of fractional numbers and the rounding of results.
Convert Special Sample Sub
Perform some sample conversions using the ConvertSpecial function.
Convert String Function
"Convert Measurement String" Perform the measurement conversion described by the string argument. Parse a string like "5 ft to in" and pass it to the Convert function. Accepts strings of the form "5 ft to in", "ft^2 to in^2", "5 in", and "in", etc.
Convert Test Function
Perform some important consistency checks of the current loaded unit, prefix, and global text replacement definitions.
Convert Text Files Test Function
Perform some important consistency checks of the unit, prefix, and global text replacement definitions stored within text files.
Convert To Base Units Property
True if the expressions resulting from mismatched conversions should be returned. Set to True if the expressions resulting from mismatched conversions should be returned.
Convert To Expr Function
Default HTML Template Function
Describe Unit Function
Describe a unit definition in the form of an Ensligh sentence.
Draw 1 String Function
Converts a string expression such as "45 m^2/kg*m*s^2" to something like: 45 m^2 -------- kg m s^2
Draw 2 Strings Function
Take two measurement expressions like "ft/s" and ".3048 m/s" and return a string of the form: foot .3048 meter ------ = ----------- second second (velocity)
Draw 3 Strings Function
Take three measurement expressions like "ft/s", "in", and "12/second" and return a string of the form: foot 12 ------ TO inch = ------ second second (velocity) (length) (frequency)
Draw Simple Function
Converts a string expression such as "45 m^2/kg*m*s^2" to something like "45 m^2 / kg m s^2"
Enumerate Units Function
"Enumerate Units" Enumerate the units and prefixes which are used within a measurement expression. For example, "ft*lb/s^2" would be translated to "foot*avoirdupois pound/second^2" Synonym-type units are replaced by their definitions, and unit codes are replaced by the name of the unit.
Find Base Categories Function
Convert a measurement expression into base units (meters, seconds, etc.) then replace those base units with the names of the fundamental physical measurements they represent (length, time, etc.).
Find Category Function
Determines the primary physical measurement represented by an expression. Return the name of the most common physical measurement described by the measurement expression. For example, the expression "meters/seconds" (and any other expression which involves a combination of length over time) is most commonly used to represent measurements of velocity.
Format Numeric Function
Format a numeric value so it looks good when displayed with a whole bunch of other numbers and words. Many numbers are not displayed using their full precision.
General Tip Function
Alternate between displaying tips from the tip list and displaying unit definitions in descriptive format.
Get Prefix Function
"Get Prefix Definition"
Get Prefix Count Function
Number of prefix definitions in the table.
Get Replacement Function
"Get Replacement Definition"
Get Replacement Count Function
"Get Replacement Count" Number of global text replacements in the table.
Get Unit Function
"Get Unit Definition"
Get Unit Count Function
Number of unit (measurement) definitions in the table.
HTML Template Property
Get the current Entisoft Units CGI HTML Template. Set the current Entisoft Units CGI HTML Template.
HTML Units List Sub
Go through the currently-defined units, prefixes, and global text replacements generating an index which will be displayed to the user in a list box. This function stores the data in a different list box depending upon whether or not Visual Basic is to sort the entries.
Initialize Done Property
True if the automatic initialization of built-in unit, prefix, and text replacement definitions have been loaded. Can also be set to True by user programs to signify that the built-in definitions should not be loaded.
Initialize Mandatory Sub
Guaranteed install or update of the built-in unit, prefix, and global text replacement definitions.
Initialize Maybe Sub
Install the built-in unit, prefix, and global text replacement definitions if it has not already been done.
Load Files Function
Load the unit, prefix, and/or global text replacement definitions from one or more files. File Names argument can accept wildcards and it can accept multiple file names separated by spaces. Returns an empty string in case of success. Returns the error message when errors occur. More specifically, errors are returned when they occur in non-interactive mode, or after they have occurred in interactive mode and the user has chosen to discontinue the process.
Load Multiple Lines Function
Loads the unit definitions, prefix definitions, global text definitions, and data files specified by the argument.
Load One File Function
Load the unit, prefix, and/or global text replacement definitions from an individual file. Returns an empty string in case of success. Returns the error message when errors occur.
Load One Line Function
Interpret (parse and execute) a string as a command to load something like a data file or a unit definition. Commands can load the built-in definitions, multiple data files, unit definitions, prefix definitions, or text replacement definitions.
Not Found Function
Returns a string describing units which partially match or which sound like the argument. Usually called by functions which have looked for the definitions of units but failed to find one. By partially match, I mean that two or more of the characters at the beginning of the codes must be the same.
Parse Expression Sub
Separate the numeric and symbolic parts of a measurement expression. "12 m/s" would be separated into 12 & "m/s". "foot per minute" would be separated into 1 & "foot per second".
Prefix Test Function
Find prefixes and combinations of prefixes and units which cannot be parsed by the conversion program.
Prep HTML Template Function
Related Units Function
Display measurements related to the current Calculator From Measurement expression in the Tip box.
Sample Conversions Function
Perform sample conversions to other units which are related to the expression in the Calculator's From Measurement box. Conversion calculations are performed in the background so that the CPU is not blocked and the user can continue to use the program.
Type Base Property
Fundamental unit of measurement.
Type Category Property
Unit represents of category of physical measurements.
Type Derived Property
Derived unit based on other fundamental or derived units.
Type Other Property
Other measurement unit or constant definition.
Type Synonym Property
Synonym for a unit.
Unit Category Test Function
Find cases where there are multiple Category-type units whose definitions equate to the same combination of base units.
Unit Category Unknown Test Function
Review all unit definitions whose user-specified Category is "unkown" and see their actual/calculated Category is known.
Unit Duplicate Test Function
Look for measurement definitions whose Code and/or space-stripped Code is the same as that of another unit. Duplicate unit codes should never occur, and duplicate space-stripped codes should normally be removed before definitions are made publicly available.
Unit Test Function
Find units which cannot be parsed by the conversion program.
Setup A Sub
"Setup 'A' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "A"
Setup C Sub
"Setup 'C' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "C"
Setup D Sub
"Setup 'D' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "D"
Setup E Sub
"Setup 'E' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "E"
Setup F Sub
"Setup 'F' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "F"
Setup H Sub
"Setup 'H' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "H"
Setup I Sub
"Setup 'I' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "I"
Setup K Sub
"Setup 'K' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "K"
Setup L Sub
"Setup 'L' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "L"
Setup M Sub
"Setup 'M' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "M"
Setup N Sub
"Setup 'N' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "N"
Setup P Sub
"Setup 'P' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "P"
Setup R Sub
"Setup 'R' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "R"
Setup S Sub
"Setup 'S' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "S"
Setup T Sub
"Setup 'T' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "T"
Setup U Sub
"Setup 'U' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "U"
Setup V Sub
"Setup 'V' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "V"
Setup W Sub
"Setup 'W' Measurement Definitions" Load the built-in definitions for measurements whose physical description begins with the letter "W"
Setup Units Sub
"Setup Measurement Definitions" Load the built-in definitions for the important measurements and constants. These measurements are loaded automatically when the first measurement-related function is called.

This Windows-based ActiveX DLL provides many useful routines through its function-bearing and data structure classes. Consult the Help file for more information, or call us at 1-310-472-3736. For the latest news and files, visit our home page on the World Wide Web: http://www.entisoft.com

Copyright 1996-1999 Entisoft
Entisoft Tools is a trademark of Entisoft.