#include <CapeBasic.hpp>
Public Member Functions | |
| virtual | ~ICapeIdentification () |
| virtual const Common::Types::CapeString & | GetComponentName () const =0 throw (Common::Error::ECapeUnknown) |
| virtual void | SetComponentName (const Common::Types::CapeString &_name)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) |
| virtual const Common::Types::CapeString & | GetComponentDescription () const =0 throw (Common::Error::ECapeUnknown) |
| virtual void | SetComponentDescription (const Common::Types::CapeString &_description)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) |
| virtual ICapeIdentification * | clone () throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) |
| creates clone copy of the interface. This method is not abstract, and throws an exception ECapeNoImpl. | |
Friends | |
| std::ostream & | operator<< (std::ostream &out_file, const ICapeIdentification &identification) |
Detailed Description
ICapeIdentification interface will be used by those CAPE-OPEN components that wish to expose its name and description. This information refers to an instance of the component, not to the software class.
Constructor & Destructor Documentation
| virtual ~ICapeIdentification | ( | ) | [inline, virtual] |
Virtual default destructor.
Member Function Documentation
| virtual const Common::Types::CapeString& GetComponentDescription | ( | ) | const throw (Common::Error::ECapeUnknown) [pure virtual] |
gets the description of the component.
Implemented in DianaParameter, DianaArrayStringParameterSpec, DianaArrayRealParameterSpec, DianaArrayParameterSpec, SensParameterFittingTask, DianaOptionParameterSpec, DianaSensOptimizationPoint, DianaPointerParameterSpec, ICapeNLPTest, DianaBooleanParameterSpec, ParameterFittingTask, DianaOptimizationPoint, OEDOptimalityCriterion, DianaIntegerParameterSpec, SensMultipleFittingTask, ICapeNLPFunction, DianaContinuation, DianaDAESO, IDASolver, MemoryReportingInterface, DianaContinuousModel, MultipleFittingTask, CFunction, DianaCollection, BasicNLPTask, DianaRealParameterSpec, PARDASPKSolver, and DianaNLAESO.
| virtual const Common::Types::CapeString& GetComponentName | ( | ) | const throw (Common::Error::ECapeUnknown) [pure virtual] |
gets the name of the component.
Implemented in DianaParameter, DianaArrayStringParameterSpec, DianaArrayRealParameterSpec, DianaArrayParameterSpec, SensParameterFittingTask, DianaOptionParameterSpec, DianaSensOptimizationPoint, DianaPointerParameterSpec, ICapeNLPTest, DianaBooleanParameterSpec, ParameterFittingTask, DianaOptimizationPoint, OEDOptimalityCriterion, DianaIntegerParameterSpec, SensMultipleFittingTask, ICapeNLPFunction, DianaContinuation, DianaDAESO, IDASolver, MultipleFittingTask, MemoryReportingInterface, DianaContinuousModel, CFunction, BasicNLPTask, DianaCollection, DianaRealParameterSpec, PARDASPKSolver, and DianaNLAESO.
Referenced by DianaContinuation::getParameterBoundaries(), SteadyStateContinuation::GetVariableName(), HopfPointContinuation::GetVariableName(), and SingAnalyser::GetVariableName().
| virtual void SetComponentDescription | ( | const Common::Types::CapeString & | _description | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [pure virtual] |
sets the description of the component.
- Parameters:
-
_description the description of the component
Implemented in DianaParameter, DianaArrayStringParameterSpec, DianaArrayRealParameterSpec, DianaArrayParameterSpec, SensParameterFittingTask, DianaOptionParameterSpec, DianaSensOptimizationPoint, DianaPointerParameterSpec, ICapeNLPTest, DianaBooleanParameterSpec, DianaOptimizationPoint, DianaNLPTask, OEDOptimalityCriterion, DianaIntegerParameterSpec, DianaNLAESO, ICapeNLPFunction, DianaContinuation, DianaDAESO, IDASolver, MemoryReportingInterface, DianaContinuousModel, CFunction, DianaCollection, DianaRealParameterSpec, and PARDASPKSolver.
| virtual void SetComponentName | ( | const Common::Types::CapeString & | _name | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [pure virtual] |
sets the name of the component.
- Parameters:
-
_name the name of the component
Implemented in DianaParameter, DianaArrayStringParameterSpec, DianaArrayRealParameterSpec, DianaArrayParameterSpec, SensParameterFittingTask, DianaOptionParameterSpec, DianaSensOptimizationPoint, DianaPointerParameterSpec, ICapeNLPTest, DianaBooleanParameterSpec, DianaNLPTask, DianaOptimizationPoint, OEDOptimalityCriterion, DianaIntegerParameterSpec, ICapeNLPFunction, DianaContinuation, DianaDAESO, IDASolver, MemoryReportingInterface, DianaContinuousModel, CFunction, DianaCollection, DianaRealParameterSpec, PARDASPKSolver, and DianaNLAESO.
Friends And Related Function Documentation
| std::ostream& operator<< | ( | std::ostream & | out_file, |
| const ICapeIdentification & | identification | ||
| ) | [friend] |
ostream output operator for the ICapeIdentification class.
The documentation for this class was generated from the following file:
