CATMathStream CATSoftwareConfiguration
Usage: you must use this class as is. You should never derive it.
public class CATSoftwareConfiguration
Class defining the software configuration to be used to run a topological operator.
A configuration is a set of code modifications and a level on which the code must be run.
The protocol offered by the configuration management allows the code of an operator to be enhanced or
modified with guaranteing the upwards compatibility of the customer data.
The configuration can be stored with the customer data, and the stored configuration can be used
to specify the code to run.
Constructor and Destructor Index
- o
CATSoftwareConfiguration()
- Constructs an open configuration.
- o
CATSoftwareConfiguration(char*,int,int)
- Constructs a closed configuration.
Method Index
- o
AddModification(CATSoftwareModification&)
- Adds a modification to a configuration.
- o
AddRef()
- Increments the reference count for the given interface.
- o
Dump(ostream&)
- Dumps the content of the config.
- o
GetLevelFromIID(IID&,short&)
- Returns the level of a modification of this configuration.
- o
GetModificationLevel(CATSoftwareModification&)
- Returns the level of a modification of this configuration.
- o
IsSupported()
- Tests whether this configuration is supported for the current software.
- o
Release()
- Decrements the reference count for the given interface.
- o
Stream(char*&,int&,int)
- Creates the stream representing this configuration.
Constructor and Destructor
o CATSoftwareConfiguration
| public CATSoftwareConfiguration( | ) |
-
Constructs an open configuration.
To use for running with the current configuration.
o CATSoftwareConfiguration
| public CATSoftwareConfiguration( | const | iStreamBuffer, |
| | iLength, |
| | iConvert | =0) |
-
Constructs a closed configuration.
To use if the input of the algorithm has been previously stored.
- Parameters:
-
- iStreamBuffer
- The pointer to the stream.
- iLength
- The length of the stream.
- iConvert
- Internal use. Use the 0 default value.
Methods
o AddModification
| public AddModification( | const | iModification) |
-
Adds a modification to a configuration.
- Parameters:
-
- iModification
- The given (code) modification identified by its IID and its code level.
o AddRef
-
Increments the reference count for the given interface.
- Returns:
- The reference count value.
This information is meant to be used for diagnostic/testing purposes only, because, in certain situations, the value may be unstable.
o Dump
-
Dumps the content of the config. ONLY FOR INTERNAL USE
o GetLevelFromIID
| public GetLevelFromIID( | const | iModifIID, |
| | ioLevel) |
-
Returns the level of a modification of this configuration.
- Parameters:
-
- iModifIID
- The given (code) modification identified by IID.
- ioLevel
- The level of a modification.
- Returns:
- Determines if the modification has been found.
Legal values:
1 if iModifIID found on this, 0 otherwise.
o GetModificationLevel
| public GetModificationLevel( | const | iModification) |
-
Returns the level of a modification of this configuration.
- Parameters:
-
- iModification
- The given (code) modification
- Returns:
- The version (or level) of the modification. If the configuration is "open", the version is the
current level of the software. If the configuration is "closed" and not known, the version is 0.
o IsSupported
-
Tests whether this configuration is supported for the current software.
- Returns:
- The result of the test.
Legal values:
- 1
- The configuration is valid
- 0
- The configuration is not valid:
- The modification is known, but the level is not supported
- The modification is unknown
o Release
-
Decrements the reference count for the given interface.
- Returns:
- The reference count value.
This information is meant to be used for diagnostic/testing purposes only, because, in certain situations, the value may be unstable.
o Stream
| public Stream( | | oStreamBuffer, |
| | oLength, |
| | iConvert | =0) |
-
Creates the stream representing this configuration.
- Parameters:
-
- oStreamBuffer
- The pointer to the created stream.
- oLength
- The length to the created stream.
- iConvert
- Internal use. Use the 0 default value.
This object is included in the file: CATSoftwareConfiguration.h
If needed, your Imakefile.mk should include the module: CATMathStream
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.