Cape
Classes
| BaseUnitEditor | Base class for a unit operation editor. |
| BooleanParameter | Boolean-Valued parameter for use in the CAPE-OPEN parameter collection. |
| CapeAboutAttribute | Provides text about information for the registration of a CAPE-OPEN object. |
| CapeBadArgumentException | An argument value of the operation is not correct. |
| CapeBadCOParameter | A parameter, which is an object from the Parameter Common Interface, has an invalid status. |
| CapeBadInvOrderException | The necessary pre-requisite operation has not been called prior to the operation request. |
| CapeBoundariesException | This is an abstract class that allows derived classes to provide information about error that result from values that are outside of their bounds. It can be raised to indicate that the value of either a method argument or the value of a object parameter is out of range. |
| CapeComputationException | The base class of the errors hierarchy related to calculations. |
| CapeConsumesThermoAttribute | Provides information regarding whether the object consumes Thermodynamics during registration of a CAPE-OPEN object. |
| CapeDataException | The base class of the errors hierarchy related to any data. |
| CapeDescriptionAttribute | Provides a text description for the registration of a CAPE-OPEN object. |
| CapeFailedInitialisationException | This exception is thrown when necessary initialisation has not been performed or has failed. |
| CapeFlowsheetMonitoringAttribute | Provides information regarding whether the object consumes Thermodynamics during registration of a CAPE-OPEN object. |
| CapeHelpURLAttribute | Provides a help URL for the registration of a CAPE-OPEN object. |
| CapeHessianInfoNotAvailableException | Exception thrown when the Hessian for the MINLP problem is not available. |
| CapeIdentification | Provides methods to identify and describe a CAPE-OPEN component. |
| CapeIllegalAccessException | The access to something within the persistence system is not authorised. |
| CapeImplementationException | The base class of the errors hierarchy related to the current implementation. |
| CapeInvalidArgumentException | An invalid argument value was passed. For instance the passed name of the phase does not belong to the CO Phase List. |
| CapeInvalidOperationException | This operation is not valid in the current context. |
| CapeLicenceErrorException | An operation can not be completed because the licence agreement is not respected. |
| CapeLimitedImplException | The limit of the implementation has been violated. |
| CapeNameAttribute | Provides a text name for the registration of a CAPE-OPEN object. |
| CapeNoImplException | An exception class that indicates that the requested operation has not been implemented by the current object. |
| CapeNoMemoryException | An exception class that indicates that the memory required for this operation is not available. |
| CapeObjectBase | Abstract base class that implements ICapeIdentification and ICapeUtilities. |
| CapeOutOfBoundsException | An argument value is outside of the bounds.. |
| CapeOutOfResourcesException | An exception class that indicates that the resources required by this operation are not available. |
| CapeParameter | Base Class defining the actual Parameter quantity. |
| CapePersistenceException | An exception class that indicates that the a persistence-related error has occurred. |
| CapePersistenceNotFoundException | An exception class that indicates that the persistence was not found. |
| CapePersistenceOverflowException | An exception class that indicates an overflow of internal persistence system. |
| CapePersistenceSystemErrorException | An exception class that indicates a severe error occurred within the persistence system. |
| CapeSolvingErrorException | An exception class that indicates a numerical algorithm failed for any reason. |
| CapeSupportsThermodynamics10Attribute | Provides information regarding whether the object supports Thermodynamics version 1.0 during registration of a CAPE-OPEN object. |
| CapeSupportsThermodynamics11Attribute | Provides information regarding whether the object supports Thermodynamics version 1.0 during registration of a CAPE-OPEN object. |
| CapeThermoMaterialWrapper | A wrapper class for the ICapeThermoMaterial interface. |
| CapeThermoSystem | A class that implements the ICapeThermoSystem interface and provides access to COM and .Net-based property packages available on the current computer. |
| CapeThrmPropertyNotAvailableException | Exception thrown when a requested theromdynamic property is not available. |
| CapeTimeOutException | Exception thrown when the time-out criterion is reached. |
| CapeUnexpectedException | This exception is raised when other error(s), specified by the operation, do not suit. |
| CapeUnitBase | Abstract base class to be used to develop unit operation models. |
| CapeUnknownException | This exception is raised when other error(s), specified by the operation, do not suit. |
| CapeUserException | This is the abstract base class for all .Net based CAPE-OPEN exception classes. |
| CapeVendorURLAttribute | Provides a vendor URL for the registration of a CAPE-OPEN object. |
| CapeVersionAttribute | Provides the CAPE-OPEN version number for the registration of a CAPE-OPEN object. |
| COMCapeOpenExceptionWrapper | A wrapper class for COM-based exceptions. |
| COMExceptionHandler | A helper class for handling exceptions from COM-based CAPE-OPEN components. |
| DescriptionChangedEventArgs | Provides data for the CapeIdentification.ComponentDescriptionChanged event. |
| IntegerParameter | Intger-Valued parameter for use in the CAPE-OPEN parameter collection. |
| MaterialObjectWrapper | Wrapper class for COM-based CAPE-OPEN ICapeThermoMaterialObject material object. |
| MixerExample | This is a mixer eample class that models an adiabtic mixer. |
| MixerExample110 | This is a mixer eample class that models an adiabtic mixer. |
| NameChangedEventArgs | Provides data for the CapeIdentification.ComponentNameChanged event. |
| OptionParameter | String Parameter class that implements the ICapeParameter and ICapeOptionParameterSpec CAPE-OPEN interfaces. |
| ParameterCollection | A type-safe collection of ICapeParameter objects. |
| ParameterDefaultValueChangedEventArgs | Provides data for the value changed event associated with the parameters. |
| ParameterLowerBoundChangedEventArgs | Provides data for the value changed event associated with the parameters. |
| ParameterModeChangedEventArgs | Provides data for the mode changed event associated with the parameters. |
| ParameterOptionListChangedEventArgs | The parameter option list was changed. |
| ParameterResetEventArgs | The parameter was reset. |
| ParameterRestrictedToListChangedEventArgs | The parameter restiction to the option list was changed. |
| ParameterUpperBoundChangedEventArgs | Provides data for the upper bound changed event associated with the parameters. |
| ParameterValidatedEventArgs | The parameter was validated. |
| ParameterValueChangedEventArgs | Provides data for the value changed event associated with the parameters. |
| PortCollection | A type-safe collection of ICapePort objects. |
| PortConnectedEventArgs | An object was connected to the port. |
| PortDisconnectedEventArgs | The port was disconnected. |
| RealParameter | Real-Valued parameter for use in the CAPE-OPEN parameter collection. |
| UnitOperationBeginCalculationEventArgs | Event fired at the start of a unit operation was calculation. |
| UnitOperationCalculateEventArgs | Event fired at the start of a unit operation was calculation. |
| UnitOperationEndCalculationEventArgs | The unit operation was validated. |
| UnitOperationValidatedEventArgs | The unit operation was validated. |
| UnitOperationWrapper | This class provides access to unit operations based upon .Net-based assembly location rules. |
| UnitPort | This class represents the behaviour of a Unit Operation connection point (Unit Operation Port). It provides different attributes for configuring the port as well as to connect it to a material, energy or information object. |
| UnitSelector | The unit selector class provides a graphical user interface (GUI) for the UnitOperationWrapper class. |
| WARAddIn | Summary for WAR |
| WARalgorithm | Performs US EPA Waste Reduction (WAR) algorithm calculation on a flowsheet accessed using the ICapeFlowsheetMonitoring interface. |
Interfaces
| ECapeBadArgument | An invalid argument value was passed. |
| ECapeBadArgument093 | An invalid argument value was passed. |
| ECapeBadCOParameter | A parameter, which is an object from the Parameter Common Interface, has an invalid status. |
| ECapeBadInvOrder | The necessary pre-requisite operation has not been called prior to the operation request. |
| ECapeBoundaries | This interface provides information about error that result from values that are outside of their bounds. It can be raised to indicate that the value of either a method argument or the value of a object parameter is out of range. |
| ECapeComputation | The base interface of the errors hierarchy related to calculations. |
| ECapeData | The base interface for the errors hierarchy related to any data. |
| ECapeErrorDummy | The ECapeErrorDummy interface is not intended to be used. |
| ECapeFailedInitialisation | This exception is thrown when necessary initialisation has not been performed or has failed. |
| ECapeHessianInfoNotAvailable | Exception thrown when the Hessian for the MINLP problem is not available. |
| ECapeIllegalAccess | The access to something within the persistence system is not authorised. |
| ECapeImplementation | The base class of the errors hierarchy related to the current implementation. |
| ECapeInvalidArgument | An invalid argument value was passed. For instance the passed name of the phase does not belong to the CO Phase List. |
| ECapeInvalidOperation | This operation is not valid in the current context. |
| ECapeLicenceError | An operation can not be completed because the licence agreement is not respected. |
| ECapeLimitedImpl | The limit of the implementation has been violated. |
| ECapeNoImpl | An exception that indicates that the requested operation has not been implemented by the current object. |
| ECapeNoMemory | An exception that indicates that the memory required for this operation is not available. |
| ECapeOutOfBounds | An argument value is outside of the bounds.. |
| ECapeOutOfResources | An exception that indicates that the resources required by this operation are not available. |
| ECapeOutsideSolverScope | Exception thrown when the problem is outside the scope of the solver. |
| ECapePersistence | An exception that indicates that the a persistence-related error has occurred. |
| ECapePersistenceNotFound | An exception that indicates that the persistence was not found. |
| ECapePersistenceOverflow | An exception that indicates an overflow of internal persistence system. |
| ECapePersistenceSystemError | An exception that indicates a severe error occurred within the persistence system. |
| ECapeRoot | The root CAPE-OPEN Exception interface. |
| ECapeSolvingError | An exception that indicates a numerical algorithm failed for any reason. |
| ECapeThrmPropertyNotAvailable | An exception that indicates the requested thermodynamic property was not available. |
| ECapeTimeOut | Exception thrown when the time-out criterion is reached. |
| ECapeUnknown | This exception is raised when other error(s), specified by the operation, do not suit. |
| ECapeUser | The base interface of the CO errors hierarchy. |
| IATCapeXRealParameterSpec | Aspen interface for providing dimension for a real-valued parameter. |
| IBooleanParameterSpecEvents | |
| ICapeArrayParameterSpec | This interface is for a parameter specification when the parameter is an array of values (maybebe integers,reals, booleans or arrays again, which represents. |
| ICapeBooleanParameterSpec | This interface is for a parameter specification when the parameter is a boolean |
| ICapeCollection | This interface provides the behaviour for a read-only collection. It can be used for storing ports or parameters. |
| ICapeCollectionEvents | |
| ICapeCOSEUtilities | Provides a mechanism for the PMC to obtain a free FORTRAN channel from the PME. |
| ICapeDiagnostic | Provides a mechanism to provide verbose messages to the user. |
| ICapeElectrolyteReactionContext | Provides access to the properties of a set of electrolyte reactions. |
| ICapeFlowsheetMonitoring | This interface provides information about error that result from values that are outside of their bounds. It can be raised to indicate that the value of either a method argument or the value of a object parameter is out of range. |
| ICapeFlowsheetMonitoringOld | This interface provides information about error that result from values that are outside of their bounds. It can be raised to indicate that the value of either a method argument or the value of a object parameter is out of range. |
| ICapeIdentification | Provides methods to identify and describe a CAPE-OPEN component. |
| ICapeIdentificationEvents | Provides methods to identify and describe a CAPE-OPEN component. |
| ICapeIntegerParameterSpec | This interface is for a parameter specification when the parameter is an integer value. |
| ICapeKineticReactionContext | Provides access to the properties of a set of kinetic reactions. |
| ICapeMaterialTemplateSystem | Creates a new thermo material template of the specified type. |
| ICapeOptionParameterSpec | This interface is for a parameter specification when the parameter is an option, which represents a list of strings from which one is selected. |
| ICapeParameter | Interface defining the actual Parameter quantity. |
| ICapeParameterEvents | |
| ICapeParameterSpec | |
| ICapePetroFractions | ICapePetroFractions interface Provides methods to identify a CAPE-OPEN component. |
| ICapeReactionChemistry | Provides information about the reactions in the reaction package. |
| ICapeReactionProperties | Provides access to the properties of a particular reaction. |
| ICapeReactionsPackageManager | Similar in scope to the ICapeThermoSystem. These interfaces will be implemented by a Reactions Package Manager component. |
| ICapeReactionsRoutine | Calculates the values of reaction (or reaction related) properties. |
| ICapeRealParameterSpec | This interface is for a parameter specification when the parameter has a double-precision floating point value. |
| ICapeSimulationContext | Encloses the diagnostic functionality. |
| ICapeThermoCalculationRoutine | ICapeThermoCalculationRoutine is a mechanism for adding foreign calculation routines to a physical property package. |
| ICapeThermoCompounds | When implemented by a Property Package, this interface is used to access the list of Compounds that the Property Package can deal with, as well as the Compounds Physical Properties. When implemented by a Material Object, the interface is used for the same purpose but is applied to the Compounds present in the Material. |
| ICapeThermoContext | Provides a material object for physical property calculations. |
| ICapeThermoEquilibriumRoutine | Implemented by any component or object that can perform an Equilibrium Calculation. |
| ICapeThermoEquilibriumServer | ICapeThermoCalculationRoutine interface is the mechanism for adding foreign calculation routines to a physical property package. |
| ICapeThermoMaterial | A Material Object is a container of information that describes a Material stream. Calculations of thermophysical and thermodynamic properties are performed by a Property Package using information stored in a Material Object. Results of such calculations may be stored in the Material Object for further usage. The ICapeThermoMaterial interface provides the methods to gather information and perform checks in preparation for a calculation, to request a calculation and to retrieve results and information stored in the Material Object. |
| ICapeThermoMaterialContext | This interface should be implemented by all Thermodynamic and Physical Properties components that need an ICapeThermoMaterial interface in order to set and get a Material’s property values. |
| ICapeThermoMaterialObject | Material object interface |
| ICapeThermoMaterialTemplate | Material Template interface |
| ICapeThermoPhases | Provides information about the number and types of Phases supported by the component that implements it. |
| ICapeThermoPropertyPackage | Interface implemented by a CAPE-OPEN version 1.0 Physical Property Package. |
| ICapeThermoPropertyPackageManager | The ICapeThermoPropertyPackageManager interface should only be implemented by a Property Package Manager component. This interface is used to access the Property Packages managed by such a component. |
| ICapeThermoPropertyRoutine | |
| ICapeThermoReliability | Interface for the reliability of the Thermo Object. |
| ICapeThermoSystem | Interface that provides access to property packages supported by a Thermodynamics Package. |
| ICapeThermoUniversalConstant | Implemented by a component that can return the value of a Universal Constant. |
| ICapeUnit | This interface handles most of the interaction with the Flowsheet Unit. |
| ICapeUnitPort | This interface represents the behaviour of a Unit Operation connection point (Unit Operation Port). It provides different attributes for configuring the port as well as to connect it to a material, energy or information object. |
| ICapeUnitPortVariables | Port variables for equation-oriented simulators. |
| ICapeUnitReport | This interface provides access to the active unit report and the available list of options. |
| ICapeUtilities | Interface that exposes a PMC's parameters, controls the PMC's lifecycle, provides access to the PME through the simulation context, and provides a means for the PME to edit the PMC. |
| IDescriptionChangedEventArgs | Event thrown to indicate that the description of a component has changed. |
| IIntegerParameterSpecEvents | |
| INameChangedEventArgs | Event thrown to indicate that the name of a component has changed. |
| IOptionParameterSpecEvents | |
| IParameterDefaultValueChangedEventArgs | Provides data for the value changed event associated with the parameters. |
| IParameterLowerBoundChangedEventArgs | Provides data for the value changed event associated with the parameters. |
| IParameterModeChangedEventArgs | Provides data for the mode changed event associated with the parameters. |
| IParameterOptionListChangedEventArgs | The parameter was reset. |
| IParameterResetEventArgs | The parameter was reset. |
| IParameterRestrictedToListChangedEventArgs | The restiction to the options list of a parameter was changed. |
| IParameterUpperBoundChangedEventArgs | Provides data for the upper bound changed event associated with the parameters. |
| IParameterValidatedEventArgs | The parameter was validated. |
| IParameterValueChangedEventArgs | Provides data for the value changed event associated with the parameters. |
| IPortConnectedEventArgs | An object was connected to the port. |
| IPortDisconnectedEventArgs | The port was disconnected. |
| IRealParameterSpecEvents | |
| IUnitOperationBeginCalculationEventArgs | Event fired at the start of a unit operation was calculation. |
| IUnitOperationCalculateEventArgs | Event fired at the start of a unit operation was calculation. |
| IUnitOperationEndCalculationEventArgs | The unit operation calculation prcess has been completed. |
| IUnitOperationValidatedEventArgs | The unit operation was validated. |
| IUnitPortEvents |
Delegates
| CollectionAddingNewHandler | Represents the method that will handle the changing the name of a component. |
| CollectionDisposedHandler | Represents the method that will handle the disposal of a collection. |
| CollectionListChangedHandler | Represents the method that will handle the changing the name of a component. |
| ComponentDescriptionChangedHandler | Represents the method that will handle the changing of the description of a component. |
| ComponentNameChangedHandler | Represents the method that will handle the changing the name of a component. |
| EquilibriumReactionsChangedHandler | Represents the method that will handle the changing of the Equilibrium Reaction Chemistry of a PMC. |
| KineticReactionsChangedHandler | Represents the method that will handle the changing of the Kinetic Reaction Chemistry of a PMC. |
| ParameterDefaultValueChangedHandler | Represents the method that will handle the changing of the default value of a parameter. |
| ParameterLowerBoundChangedHandler | Represents the method that will handle the changing of the lower bound of a parameter. |
| ParameterModeChangedHandler | Represents the method that will handle the changing of the mode of a parameter. |
| ParameterOptionListChangedHandler | Represents the method that will handle the changing of the option list of a parameter. |
| ParameterResetHandler | Represents the method that will handle the resetting of a parameter. |
| ParameterRestrictedToListChangedHandler | Represents the method that will handle the changing of whether a paratemer's value is restricted to those in the option list. |
| ParameterUpperBoundChangedHandler | Represents the method that will handle the changing of the upper bound of a parameter. |
| ParameterValidatedHandler | Represents the method that will handle the validation of a parameter. |
| ParameterValueChangedHandler | Represents the method that will handle the changing of the value of a parameter. |
| PortConnectedHandler | Represents the method that will handle connecting an object to a unit port. |
| PortDisconnectedHandler | Represents the method that will handle disconnecting an object from a unit port. |
| PropertyPackageChangedHandler | Represents the method that will handle the changing of a property package used in a PMC. |
| SimulationContextChangedHandler | Represents the method that will handle the changing of the simualtion context of a PMC. |
| UnitOperationBeginCalculationHandler | Represents the method that will handle the beginning of a calculation of a unit operation. |
| UnitOperationCalculateHandler | Represents the method that will handle the beginning of a calculation of a unit operation. |
| UnitOperationEndCalculationHandler | Represents the method that will handle the completion of a unit operation calculation process. |
| UnitOperationValidatedHandler | Represents the method that will handle the validation of a unit operation. |
Enumerations
| CapeCalculationCode | A flag that indicates the desired calculations for the ICapeThermoPropertyRoutine.CalcAndGetLnPhi method. |
| CapeCompoundType | The type of compound for use in petroleum fractions |
| CapeErrorInterfaceHR | Enumeration of the various HRESULT values for the CAPE-OPEN error handling interfaces. |
| CapeParamMode | Modes of parameters. |
| CapeParamType | Gets the type of the parameter for which this is a specification: |
| CapePhaseStatus | Status of the phases present in the material object. |
| CapePortDirection | The direction that objects or information connected to the port is expected to flow (e.g. material, energy or information objects). |
| CapePortType | The type of objects or information that can flow into the unit operation from the connected object. |
| CapeReactionRateBasis | Enumeration for the rate basis for the reaction. |
| CapeReactionType | Enumeration for the type of reaction. |
| CapeSolutionStatus | Indicates solution status of the monitored flowsheet. |
| CapeValidationStatus | Enumeration flag to indicate parameter validation status. |