Accessing Pro-Designer Variables with COM
About
The following tables display variable related information, for accessing (either as input or output) the Pro-Designer variables using the COM methods of the Designer server. Mainly the correspondence between the varID Enum and the Pro-Designer variable is given. You can retrieve the value of all variables using the Get…. functions but you can set the value (using the Set… functions) only for those marked as I/O in the table. The tables list the Variable ID that needs to be used for each variable (val) and their type. Some variables require extra specification, which is provided through the extra arguments (val2, val3, val4) when that is necessary.
The variables used in the Pro-Designer Server are grouped in the following categories:
● Flowsheet Variables
● Report Options Variables
● Section Variables
● Equipment Variables
● Procedure Variables
● Operation Variables
● Stream Variables
● Ingredient Variables
● Heat Transfer Agent Variables
● Power Type Variables
● Labor Type Variables
● Storage Unit Variables
● Excel Tables Options/Data Link Variables
● Auto Initialization Variables
|
|
All val, val2, val3 arguments of the COM functions are defined as Variants in the Pro-Designer Server and they must be defined as susch in VBA scripts. This means they can take different data types (Long, Boolean, Double, String, etc.). Each Pro-Designer server variable corresponds to a specific type and the data type for each variable ID is given for each variable category listed below. Please, see How to Use Variant Data Types in VBA Scripts for useful tips on how to treat these arguments in your VBA Scripts.
|
All variables of the Designer type library are communicated in SI Units. To find more on the units of the COM Variables, see Units of Variables accessed by COM.
Units of Variables accessed by COM
The data exchange in the Pro-Designer COM functions is done in SI units. The following table lists the most common units used in these functions:
|
Variable
|
Units
|
|
Mass
|
kg
|
|
Time
|
s
|
|
Volume
|
m3
|
|
Mass Flow
|
kg / s
|
|
Volumetric Flow
|
m3 / s
|
|
Temperature
|
Kelvin
|
|
Pressure
|
Pa
|
|
Power
|
W
|
|
Specific Power
|
W / kg or W / m3 or W / m2 (depending on the operation)
|
|
Mass Flux
|
kg / m2 s
|
|
Volume Flux
|
m3 / m2 s
|
|
Mass Concentration
|
kg / m3
|
|
Currency
|
$
|
|
Fraction / Percentage
|
[0, 1]
|
|
Heat Capacity
|
J/kg-K
|
Note on Stream related variables: Some variables are reported on a per batch basis if the flowsheet is in batch mode as shown in the following table:
|
Variable
|
Units
|
Flowsheet Type
|
|
Mass Flow
|
kg / batch
|
Batch
|
|
|
kg / s
|
Continuous
|
|
Volumetric Flow
|
m3 / batch
|
Batch
|
|
|
m3 / s
|
Continuous
|
|
Molar Flow
|
mol / batch
|
Batch
|
|
|
mol / s
|
Continuous
|
Note on Flowsheet related variables: The value of most flowsheet related variables are reported on a per year basis as shown in the following table. Furthermore some quantity specific variables are reported on per entity basis if the main product is discrete.
|
Variable
|
Units
|
Explanation
|
|
Annual Amount of Product
|
kg (/yr)
|
When product is bulk
|
|
|
entity (/yr)
|
When product is discrete
|
|
Units Production Cost
|
$ / kg
|
When product is bulk
|
|
|
$ /entity
|
When product is discrete
|
|
Total Amount of Component In/Out
|
kg (/yr)
|
When component refers to bulk material
|
|
|
entity (/yr)
|
When component refers to discrete entities
|
|
Annual Amount of Electricity
|
KWh (/yr)
|
|
|
Annual Amount of Utility (Agent)
|
kg (/yr)
|
|
Flowsheet Variables
1. Variables used in functions: GetFlowsheetVarVal / SetFlowsheetVarVal
|
Variable
Category
|
Variable (val)
|
Variable ID (varID)
|
I/O
|
Data
Type
|
|
Scheduling
|
Recipe Batch Time
|
batchTime_VID
|
O
|
Double
|
|
|
Recipe Cycle Time
|
cycleTime_VID
|
O
|
Double
|
|
|
Minimum Recipe Cycle Time
|
minCycleTime_VID
|
O
|
Double
|
|
|
Maximum Number Of Batches Per Year
|
maxNumberOfBatchesPerYear_VID
|
O
|
Long
|
|
|
Number of Batches per Year
|
numberOfBatchesPerYear_VID
|
I/O
|
Long
|
|
|
Annual Throughput
|
annualThroughput_VID
|
I/O
|
Double
|
|
|
Batch Throughput
|
batchThroughput_VID
|
I/O
|
Double
|
|
|
Ref. Flow Stream Name
|
refFlowStream_VID
|
I/O
|
String
|
|
|
Ref. Flow Component Name
|
refFlowComponent_VID
|
I/O
|
String
|
|
|
Throughput Ref. Flow Description
|
throughputRefFlowDscr_VID
|
O
|
String
|
|
|
Available Annual Operating Time
|
AOTAvailable_VID
|
I/O
|
Double
|
|
|
Annual Operating Time
|
AOTUtilized_VID
|
I/O
|
Double
|
|
|
Number of Campaigns
|
numberOfCampaigns_VID
|
I/O
|
Long
|
|
|
Is the Number of Batches Set By User
|
is NumberOfBatchesSBU_VID
|
I/O
|
Boolean
|
|
|
Is Cycle TIme Set-by-User
|
isCycleTimeSBU_VID
|
I/O
|
Boolean
|
|
|
Longest Procedure
|
longestUPName_VID
|
O
|
String
|
|
|
Bottleneck Equipment
|
bottleneckEquipName_VID
|
O
|
String
|
|
|
Is Batch Mode
|
isBatchMode_VID
|
O
|
Boolean
|
|
Cost
|
Equipment Purchase Cost
|
purchaseCost_VID
|
O
|
Double
|
|
|
Unlisted Equipment Purchase Cost
|
unlistedEquipPurchaseCost_VID
|
O
|
Double
|
|
|
Direct Fixed Cost
|
DFC_VID
|
O
|
Double
|
|
|
Raw Material Cost
|
materialsCost_VID
|
O
|
Double
|
|
|
Total Installation Cost
|
installationCost_VID
|
O
|
Double
|
|
|
Working Capital
|
workingCapital_VID
|
O
|
Double
|
|
|
Startup Capital
|
startupCapital_VID
|
O
|
Double
|
|
|
Up-front R&D Expenses
|
upFrontRD_VID
|
O
|
Double
|
|
|
Up-front Royalties
|
upFrontRoyalties_VID
|
O
|
Double
|
|
|
Equipment Cost
|
equipmentCost_VID
|
O
|
Double
|
|
|
Labor Cost
|
laborCost_VID
|
O
|
Double
|
|
|
Consumables Cost
|
consumablesCost_VID
|
O
|
Double
|
|
|
Laboratory Quality Control and Assurance Cost
|
labQcQaCost_VID
|
O
|
Double
|
|
|
Waste Treatment / Disposal Cost
|
wasteTrtDspCost_VID
|
O
|
Double
|
|
|
Utilities Cost
|
utilitiesCost_VID
|
O
|
Double
|
|
|
Transportation Cost
|
transportationCost_VID
|
O
|
Double
|
|
|
Miscellaneous Cost
|
miscellaneousCost_VID
|
O
|
Double
|
|
|
Annual Operating Cost
|
annualOperCost_VID
|
O
|
Double
|
|
|
Annual Operating Cost (without depreciation)
|
annualOperCostNDP_VID
|
O
|
Double
|
|
|
Other Annual Operating Cost
|
otherAnnualCost_VID
|
O
|
Double
|
|
|
Extended Annual Operating Cost
|
extendedAnnualOperCost_VID
|
O
|
Double
|
|
|
Depreciation Cost
|
depreciationCost_VID
|
O
|
Double
|
|
|
Annual Variable Operating Cost
|
annualVariableOperCost_VID
|
O
|
Double
|
|
|
Annual Fixed Operating Cost
|
annualFixedOperCost_VID
|
O
|
Double
|
|
|
Annual Electricity Cost
|
annualElectricityCost_VID
|
O
|
Double
|
|
|
Product Units Cost
|
unitProductionCost_VID
|
O
|
Double
|
|
|
Product Units Cost (without depreciation)
|
unitProductionCostNDP_VID
|
O
|
Double
|
|
|
Product Units Cost Units (Description)
|
unitProductionCostDscr_VID
|
O
|
String
|
|
|
Is the whole stream the main revenue
|
isMainRevenueWholeStream_VID
|
O
|
Boolean
|
|
|
Net annual operating Cost
|
netAnnualOperCost_VID
|
O
|
Double
|
|
|
Labor Hrs can be inputted in the Operation on a per Equipment basis
|
isLaborHrPerEquipment_VID
|
I/O
|
Boolean
|
|
Economic Indices
|
Revenue
|
revenue_VID
|
O
|
Double
|
|
|
Net Cash Flow
|
netCashFlow_VID
|
O
|
Double
|
|
|
Gross Margin
|
grossMargin_VID
|
O
|
Double
|
|
|
ROI
|
ROI_VID
|
O
|
Double
|
|
|
IRR Before Taxes
|
IRR_BeforeTaxes_VID
|
O
|
Double
|
|
|
IRR After Taxes
|
IRR_AfterTaxes_VID
|
O
|
Double
|
|
|
Annual Unit Production Cost Reference Rate
|
annualUnitProductionRefRate_VID
|
O
|
Double
|
|
|
Main Revenue Cost
|
mainRevenueCost_VID
|
O
|
Double
|
|
|
Gross Profit
|
grossProfit_VID
|
O
|
Double
|
|
|
Net Profit
|
netProfit_VID
|
O
|
Double
|
|
|
Payback Time
|
paybackTime_VID
|
O
|
Double
|
|
|
Total Investment
|
totalInvestment_VID
|
O
|
Double
|
|
|
Total Investment charged to this project
|
projectTotalInvestment_VID
|
O
|
Double
|
|
|
Annual Amount of Electricity
|
annualElectricityAmount_VID
|
O
|
Double
|
|
|
Low Interest Rate for NPV
|
NPVInterestLow_VID
|
O
|
Double
|
|
|
Medium Interest Rate for NPV
|
NPVInterestMedium_VID
|
O
|
Double
|
|
|
High Interest Rate for NPV
|
NPVInterestHigh_VID
|
O
|
Double
|
|
|
NPV at Low Interest Rate
|
NPVLow_VID
|
O
|
Double
|
|
|
NPV at Medium Interest Rate
|
NPVMedium_VID
|
O
|
Double
|
|
|
NPV at High Interest Rate
|
NPVHigh_VID
|
O
|
Double
|
|
|
Year of Analysis
|
yearOfAnalysis_VIDq
|
I/O
|
Long
|
|
|
Year Construction Starts
|
yearConstructionStarts_VIDq
|
I/O
|
Long
|
|
|
Construction Period
|
constructionPeriod_VID
|
I/O
|
Long
|
|
|
Startup Period
|
startupPeriod_VID
|
I/O
|
Long
|
|
|
Project Lifetime
|
projectLifetime_VID
|
I/O
|
Long
|
|
|
Inflation Rate (0-1)
|
inflation_VID
|
I/O
|
Double
|
|
|
Depreciation Method
|
deprecMethod_VID
|
I/O
|
Long
|
|
|
Depreciation Period
|
deprecPeriod_VID
|
I/O
|
Long
|
|
|
Salvage Fraction (0-1)
|
salvageF_VID
|
I/O
|
Double
|
|
|
Is Depreciation Subtracted from Net Profit
|
isDeprecSubFromNetProfit_VID
|
I/O
|
Boolean
|
|
|
Product Failure Rate
|
prodFailureRate_VID
|
I/O
|
Double
|
|
|
Failed Product Disposal Cost
|
failedProdDisposalCost_VID
|
I/O
|
Double
|
|
|
Income Tax Rate
|
incomeTaxRate_VID
|
I/O
|
Double
|
|
|
Sales & Advertising Cost (Fixed Component)
|
adSalesExpFixed_VID
|
I/O
|
Double
|
|
|
Sales & Advertising Cost (Variable Component)
|
adSalesExpVariable_VID
|
I/O
|
Double
|
|
General
|
Number of Components Registered
|
numberOfComps_VID
|
O
|
Long
|
|
|
Number of Unit Procedures in the Process
|
numberOfUP_VID
|
O
|
Long
|
|
|
Year of Analysis
|
yearOFAnalysis_VID
|
I/O
|
Long
|
|
|
Draftsman’s Name
|
draftsman_VID
|
I/O
|
String
|
|
|
Designer’s Name
|
designer_VID
|
I/O
|
String
|
|
|
Supervisor’s Name
|
superviso_VID
|
I/O
|
String
|
|
|
Company’s Name
|
companyName_VID
|
I/O
|
String
|
|
|
Plant’s Name
|
plantName_VID
|
I/O
|
String
|
|
|
Revision
|
revision_VID
|
I/O
|
String
|
|
|
Date the process model was saved
|
lastSavedDate_VID
|
I/O
|
Date
|
|
|
Comments
|
comments_VID
|
I/O
|
String
|
|
|
File name including path
|
fileName_VID
|
O
|
String
|
|
|
Initialize auto intialized streams upon opening
|
bInitIStreamsUponOpen_VID
|
I/O
|
Boolean
|
2. Variables used in functions: GetFlowsheetVarVal2 / SetFlowsheetVarVal2
|
Variable (val)
|
Variable ID (varID)
|
Variable
Type
|
Extra arg.
(val2) and
type
|
I/O
|
|
Total amount of component input to the process
|
totalComponentInput_VID
|
Double
|
Component Name (String)
|
O
|
|
Total amount of component output of the process
|
totalComponentOutput_VID
|
Double
|
Component Name (String)
|
O
|
|
Annual Amount of Heat Transfer Agent use
|
annualAgentAmount_VID
|
Double
|
Agent Name (String)
|
O
|
|
Annual Cost of Heat Transfer Agent use
|
hxAgentCost_VID
|
Double
|
Agent Name (String)
|
O
|
|
Annual Amount of Electricity
|
annualElectricityAmount_VID
|
Double
|
Power Name
(String)
|
O
|
|
Annual Electricity Cost
|
annualElectricityCost_VID
|
Double
|
Power Name
(String)
|
O
|
|
Annual Amount of Labor hours used
|
laborAmount_VID
|
Double
|
Labor Type Name (String)
|
O
|
|
Annual Cost of Labor use
|
laborCost_VID
|
Double
|
Labor Type Name (String)
|
O
|
|
Auxiliary Equipment Purchase Cost
|
auxEquipPC_VID
|
Double
|
Aux. Equip. Name (String)
|
O
|
|
Auxiliary Equipment Size
|
auxEquipSize_VID
|
Double
|
Aux. Equip. Name (String)
|
O
|
|
Auxiliary Equipment Size Units
|
auxEquipSizeUnits_VID
|
String
|
Aux. Equip. Name (String)
|
O
|
|
Auxiliary Equipment Number of Units
|
auxEquipNoUnits_VID
|
Long
|
Aux. Equip. Name (String)
|
O
|
|
Auxiliary Equipment Number of Parallel Uses
|
auxEquipNoParallelUses_VID
|
Long
|
Aux. Equip. Name (String)
|
O
|
3. Variables used in Functions: GetFlowsheetVarVal3 / SetFlowsheetVarVal3
|
Variable (val)
|
Variable ID (varID)
|
Variable
Type
|
Extra arg.
(val2) and
type
|
Extra arg.
(val3) and
type
|
I/O
|
|
Consumable
Description
|
description_VID
|
String
|
Consumable
Name (String)
|
Consumable
Type (String)
|
I/O
|
|
Consumable
Unit Cost
|
consumableUnitCost_VID
|
Double
|
Consumable
Name (String)
|
Consumable
Type (String)
|
I/O
|
|
Consumable Basis
|
consumableBasis_VID
|
Double
|
Consumable
Name (String)
|
Consumable Type (String)
|
O
|
|
Annual Consumable Amount
|
annualConsumable
Amount_VID
|
Double
|
Consumable
Name (String)
|
Consumable Type (String)
|
O
|
|
Electricity Unit Cost
|
secOCElecUnitCost_VID
|
Double
|
Section Name (String )
|
Branch Name (String)
|
O
|
|
Ingredient Amount not Inputted through Streams
|
nonStreamIngredientUse_VID
|
Double
|
Ingredient
Name (String)
|
Resource
UseTimeRef
|
O
|
|
Ingredient Amount Used through Streams
|
streamIngredientUse_
VID
|
Double
|
Ingredient
Name (String)
|
Resource
UseTimeRef
|
O
|
Resource Use Time Reference
Resource Use Time Reference that can be used with nonStreamIngredientUse_VID and streamIngredientUse_VID:
|
Value (Long)
|
Meaning
|
|
1
|
Per Year
|
|
2
|
Per Batch
|
|
3
|
Per Campaign
|
|
4
|
Per Main Product
|
|
5
|
Per Hour
|
Note: Electricity Unit Cost can only be retrieved, if there is only one type of Power utilized in the section (default power), otherwise, if there are different types you must use GetPowerVarVal function indicating the power type, see Functions for Power Variables.
Report Options Variables
Variables for functions: GetReportGeneralOptions / SetReportGeneralOptions
|
Variable (val)
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Use Default Title in Reports
|
bDefaultTitle_VID
|
I/O
|
Boolean
|
|
Title
|
title_VID
|
I/O
|
String
|
|
Header
|
header_VID
|
I/O
|
String
|
|
Footer
|
footer_VID
|
I/O
|
String
|
Section Variables
1. Variables used in functions: GetSectionVarVal / SetSectionVarVal
|
Variable
Category
|
Variable (val)
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Cost
|
Equipment Purhcase Cost
|
purchaseCost_VID
|
O
|
Double
|
|
|
Direct Fixed Cost
|
DFC_VID
|
O
|
Double
|
|
|
Raw Materials Cost
|
materialsCost_VID
|
O
|
Double
|
|
|
Installation Cost
|
installationCost_VID
|
O
|
Double
|
|
|
Direct Cost
|
directCost_VID
|
O
|
Double
|
|
|
Indirect Cost
|
indirectCost_VID
|
O
|
Double
|
|
|
Other Cost
|
otherCost_VID
|
|
|
|
|
Equipment Cost
|
equipmentCost_VID
|
O
|
Double
|
|
|
Labor Cost
|
laborCost_VID
|
O
|
Double
|
|
|
Consumable Cost
|
consumablesCost_VID
|
O
|
Double
|
|
|
Laboratory Quality Control and Assurance Cost
|
labQcQaCost_VID
|
O
|
Double
|
|
|
Waste Treatment / Disposal Cost
|
wasteTrtDspCost_VID
|
O
|
Double
|
|
|
Utilities Cost
|
utilitiesCost_VID
|
O
|
Double
|
|
|
Transportation Cost
|
transportationCost_VID
|
O
|
Double
|
|
|
Miscellaneous Cost
|
miscellaneousCost_VID
|
O
|
Double
|
|
|
Annual Operating Cost
|
annualOperCost_VID
|
O
|
Double
|
|
|
Depreciation Cost
|
depreciationCost_VID
|
O
|
Double
|
|
|
Annual Electricity Cost
|
annualElectricityCost_VID
|
O
|
Double
|
|
Capital
Cost/DFC
|
DFC Estimation Option
0 = Set By User
1 = Using PC-to-DFC Factor
2 = Detailed Estimation
|
secCCDFCEstimationOption_VID
|
I/O
|
Long
|
|
|
PC-to-DFC Factor
|
secCCPCtoDFCFactor_VID
|
I/O
|
Double
|
|
|
Piping Factor
|
secCCPipingF_VID
|
I/O
|
Double
|
|
|
Instrumentation Factor
|
secCCInstrumentationF_VID
|
I/O
|
Double
|
|
|
Insulation Factor
|
secCCInsulationF_VID
|
I/O
|
Double
|
|
|
Electrical Facilities Factor
|
secCCElecFacilitiesF_VID
|
I/O
|
Double
|
|
|
Buildings Factor
|
secCCBuildingsF_VID
|
I/O
|
Double
|
|
|
Yard Improvement
|
secCCYardImprovementF_VID
|
I/O
|
Double
|
|
|
Engineering Factor
|
secCCEngineeringF_VID
|
I/O
|
Double
|
|
|
Auxiliary Facilities Factor
|
secCCAuxFacilitiesF_VID
|
I/O
|
Double
|
|
|
Yard Improvement Factor
|
secCCYardImprovementF_VID
|
I/O
|
Double
|
|
|
Construction Factor
|
secCCConstructionF_VID
|
I/O
|
Double
|
|
|
Contractor’s Fee Factor
|
secCCContractorFeeF_VID
|
I/O
|
Double
|
|
|
Contigency Factor
|
secCCContigencyF_VID
|
I/O
|
Double
|
|
|
Unlisted Equipment Factor
|
secCCUnlistedEquipF_VID
|
I/O
|
Double
|
|
|
Unlisted Equipment Installation Factor
|
secCCUnlistedEquipInstallF_VID
|
I/O
|
Double
|
|
Capital
Cost/Misc
|
Is Working Capital
Set By User
|
secCCWkngCapSetByUSer_VID
|
I/O
|
Boolean
|
|
|
Working Capital
|
secCCWkngCap_VID
|
I/O
|
Double
|
|
|
Days of Labor Incl. Cost In Working Capital
|
secCCWkngCapLanorDays_VID
|
I/O
|
Double
|
|
|
Days of Raw Materials CostIncl. In Working Capital
|
secCCWkngCapRawMatDays_VID
|
I/O
|
Double
|
|
|
Days of Utilities Cost Incl. In Working Capital
|
secCCWkngCapUtilities_VID
|
I/O
|
Double
|
|
|
Days of Waste Treatment incl. In Working Capital
|
secCCWkngCapWasteTrmtDays_VID
|
I/O
|
Double
|
|
|
Working Capital for Miscellaneous Activities
|
secCCWkngCapMisc_VID
|
I/O
|
Double
|
|
|
Is Startup Cost Set By User
|
secCCStartupCostSetByUser_VID
|
IO
|
Boolean
|
|
|
Startup Cost Factor
|
secCCStratupCostF_VID
|
I/O
|
Double
|
|
|
Up Front R&D Factor
|
secCCUpFrontRD_VID
|
I/O
|
Double
|
|
|
Up Front Royalties Factor
|
secCCUpFrontRoyalties_VID
|
I/O
|
Double
|
|
|
User Comments
|
comments_VID
|
I/O
|
String
|
|
Oper. Cost
/ Facility
|
Inc. Component Based on Operating Parameters
|
secOCInclOpParamsBased_VID
|
I/O
|
Boolean
|
|
|
Incl. Component Based on Capital investment
|
secOCInclCapInvstmBased_VID
|
I/O
|
Boolean
|
|
|
Incl. Component Based on Equip. Usage/Avail.
|
secOCInclEquipUseBased_VID
|
I/O
|
Boolean
|
|
|
Inc. Component Based on Facility Usage/Avail.
|
secOCInclFacilityUseBased_VID
|
I/O
|
Boolean
|
|
|
Is Equipment Charge (Hours) Based on Use?
|
secOCEquipHrsBasedOnUsage_VID
|
I/O
|
Boolean
|
|
|
Facility Charge Rate
|
secOCFacilityUseRate_VID
|
I/O
|
Double
|
|
|
Is Maintenance Component Included?
|
secOCInclMaintnc_VID
|
I/O
|
Boolean
|
|
|
Is Depreciation Component Included?
|
secOCInclDeprec_VID
|
I/O
|
Boolean
|
|
|
Is Miscellaneous Cost Component Included?
|
secOCInclMiscCosts_VID
|
I/O
|
Boolean
|
|
|
Is Miscellaneous Cost Calculated from DFC?
|
secOCMaintcBasedOnDFC_VID
|
I/O
|
Boolean
|
|
|
DFc to Maintenance Factor
|
secOCDFCtoMaintcF_VID
|
I/O
|
Double
|
|
|
Insurance Factor
|
secOCInsuranceF_VID
|
I/O
|
Double
|
|
|
Local Taxes Factor
|
secOCLocalTaxF_VID
|
I/O
|
Double
|
|
|
Factory Expenses Factor
|
secOCFactoryExpF_VID
|
I/O
|
Double
|
|
Oper. Cost
/ Util.
|
Electricity Unit Cost
|
secOCElecUnitCost_VID
|
O
|
Double
|
|
|
Extra Electricity
(per year or per batch)
|
secOCExtraElec_VID
|
I/O
|
Double
|
|
|
Is Extra Electricity Set On a Per-Year Basis?
|
secOCIsExtraElecPerYear_VID
|
I/O
|
Boolean
|
|
|
General Load
(as % total)
|
secOCGeneralLoadF_VID
|
I/O
|
Double
|
|
|
Electrical Poqer for Unlisted
Equip. (as % Total)
|
secOCUnlistedEquipLoadF_VID
|
I/O
|
Boolean
|
|
Oper.
Cost/Misc.
|
Is Misc. Oper. Cost Items Set on a Per Year Basis?
|
secOCIsOCMiscPerYear_VID
|
I/O
|
Boolean
|
|
|
R&D Cost (Fixed)
|
secOCResAndDevFixed_VID
|
I/O
|
Double
|
|
|
R&D Cost (Variable)
|
secOCResAndDevVariable_VID
|
I/O
|
Double
|
|
|
Process Validation
|
secOCProcessValidation_VID
|
I/O
|
Double
|
|
|
Other Cost (Fixed)
|
secOCMiscOtherFixed_VID
|
I/O
|
Double
|
|
|
Other Cost (Variable)
|
secOCMiscOtherVariable_VID
|
I/O
|
Double
|
|
|
Laboratory Quality Control Labor Factor [0, 1.0]
(as % of Total Labor Cost)
|
qcSecLaborFactor_VID
|
I/O
|
Double
|
|
|
Laboratory Quality Control
Estimated as % of Total Labor option
|
qcSecLaborIsEstimated_VID
|
I/O
|
Boolean
|
|
|
Laboratory Quality Control
Detailed Estimation option
|
qcSecItemizedIsEstimated_VID
|
I/O
|
Boolean
|
|
|
|
|
|
|
|
|
|
|
|
|
|
General
|
Number of Components Registered
|
numberOfComps_VID
|
O
|
Long
|
|
|
Gross Mass Yield
|
grossMassYield_VID
|
O
|
Double
|
|
|
Refined Mass Yield
|
refinedMassYield_VID
|
O
|
Double
|
|
|
Molar Yield
|
molarYield_VID
|
O
|
Double
|
2. Variables Used In Functions: GetSectionVarVal2 / SetSectionVarVal2
|
Variable (val)
|
Varibale ID (varID)
|
Data Type
|
Extra arg.
(val2) and
type
|
I/O
|
|
Annual Material Amount
|
materialAmount_VID
|
Double
|
Material Name (String)
|
O
|
|
Annual Material Amount (per Year)
|
materialAmtPerYr_VID
|
Double
|
Material Name (String)
|
O
|
|
Material Amount
(per Batch)
|
materialAmtPerBatch_VID
|
Double
|
Material Name (String)
|
O
|
|
Material Amount
(per Campaign)
|
materialAmtPerCampaign_
VID
|
Double
|
Material Name (String)
|
O
|
|
Material Amount
(per Main Product)
|
materialAmtPerMP_VID
|
Double
|
Material Name (String)
|
O
|
|
Material Amount
(per Hour)
|
materialAmtPerHr_VID
|
Double
|
Material Name (String)
|
O
|
|
Annual Heat Transfer Agent Amount
|
annualAgentAmount_VID
|
Double
|
Agent Name (String)
|
O
|
|
Annual Labor Amount
|
laborAmount_VID
|
Double
|
Labor Type Name (String)
|
O
|
|
Total Lumped Labor Need amount for all services
|
laborNeed_VID
|
Double
|
Labor Type Name (String)
|
I/O
|
|
Annual Electricity Amount
|
annualElectricityAmount_VID
|
Double
|
Power Type Name (String)
|
O
|
|
Laboratory Quality Control
Fixed Cost
|
qcSecFixedCost_VID
|
Double
|
per Year: true
per Batch:
false
|
I/O
|
|
Laboratory Quality Control
Variable Cost: Number of Cost Tests
|
qcSecVariableCostTests_VID
|
Long
|
Cost Test Name (String)
|
I/O
|
|
Laboratory Quality Control
Variable Cost
|
qcSecVariableCost_VID
|
Double
|
Cost Test Name (String)
|
I/O
|
3. Variables Used In Functions:
|
Variable (val)
|
Varibale ID (varID)
|
Data Type
|
Extra arg.
(val2) and
type
|
Extra arg. (val3) and type
|
I/O
|
|
Lumped labor need amount
|
laborNeed_VID
|
Double
|
Labor Type Name (String)
|
Service Name (String)
|
I/O
|
|
Lumped labor need amount units (Resource Use Time Reference units)
|
laborUnits_VID
|
Integer
|
Labor Type Name (String)
|
Service Name (String)
|
I/O
|
|
Itemized labor amount
|
itemizedLaborAmt_VID
|
Double
|
Labor Type Name (String)
|
Resource Use Time Ref Units (Integer)
|
O
|
|
Add New Variable Cost Test Name
|
qcSecVariableCostTest_VID
|
String
|
Number of Tests (Long)
|
Cost (Double)
|
I
|
|
Material Amount
|
materialAmount_VID
|
Double
|
Material Name (String)
|
Resource Use Time Ref Units (Integer)
|
O
|
GetSectionVarVal3 / SetSectionVarVal3
Variables Used In Functions:
|
Variable (val)
|
Varibale ID (varID)
|
Data Type
|
Extra arg.
(val2) and
type
|
Extra arg. (val3) and type
|
Extra arg. (val3) and type
|
I/O
|
|
material input amount in specified Resource Use Time Ref. Units and consumption type
|
material
Amount_VID
|
Dbl
|
Material Name (String)
|
Resource Use Time Ref Units (Integer)
|
Ingredient In Type
(Interger)
|
O
|
|
material output amount in specified Resource Use Time Ref. Units and output type
|
materialOut
Amount_VID
|
Dbl
|
Material Name (String)
|
Resource Use Time Ref Units (Integer)
|
Ingredient Out Type
(Interger)
|
O
|
GetSectionVarVal4
Resource Use Time Reference
Resource Use Time Reference that can be used with itemizedLaborAmt_VID:
|
Value (Long)
|
Meaning
|
|
1
|
Per Year
|
|
2
|
Per Batch
|
|
3
|
Per Campaign
|
|
4
|
Per Main Product
|
|
5
|
Per Hour
|
Specifying Ingredient Consumption Type
This Enum is used for specifying the ingredient consumption type that can be used with materialAmount_VID:
|
Ingredient Classified As:
|
Ingredient Consumption Type
|
|
Raw Material
|
rawMaterial_MIT
|
|
Unclassified
|
unclassified_MIT
|
|
Cleaning Agent
|
cleaningAgent_MIT
|
|
Heat Transfer Agent
|
hxAgent_MIT
|
|
Revenue Agent
|
revenue_MIT
|
|
All of the above types
|
all_MIT
|
Specifying Material Output Type
This Enum is used for specifying the material output type that can be used with materialOutAmount_VID:
|
Material Classified As:
|
Material Output Type
|
|
No Classification
|
noClassification_MOT
|
|
Revenue
|
revenue_MOT
|
|
Credit
|
credit_MOT
|
|
Solid Waste
|
solWaste_MOT
|
|
Aqueous Waste
|
aqWaste_MOT
|
|
Organic Waste
|
orgWaste_MOT
|
|
Emissions
|
emission_MOT
|
|
Heat Transfer Agent Output
|
hxAgentOutput_MOT
|
|
All of the above types
|
all_MOT
|
Equipment Variables
1. Variables used in functions: GetEquipVarVal / SetEquipVarVal
|
Variable (val)
|
Variable ID (varID)
|
I/O
|
Data
Type
|
|
Number of Units
|
noUnits_VID
|
I/O
|
Long
|
|
Number of Procedures hosted by this equipment
|
noHostedProcedures_VID
|
O
|
Long
|
|
Is Equipment In Design Mode?
|
isDesignMode_VID
|
I/O
|
Boolean
|
|
Number of Staggered Equipment Sets. Will enable staggering mode if number of staggered sets >=1 or disable it if set to zero.
|
noStaggeredEquip_VID
|
I/O
|
Long
|
|
Purchase Cost
|
equipPC_VID
|
I/O
|
Double
|
|
Purchase Cost Estimation Option
0 = Default Model
1= User Defined Model
2 = Set by User
|
equipPCEstimationOption_VID
|
I/O
|
Long
|
|
Number of Standby Units
|
equipStandByNoUnits_VID
|
I/O
|
Long
|
|
PC Portion Already Depreciated
|
equipPCDeprePortion_VID
|
I/O
|
Double
|
|
Construction Material
|
equipConstrMaterial_VID
|
I/O
|
String
|
|
Construction Material Factor
|
equipConstrMaterialF_VID
|
I/O
|
Double
|
|
Installation Factor
|
equipInstallCostF_VID
|
I/O
|
Double
|
|
Maintenance Factor
|
equipMaintcCostF_VID
|
I/O
|
Double
|
|
Usage Rate
|
equipUsageRate_VID
|
I/O
|
Double
|
|
Availability Rate
|
equipAvailabilityRate_VID
|
I/O
|
Double
|
|
Busy Time (total time equipment is engaged, possibly by multiple procedures, not including in-between dead-time)
|
busyTime_VID
|
O
|
Double
|
|
Occupancy Time (total time equipment is occupied, including in-between dead-time)
|
occupancyTime_VID
|
O
|
Double
|
|
Maximum Fill Ratio
|
maxFillRatio_VID
|
O
|
Double
|
|
Equipment Name
|
equipmentName_VID
|
O
|
String
|
|
Description
|
description_VID
|
I/O
|
String
|
|
Number of procedures using equipment
|
noHostedProcedures_VID
|
O
|
Long
|
|
User Comments
|
comments_VID
|
I/O
|
String
|
|
Equipment Size
|
size_VID
|
O
|
Double
|
|
Equipment Size Units
|
sizeUnits_VID
|
O
|
String
|
|
Sizing Description
|
sizeName_VID
|
O
|
String
|
|
Equipment Type
|
typeName_VID
|
O
|
String
|
|
Equipment Type ID
|
typeID_VID
|
O
|
Long
|
/ GetEquipVarValEx
2. Variables used in functions: GetEquipVarVal3 / SetEquipVarVal3
|
Variable
|
Variable ID (varID)
|
Var.
Type
|
Extra arg.
(val2) and
type
|
Extra arg.
(val3) and
type
|
I/O
|
|
Consumable
Replacement
Frequency
|
consumableReplFreq_VID
|
Double
|
Consumable
Name
(String)
|
Consumable
Type
(String)
|
I/O
|
|
Consumable
Replacement
Frequency
Basis
|
consumableReplFreqBasis_VID
|
Out
String/In
Long
|
Consumable
Name
(String)
|
Consumable
Type
(String)
|
I/O
|
|
Consumable Consumtion Rate
|
consumableConsumRate_VID
|
Double
|
Consumable
Name
(String)
|
Consumable
Type
(String)
|
I/O
|
|
Size Utilization
|
sizeUtilization_VID
|
Double
|
Procedure Name (String)
|
-
|
O
|
|
Annual Consumable Amount
|
annualConsumableAmount_
VID
|
Double
|
Consumable
Name (String)
|
Consumable Type (String)
|
O
|
|
Time Utilization
|
timeUtilization_VID
|
Double
|
Procedure Name (String)
|
-
|
O
|
Replacement Frequency Basis
The Replacement Frequency Basis unit option that can be set with consumableReplFreqBasis_VID:
|
Value (Long)
|
Meaning
|
|
1
|
per Cycle(s)
|
|
2
|
per Hour(s)
|
|
6
|
per Year(s)
|
3. Equipment Specific Variables for variables used in certain equipment (i.e. volume in vessels)
4. Variables used in functions: GetEquipContentsVarVal / SetEquipContentsVarVal
|
Variable (val)
|
Variable ID (varID)
|
I/O
|
Data
Type
|
|
Contents Temperature
|
temperature_VID
|
I/O
|
Double
|
|
Contents Pressure
|
pressure_VID
|
I/O
|
Double
|
|
Activity
|
activity_VID
|
O
|
Double
|
|
Mass Flow
|
massFlow_VID
|
I/O
|
Double
|
|
Volumetric Flow
|
volFlow_VID
|
I/O
|
Double
|
|
Ingredient Mass Flow
|
componentMassFlow_VID
|
I/O
|
Double
|
|
Ingredient Mole Flow
|
componentMoleFlow_VID
|
I/O
|
Double
|
|
Ingredient Mass Concentration
|
compMassConc_VID
|
O
|
Double
|
|
Ingredient Mole Concentration
|
compMoleConc_VID
|
O
|
Double
|
|
Ingredient Mass Fraction
|
compMassFrac_VID
|
I/O
|
Double
|
|
Ingredient Mole Fraction
|
compMoleFrac_VID
|
O
|
Double
|
|
Ingredient Vapor Fraction
|
compVaporFrac_VID
|
O
|
Double
|
|
Ingredient Extra Cell Fraction
|
compExtraCellFrac_VID
|
I/O
|
Double
|
|
Ingredient Molecular Weight
|
mw_VID
|
O
|
Double
|
|
Edit the ingredient fractions as opposed to the flows
|
bEditIngredientFracs_VID
|
I/O
|
Boolean
|
|
Edit the contents mass as opposed to the volume
|
bVolFlowSetByUser_VID
|
I/O
|
Boolean
|
Plus the following environmental properties:
|
Variable ID (varID)
|
I/O
|
Data
Type
|
|
TOC_VID
|
O
|
Double
|
|
COD_VID
|
O
|
Double
|
|
ThOD_VID
|
O
|
Double
|
|
BODu_VID
|
O
|
Double
|
|
BOD5_VID
|
O
|
Double
|
|
TKN_VID
|
O
|
Double
|
|
NH3_VID
|
O
|
Double
|
|
NO3_VID
|
O
|
Double
|
|
TP_VID
|
O
|
Double
|
|
TS_VID
|
O
|
Double
|
|
TSS_VID
|
O
|
Double
|
|
VSS_VID
|
O
|
Double
|
|
DVSS_VID
|
O
|
Double
|
|
TDS_VID
|
O
|
Double
|
|
VDS_VID
|
O
|
Double
|
|
DVDS_VID
|
O
|
Double
|
|
CaCO3_VID
|
O
|
Double
|
Procedure Variables
1. Variables for functions: GetUPVarVal / SetUPVarVal
|
Variable
|
Variable ID (varID)
|
I/O
|
Data
Type
|
|
Number of Operations in the Procedure
|
numberOfOperations_VID
|
O
|
Long
|
|
Number of Cycles in the Procedure
|
numberOfCycles_VID
|
I/O
|
Long
|
|
Start Time
|
startTime_VID
|
O
|
Double
|
|
End Time
|
endTime_VID
|
O
|
Double
|
|
Cycle Time
|
cycleTime_VID
|
O
|
Double
|
|
Holdup Time
|
holdupTime_VID
|
I/O
|
Double
|
|
Total Time per Batch (all cycles)
|
totalTimePerBatch_VID
|
O
|
Double
|
|
Is Batch Mode?
|
isBatchMode_VID
|
O
|
Boolean
|
|
Equipment Name
|
equipmentName_VID
|
O
|
String
|
|
Size Utilization
|
sizeUitlization_VID
|
O
|
Double
|
|
Maximum Fill Ratio
|
maxFillRatio_VID
|
O
|
Double
|
|
Time Utilization
|
timeUtilization_VID
|
O
|
Double
|
|
Comments
|
comments_VID
|
I/O
|
String
|
|
Section name
|
sectionName_VID
|
O
|
String
|
2. Variables for functions: GetUPVarVal2 / SetUPVarVal2
|
Variable
|
Variable ID (varID)
|
Data
Type
|
Extra arg.
(val2) and
type
|
I/O
|
|
Annual Material Amount
|
materialAmount_VID
|
Double
|
Material Name (String)
|
O
|
|
Annual Material Amount (per Year)
|
materialAmtPerYr_VID
|
Double
|
Material Name (String)
|
O
|
|
Material Amount
(per Batch)
|
materialAmtPerBatch_VID
|
Double
|
Material Name (String)
|
O
|
|
Material Amount
(per Campaign)
|
materialAmtPerCampaign_
VID
|
Double
|
Material Name (String)
|
O
|
|
Material Amount
(per Main Product)
|
materialAmtPerMP_VID
|
Double
|
Material Name (String)
|
O
|
|
Material Amount
(per Hour)
|
materialAmtPerHr_VID
|
Double
|
Material Name (String)
|
O
|
|
Annaul Heat Transfer Agent Amount
|
annualAgentAmount_VID
|
Double
|
Agent Name (String)
|
O
|
|
Annual Labor Amount
|
laborAmount_VID
|
Double
|
Labor Type Name (String)
|
O
|
|
Annual Electricity Amount
|
annualElectricityAmount_VID
|
Double
|
Power Type Name (String)
|
O
|
3. Variables used in Functions: GetUPVarVal3 / SetUPVarVal3
|
Variable (val)
|
Variable ID (varID)
|
Variable
Type
|
Extra arg.
(val2) and
type
|
Extra arg.
(val3) and
type
|
I/O
|
|
Material Amount
|
materialAmount_VID
|
Double
|
Ingredient
Name (String)
|
Resource
UseTimeRef
|
O
|
See also, Resource Use Time Reference.
3. Variables for functions: GetUPEmptiedContentsVarVal
|
Variable
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Stream Temperature
|
temperature_VID
|
O
|
Double
|
|
Stream Pressure
|
pressure_VID
|
O
|
Double
|
|
Stream Mass Flow
|
massFLow_VID
|
O
|
Double
|
|
Stream Volumetric Flow
|
volFLow_VID
|
O
|
Double
|
|
Specified Component Molecular Weight
|
mw_VID
|
O
|
Double
|
|
Specified component mass flow in stream
|
componentMassFlow_VID
|
O
|
Double
|
|
Specified component mass fraction in stream
|
compMassFrac_VID
|
O
|
Double
|
|
Specified component mole flow in stream
|
componentMoleFlow_VID
|
O
|
Double
|
|
Specified component mole fraction in stream
|
componentMoleFrac_VID
|
O
|
Double
|
|
Specified component mass concentration in stream
|
compMassConc_VID
|
O
|
Double
|
|
Specified component mole concentration in stream
|
compMolConc_VID
|
O
|
Double
|
|
Specified component extra cellular fraction in stream
|
compExtraCellFrac_VID
|
O
|
Double
|
|
Specified component vapor fraction in stream
|
compVaporFrac_VID
|
O
|
Double
|
Operation Variables
1. Variables for functions: GetOperVarVal / SetOperVarVal
|
Variable
|
Variable ID (varID)
|
I/O
|
Data
Type
|
|
Operation Start Time
|
startTime_VID
|
O
|
Double
|
|
Operation End Time
|
endTime_VID
|
O
|
Double
|
|
Operation Set Up Time
|
setUpTime_VID
|
I/O
|
Double
|
|
Operation Process Time
|
processTime_VID
|
I/O
|
Double
|
|
Operation Holdup Time
|
holdupTime_VID
|
I/O
|
Double
|
|
Operation Turnaround Time
|
turnaroundTime_VID
|
I/O
|
Double
|
|
Process Time Calculation Mode
|
processTimeCalcMode_VID
|
O
|
Long
|
|
Operation Start Time Shift
|
timeShift_VID
|
I/O
|
Double
|
|
Thermal Mode
|
thermalMode_VID
|
I/O
|
Long
|
|
Exit Temperature
|
exitTemperature_VID
|
I/O
|
Double
|
|
Operating Pressure
|
operPress_VID
|
I/O
|
Double
|
|
Heating Duty
|
heatingDuty_VID
|
I/O
|
Double
|
|
Cooling Duty
|
coolingDuty_VID
|
I/O
|
Double
|
|
Primary Heat Transfer Agent Name
|
primaryHxAgentName_VID
|
O
|
String
|
|
Primary Heat Transfer Agent Rate
|
primaryHxAgentRate_VID
|
O
|
Double
|
|
Primary Heat Transfer Agent Duty
|
primaryHxAgentDuty_VID
|
O
|
Double
|
|
Is Primary Heat Transfer Agent Heating or Cooling?
|
isPrimaryHxAgentHeating_VID
|
O
|
Boolean
|
|
Auxiliary Heating Agent Name
|
auxHeatingHxAgentName_VID
|
O
|
String
|
|
Auxiliary Heating Agent Rate
|
auxHeatingHxAgentRate_VID
|
I/O
|
Double
|
|
Auxiliary Heating Agent Duty
|
auxHeatingHxAgentDuty_VID
|
O
|
Double
|
|
Auxiliary Cooling Agent Name
|
auxCoolingHxAgentName_VID
|
O
|
String
|
|
Auxiliary Cooling Agent Rate
|
auxCoolingHxAgentRate_VID
|
I/O
|
Double
|
|
Auxiliary Cooling Agent Duty
|
auxCoolingHxAgentDuty_VID
|
O
|
Double
|
|
Auxiliary Power Name
|
auxPowerName_VID
|
O
|
String
|
|
Auxiliary Power Rate
|
auxPowerRate_VID
|
I/O
|
Double
|
|
Size Utilization
|
sizeUtilization_VID
|
O
|
Double
|
|
Power Calculation Mode
|
powerCalcMode_VID
|
O
|
Long
|
|
Power
|
power_VID
|
I/O
|
Double
|
|
Specific Power
|
specPower_VID
|
I/O
|
Double
|
|
Power per Unit
|
powerPerUnit_VID
|
I/O
|
Double
|
|
Power Dissipation to Heat
|
powerDissipationFrac_VID
|
I/O
|
Double
|
|
Is Vent On
|
bIsVentOn_VID
|
O
|
Boolean
|
|
Relief Valve Pressure
|
ventPress_VID
|
I/O
|
Double
|
|
Vent Condenser Temperature
|
condenserTemperature_VID
|
I/O
|
Double
|
|
Operation Type
|
opType_VID
|
O
|
String
|
|
Operation Description
|
opDescr_VID
|
I/O
|
String
|
|
Is Operation Description
Set By User
|
isOpDescrSetByUser_VID
|
I/O
|
Boolean
|
|
Auxiliary Equipment name used by operation
|
auxEquipName_VID
|
O
|
String
|
|
User Comments
|
comments_VID
|
I/O
|
String
|
Note: When setting the operation process time the process time calculation mode is forced to Set by the User.
2. Variables for functions: GetOperVarVal2 / SetOperVarVal2
|
Variable
|
Variable (varID)
|
Extra arg.
(val2) and
type
|
I/O
|
Data
Type
|
|
Total Annual Labor Amount
|
laborAmount_VID
|
Labor Name (String)
|
O
|
Double
|
|
Total Labor Need amount for all services
|
laborNeed_VID
|
Labor Name
(String)
|
I/O
|
Double
|
|
Labor Units
|
laborUnits_VID
|
Labor Name
(String)
|
O
|
String
|
|
Is Component Emitted?
|
bIsCompEmitted_VID
|
Component Name (String)
|
I/O
|
Boolean
|
|
Emission Fractions
|
emissionsFracs_VID
|
Component Name (String)
|
I/O
|
Double
|
3. Variables used in Functions: GetOperVarVal3 / SetOperVarVal3
|
Variable (val)
|
Variable ID (varID)
|
Variable
Type
|
Extra arg.
(val2) and
type
|
Extra arg.
(val3) and
type
|
I/O
|
|
Ingredient Amount not Inputted through Streams
|
nonStreamIngredientUse_VID
|
Double
|
Ingredient
Name (String)
|
Resource
UseTimeRef
|
O
|
|
Ingredient Amount Used through Streams
|
streamIngredientUse_
VID
|
Double
|
Ingredient
Name (String)
|
Resource
UseTimeRef
|
O
|
|
Labor Need Amount
|
laborNeed_VID
|
Double
|
Labor Name (String)
|
Service Name (String)
|
I/O
|
See also, Resource Use Time Reference.
4. Operation Specific Variables for variables used in operations equipment.
Process Time Calculation Mode
Process Time Calculation Mode values that can be retrieved with processTimeCalcMode_VID:
|
Value (Long)
|
Meaning
|
|
1
|
Process Time is Set by the User
|
|
2
|
Process Time is Calculated from another parameter such as flowrate, volume, throughput, flux, etc depending on the operation
|
|
3
|
Process Time is set by a Master-Slave Relationship (it depends on another operation in the same procedure or another operation in another procedure)
|
|
4
|
Process Time is calculated based on the Mass flowrate (when retrieving data from operation such as Charge, Transfer In/Out, Pull In/Out, etc)
|
|
5
|
Process Time is calculated based on the Volumetric flowrate (when retrieving data from operations such as Charge, Transfer In/Out, Pull In/Out, etc)
|
|
9
|
Process Time is set by a sequence of other operations
|
Power Calculation Mode
Power Calculation Mode Values that can be retrieved with powerCalcMode_VID:
|
Value (Long)
|
Meaning
|
|
1
|
Power is Set by the User
|
|
2
|
Power is set from the Specific Power
|
|
3
|
Power is set by the Simulation Output
|
|
4
|
None of the above
|
Thermal Mode
Thermal Calculation Mode Values that can be set or retrieved with thermalMode_VID:
|
Value (Long)
|
Meaning
|
|
1
|
Set Final Temperature or Isothermal Mode
|
|
2
|
Adiabatic Mode
|
|
3
|
Set Duty Mode (Set the Heating or Cooling Duty)
|
Stream Variables
Variables for functions: GetStreamVarVal / SetStreamVarVal
● for any Stream
|
Variable
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Stream Temperature
|
temperature_VID
|
O
|
Double
|
|
Stream Pressure
|
pressure_VID
|
O
|
Double
|
|
Stream Price
|
streamPrice_VID
|
I/O
|
Double
|
|
User Comments
|
comments_VID
|
I/O
|
String
|
|
Stream Activity
|
activity_VID
|
O
|
Double
|
|
Stream Mass Flow
|
massFLow_VID
|
O
|
Double
|
|
Stream Volumetric Flow
|
volFLow_VID
|
O
|
Double
|
|
Specified Compnent Molecular Weight
|
mw_VID
|
O
|
Double
|
|
Specified component mass flow in stream
|
componentMassFlow_VID
|
O
|
Double
|
|
Specified component mass fraction in stream
|
compMassFrac_VID
|
O
|
Double
|
|
Specified component mole flow in stream
|
componentMoleFlow_VID
|
O
|
Double
|
|
Specified component mole fraction in stream
|
componentMoleFrac_VID
|
O
|
Double
|
|
Specified component extra cellular fraction in stream
|
compExtraCellFrac_VID
|
O
|
Double
|
|
Specified component vapor fraction in stream
|
compVaporFrac_VID
|
O
|
Double
|
|
Specified ingredient (pure component/mixture) mass concentration in stream
|
compMassConc_VID
|
O
|
Double
|
|
Specified ingredient (pure component/mixture) mole concentration in stream
|
compMolConc_VID
|
O
|
Double
|
|
Enthalpy of Stream
|
enthalpy_VID
|
O
|
Double
|
|
Specific Enthalpy of Stream
|
specificEnthalpy_VID
|
O
|
Double
|
|
Heat Capacity of Stream
|
Cp_VID
|
O
|
Double
|
|
Check if a stream is an input stream (no source UP)
|
isInputStream_VID
|
O
|
Boolean
|
|
Check if a stream is an output stream (no destination UP)
|
isOutputStream_VID
|
O
|
Boolean
|
|
Is it a “Raw Material”?
|
isRawMaterial_VID
|
O
|
Boolean
|
|
Is it a “Cleaning Agent”?
|
isCleaingAgent_VID
|
O
|
Boolean
|
|
Is it a “Main Revenue:?
|
isMainRevenue_VID
|
I/O
|
Boolean
|
|
Is it a “Revenue”?
|
isRevenue_VID
|
I/O
|
Boolean
|
|
Is it a “Waste”?
|
isWaste_VID
|
O
|
Boolean
|
|
Is it a “Solid Waste”?
|
isSolidWaste_VID
|
O
|
Boolean
|
|
Is it an “Aqueous Waste”?
|
isAqueousWaste_VID
|
O
|
Boolean
|
|
Is it an “organic Waste”?
|
isOrganicWaste_VID
|
O
|
Boolean
|
|
Is it an “Emission”?
|
isEmission_VID
|
O
|
Boolean
|
|
Is it classified as “none”?
|
isNone_VID
|
I/O
|
Boolean
|
|
Stream Classification
|
classification_VID
|
O
|
String
|
|
Waste Treatment Cost
|
wasteTreatCost_VID
|
I/O
|
Double
|
|
Source Procedures Name
|
sourceProcesureName_VID
|
O
|
String
|
|
Destination Procedure Name
|
destinationProcedureName_VID
|
O
|
String
|
● (input, intermediate or output):
● for Input Streams:
|
Variable
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Stream Temperature
|
temperature_VID
|
I/O
|
Double
|
|
Stream Pressure
|
pressure_VID
|
I/O
|
Double
|
|
Stream Price
|
streamPrice_VID
|
I/O
|
Double
|
|
Stream Activity
|
activity_VID
|
O
|
Double
|
|
Stream mass flow
|
massFlow_VID
|
I/O
|
Double
|
|
Stream volumetric flow
|
volFlow_VID
|
I/O
|
Double
|
|
Component Molecular Weight
|
mw_VID
|
O
|
Double
|
|
Specified ingredient (pure component/mixture) mass flow in stream
|
componentMassFlow_VID
|
I/O
|
Double
|
|
Specified ingredient (pure component/mixture) mass fraction in stream
|
compMassFrac_VID
|
I/O
|
Double
|
|
Specified ingredient (pure component/mixture) mole flow in stream
|
componentMoleFlow_VID
|
I/O
|
Double
|
|
Specified ingredient (pure component/mixture) mole fraction in stream
|
componentMoleFrac_VID
|
I/O
|
Double
|
|
Specified ingredient (pure component/mixture) extra cellular fraction in stream
|
compExtraCellFrac_VID
|
I/O
|
Double
|
|
Is the stream flow Auto Adjusted?
|
autoAdjust_VID
|
I/O
|
Boolean
|
|
Do we edit the ingredient fractions? (as opposed to the flows)
|
bEditIngredientFracs_VID
|
I/O
|
Boolean
|
|
Do we edit the stream mass flow? (as opposed to the stream volumetric flow)
|
bVolFlowSetByUser_VID
|
I/O
|
Boolean
|
|
Is it a “Raw Material”?
|
isRawMaterial_VID
|
I/O
|
Boolean
|
|
Is it a “Cleaning Agent”?
|
isRawMaterial_VID
|
I/O
|
Boolean
|
|
Is it classified as “none”?
|
isNone_VID
|
I/O
|
Boolean
|
|
Discrete Entity Purchase Price
|
discretePurchasePrice_VID
|
I/O
|
Double
|
|
Discrete Entity Selling Price
|
discreteSellingPrice_VID
|
I/O
|
Double
|
● for Output Streams:
|
Variable
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Is it a “Credit”?
|
isCredit_VID
|
I/O
|
Boolean
|
|
Is it a “Solid Waste”?
|
isSolidWaste_VID
|
I/O
|
Boolean
|
|
Is it an “Aqueous Waste”?
|
isAqueousWaste_VID
|
I/O
|
Boolean
|
|
Is it an “Organic Waste”?
|
isOrganicWaste_VID
|
I/O
|
Boolean
|
|
Is is an “Emission”?
|
IsEmission_VID
|
I/O
|
Boolean
|
|
Discrete Entity Selling Price
|
discreteSellingPrice_VID
|
I/O
|
Double
|
Ingredient Variables
Variables for functions: GetIngredientVarVal / SetIngredientVarVal
|
Variable
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Pruchase Price
|
purchasePrice_VID
|
I/O
|
Double
|
|
Selling Price
|
sellingPrice_VID
|
O
|
Double
|
|
Waste Treatment Cost
|
wasteTreatCost_VID
|
I/O
|
Double
|
|
User Comments
|
comments_VID
|
I/O
|
String
|
|
Formal Name
|
componentName_VID
|
O
|
String
|
|
Trade Name
|
tradeName_VID
|
I/O
|
String
|
|
Formula
|
formula_VID
|
I/O
|
String
|
|
CAS Number
|
CAS_Number_VID
|
I/O
|
String
|
|
Compny ID
|
companyID_VID
|
I/O
|
String
|
|
Molecular Weight
|
mw_VID
|
I/O
|
Double
|
|
Enthalpy of Formation
|
enthalpyOfFormation_VID
|
I/O
|
Double
|
|
Normal Boilong Point
|
boilingPoint_VID
|
I/O
|
Double
|
|
Normal Freezing Point
|
freezingPoint_VID
|
I/O
|
Double
|
|
Critical Temperature
|
criticalT_VID
|
I/O
|
Double
|
|
Critical Pressure
|
criticalP_VID
|
I/O
|
Double
|
|
Compressibility Factor
|
compressilibilityF_VID
|
I/O
|
Double
|
|
Acentric Factor (Omega)
|
acentricF_VID
|
I/O
|
Double
|
|
Henry’s Constant
|
henryC_VID
|
I/O
|
Double
|
|
Particle Size
|
particleSize_VID
|
I/O
|
Double
|
|
Default Volumetric Coefficient
|
defVolumetricC_VID
|
I/O
|
Double
|
|
Liquid/Solid Density Coefficient A
|
liqSolDensityCoeffA_VID
|
I/O
|
Double
|
|
Liquid/Solid Density Coefficient B
|
liqSolDensityCoeffB_VID
|
I/O
|
Double
|
|
Oxidation State (Valency)
|
oxidationState_VID
|
I/O
|
Double
|
Pure Components:
Stock Mixtures:
|
Variable
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Pruchase Price
|
purchasePrice_VID
|
I/O
|
Double
|
|
User Comments
|
comments_VID
|
I/O
|
String
|
|
Formal Name
|
componentName_VID
|
O
|
String
|
|
Trade Name
|
tradeName_VID
|
I/O
|
String
|
|
Liquid/Solid Density Coefficient A
|
liqSolDensityCoeffA_VID
|
I/O
|
Double
|
|
Liquid/Solid Density Coefficient B
|
liqSolDensityCoeffB_VID
|
I/O
|
Double
|
Ingredient Inventory variables:
|
Variable
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Inventory Supply Rate
|
invSupplyRate_VID
|
I/O
|
Double
|
|
Inventory Supply Start Time
|
invSupplyStartTime_VID
|
I/O
|
Double
|
|
Inventory Capacity
|
invCapacity_VID
|
I/O
|
Double
|
|
Inventory Initial Contents
|
invInitialContents_VID
|
I/O
|
Double
|
Heat Transfer Agent Variables
Variables for functions: GetHXAgentVarVal / SetHXAgentVarVal
|
Variable
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Price
|
hxAgentPrice_VID
|
I/O
|
Double
|
|
If True the price is in $/kg else it is in $/kcal
|
isPriceQuantityBased_VID
|
I/O
|
Boolean
|
|
Mass-to-Energy Factor
|
massToEnergyF_VID
|
I/O
|
Double
|
|
User Comments
|
comments_VID
|
I/O
|
String
|
|
Inventory Supply Rate
|
invSupplyRate_VID
|
I/O
|
Double
|
|
Inventory Supply Start Time
|
invSupplyStartTime_VID
|
I/O
|
Double
|
|
Inventory Capacity
|
invCapacity_VID
|
I/O
|
Double
|
|
Inventory Initial Contents
|
invInitialContents_VID
|
I/O
|
Double
|
Power Type Variables
Variables for functions: GetPowerVarVal / SetPowerVarVal
|
Variable
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Purchase Price
|
purchasingPrice_VID
|
I/O
|
Double
|
|
Selling Price
|
sellingPrice_VID
|
I/O
|
Double
|
|
User Comments
|
comments_VID
|
I/O
|
String
|
Labor Type Variables
Variables for functions: GetLaborVarVal / SetLaborVarVal
|
Variable
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Basic Rate
|
basicRate_VID
|
I/O
|
Double
|
|
Benefits Factor
|
benefitsFactor_VID
|
I/O
|
Double
|
|
Operating Supplies Factor
|
suppliesFactor_VID
|
I/O
|
Double
|
|
Supervision Factor
|
supervisionFactor_VID
|
I/O
|
Double
|
|
Administration Factor
|
administrationFactor_VID
|
I/O
|
Double
|
|
Lumped Estimate Rate
|
lumpedRate_VID
|
I/O
|
Double
|
|
Batch Processes (Labor Time Estimation)
|
directUtilFBatch_VID
|
I/O
|
Double
|
|
Continuous Processes (Labor Time Estimation)
|
directUtilFCont_VID
|
I/O
|
Double
|
|
Adjusted Basic Labor Cost Rate
|
adjBasicCostRate_VID
|
O
|
Double
|
Storage Unit Variables
Variables for functions: GetStorageUnitVarVal / SetStorageUnitVarVal
|
Variable
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Receiving Storage Unit Waste Treatment Cost
|
wasteTreatCost_VID
|
I/O
|
Double
|
|
Supply Storage Unit Material Purchase Cost
|
purchaseCost_VID
|
O
|
Double
|
Excel Tables Options/Data Link Variables
Data Link Variables
Variables for functions: Set/GetXLSLinkDataForStreamSummaryTable, Set/GetXLSLinkDataForComponentPropsTable, Set/GetXLSLinkDataForEquipmentContentsTable, Set/GetXLSLinkDataForProcedureOperSeqTable
|
Variable
|
Variable ID (varID)
|
I/O
|
Data Type
|
|
Name of Excel workbook for the link
|
workbook_VID
|
I/O
|
String
|
|
Name of Excel range for the link
|
rangeName_VID
|
I/O
|
String
|
|
Auto-update values?
|
bAutoUpdate_VID
|
I/O
|
Boolean
|
|
Expand (range) cell area to fit data if necessary?
|
bExpandExtraCellArea_VID
|
I/O
|
Boolean
|
|
Erase extra (range) cell area if data array is smaller than cell area?
|
bEraseExtraCellArea_VID
|
I/O
|
Boolean
|
|
Include column headers at the top of each column?
|
bIncludeColumnHeaders_VID
|
I/O
|
Boolean
|
|
Include row headers at the beginning of each row?
|
bIncludeRowHeaders_VID
|
I/O
|
Boolean
|
|
Carry over styles of the tables?
|
bIncludeStyles_VID
|
I/O
|
Boolean
|
Options Variables
1. Variables for functions: Set/GetOptionsForEquipmentContentsTable(equipName As String, VarID As VarID, val), Set/GetOptionsForStreamSummaryTable(VarID As VarID, val)
|
Variable
|
Variable ID (varID)
|
Data Type
|
Units Type
|
|
Total Mass
|
totalMassUnits_VID
|
Long
|
Mass
|
|
Temperature
|
temperatureUnits_VID
|
Long
|
Temperature
|
|
Pressure
|
pressureUnits_VID
|
Long
|
Pressure
|
|
Liquid/Solid Mass
|
liquidSolidMassUnits_VID
|
Long
|
Mass
|
|
Liquid/Solid Volume
|
liquidSolidVolUnits_VID
|
Long
|
Volume
|
|
Liquid/Solid Density
|
liquidSolidDensityUnits_VID
|
Long
|
Density
|
|
Total Mass Contents
|
totalMassContentsUnits_VID
|
Long
|
Mass/Fraction
|
|
Liquid/Solid Mass Contents
|
liquidSolidMassContentsUnits_VID
|
Long
|
Mass/Fraction
|
|
Vapor Mass Contents
|
gasMassContentUnits_VID
|
Long
|
Mass/Fraction
|
|
Liquid/Solid Heat Capacity
|
liquidSolidCpUnits_VID
|
Long
|
Heat Capacity
|
2. Variables for functions: Set/GetOptionsForProcOperationSequenceTable(procName As String, VarID As VarID, val)
|
Variable
|
Variable ID (varID)
|
Data Type
|
Units Type
|
|
Total Charge Mass
|
chargeMassUnits_VID
|
Long
|
Mass
|
|
Charge Liquid/Solid Mass
|
chargeLiquidSolidMassUnits_VID
|
Long
|
Mass
|
|
Charge Liquid/Solid Density
|
chargeLiquidSolidDensityUnits_VID
|
Long
|
Density
|
|
Charge Liquid/Solid Volume
|
chargeLiquidSolidVolUnits_VID
|
Long
|
Volume
|
|
Charge Temperature
|
chargeTemperatureUnits_VID
|
Long
|
Temperature
|
|
Charge Pressure
|
chargePressureUnits_VID
|
Long
|
Pressure
|
|
|
|
|
|
|
Contents Total Mass
|
totalMassUnits_VID
|
Long
|
Mass
|
|
Contents Liquid/Solid Mass
|
liquidSolidMassUnits_VID
|
Long
|
Mass
|
|
Contents Liquid/Solid Volume
|
liquidSolidVolUnits_VID
|
Long
|
Volume
|
|
Contents Liquid/Solid Density
|
liquidSolidDensityUnits_VID
|
Long
|
Density
|
|
Contents Temperature
|
temperatureUnits_VID
|
Long
|
Temperature
|
|
Contents Pressure
|
pressureUnits_VID
|
Long
|
Pressure
|
|
|
|
|
|
|
Duration
|
durationUnits_VID
|
Long
|
Time
|
|
Start Time
|
stratTimeUnits_VID
|
Long
|
Time
|
|
End Time
|
endTimeUnits
|
Long
|
Time
|
Note that for the value of the units variable a new Enum is now exported: the COMPQUnits Enum. For more information look at Specifying Physical Quantity Units in Tables.