All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface CATICfgSpecInclusion
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICfgSpecInclusion
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICfgSpecInclusion
Interface for Specification Inclusion
Specify a list of specifications to be included if the condition is true
Method Index
- o
Attach(SEQUENCE(octet)&)
- Attaches a Specification Inclusion to a Configured Object.
- o
Delete()
- Deletes the Specification Inclusion.
- o
Detach(SEQUENCE(octet)&)
- Detaches a Specification Inclusion from a Configured Object.
- o
GetDescription(CATUnicodeString&)
- Gets the description of a Specification Inclusion.
- o
GetIfCondition(CATICfgORExpression_var&)
- Gets the condition of a Specification Inclusion.
- o
GetIncludedSpecification(CATListValCATICfgSimpleSpecification_var&)
- Gets the list of included
- o
GetName(CATUnicodeString&)
- Gets the name of a Specification Inclusion.
- o
GetPriority(int&)
- Gets the Specification Inclusion Priority.
- o
GetUIDList(SEQUENCE(CORBAAny)&)
- Gets the list of Configured Objects attached to a Spec Inclusion.
- o
RemoveIncludedSpecification(CATListValCATICfgSimpleSpecification_var&)
- Removes a list of included
- o
SetDescription(CATUnicodeString&)
- Sets the description of a Specification Inclusion.
- o
SetIfCondition(CATICfgORExpression_var&)
- Sets the condition of a Specification Inclusion.
- o
SetIncludedSpecification(CATListValCATICfgSimpleSpecification_var&)
- Sets the list of included
- o
SetPriority(int)
- Sets the Specification Inclusion Priority.
- o
Solve(CATListValCATICfgSimpleSpecification_var&,CATListValCATICfgSimpleSpecification_var&)
- Checks whether the condition is true or not depending on a list of Simple Specifications.
Methods
o Attach
public virtual HRESULT Attach( | SEQUENCE(octet)& | iObjectUUID) = 0 |
-
Attaches a Specification Inclusion to a Configured Object.
- Parameters:
-
- iObjectUUID
- The UUID of a configured object
o Delete
-
Deletes the Specification Inclusion.
o Detach
public virtual HRESULT Detach( | SEQUENCE(octet)& | iObjectUUID) = 0 |
-
Detaches a Specification Inclusion from a Configured Object.
- Parameters:
-
- iObjectUUID
- The UUID of a configured object
o GetDescription
-
Gets the description of a Specification Inclusion.
- Parameters:
-
- oDescription
- A
CATUnicodeString for the description
o GetIfCondition
public virtual HRESULT GetIfCondition( | CATICfgORExpression_var& | oOrExp) = 0 |
-
Gets the condition of a Specification Inclusion.
- Parameters:
-
- oOrExp
- A
CATICfgORExpression that is evaluated for the SpecInclusion
o GetIncludedSpecification
public virtual HRESULT GetIncludedSpecification( | CATListValCATICfgSimpleSpecification_var& | oList) const = 0 |
-
Gets the list of included
CATICfgSimpleSpecification.
- Parameters:
-
- oList
- The list of
CATICfgSimpleSpecification that are taken into account if the condition is true
o GetName
-
Gets the name of a Specification Inclusion.
- Parameters:
-
- oName
- A
CATUnicodeString for the name
o GetPriority
public virtual HRESULT GetPriority( | int& | oPriority) =0 |
-
Gets the Specification Inclusion Priority.
o GetUIDList
public virtual HRESULT GetUIDList( | SEQUENCE(CORBAAny)& | Ret) const = 0 |
-
Gets the list of Configured Objects attached to a Spec Inclusion.
- Parameters:
-
- oUUIDList
- The list of configurable objects currently attached
o RemoveIncludedSpecification
public virtual HRESULT RemoveIncludedSpecification( | const CATListValCATICfgSimpleSpecification_var& | iList) = 0 |
-
Removes a list of included
CATICfgSimpleSpecification.
- Parameters:
-
- iList
o SetDescription
-
Sets the description of a Specification Inclusion.
- Parameters:
-
- iDescription
- A
CATUnicodeString containing the description
o SetIfCondition
public virtual HRESULT SetIfCondition( | CATICfgORExpression_var& | iOrExp) =0 |
-
Sets the condition of a Specification Inclusion.
- Parameters:
-
- iOrExp
- A
CATICfgORExpression to be evaluated for the SpecInclusion
o SetIncludedSpecification
public virtual HRESULT SetIncludedSpecification( | CATListValCATICfgSimpleSpecification_var& | iList) const =0 |
-
Sets the list of included
CATICfgSimpleSpecification .
- Parameters:
-
- iList
- The list of
CATICfgSimpleSpecification that are taken into account if the condition is true
o SetPriority
public virtual HRESULT SetPriority( | int | iPriority)=0 |
-
Sets the Specification Inclusion Priority.
o Solve
public virtual HRESULT Solve( | CATListValCATICfgSimpleSpecification_var& | iList, |
| CATListValCATICfgSimpleSpecification_var& | oList) const =0 |
-
Checks whether the condition is true or not depending on a list of Simple Specifications.
(@see #SetIfCondition)
- Parameters:
-
- iList
- A list of
CATICfgSimpleSpecification to be checked against the condition
- oList
- The list of
CATICfgSimpleSpecification to be included if the condition is true
This object is included in the file: CATICfgSpecInclusion.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces