All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface CATICfgBasicEffectivity
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICfgBasicEffectivity
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICfgBasicEffectivity
A BasicEffectivity is made of:
- One interval (range or date)
- A set of CATICfgSignedSpec_var ANDed together (see CATICfgSpecANDExpression)
Method Index
- o
AddSpec(int,CATICfgSimpleSpecification_var&)
- Add a spec to the specexp of an Effectivity
Warning: If you have several specs to add, it's better to use SetSpecExp
- o
DoesAlreadyShare(CATICfgBasicEffectivity_var&)
- Look if this or one of its ancestors shares an effectivity.
- o
GetDateInterval(CATTime&,CATTime&)
- Retrieves the value of the date interval.
- o
GetEndMilestoneName(CATUnicodeString&)
- Retrieves the end milestone name.
- o
GetIntervals(CATListValCATICfgInterval_var&)
- Retrieves the range and the date interval of an Effectivity
- o
GetRangeInterval(int&,int&)
- Retrieves the value of the range interval.
- o
GetSpecExp(CATICfgSpecANDExpression_var&)
- Retrieves the specexp of an Effectivity
- o
GetStartMilestoneName(CATUnicodeString&)
- Retrieves the start milestone name.
- o
GetTheEffectivityShared(CATICfgBasicEffectivity_var&)
- Retrieves the effectivity shared.
- o
GetTheSharingEffectivities(CATListValCATICfgBasicEffectivity_var&)
- Retrieves all the effectivities sharing this effectivity.
- o
GetUserInterval(CATUnicodeString&,CATUnicodeString&)
- Retrieves the user interval of an Effectivity
- o
SetDateInterval(CATTime&)
- Sets the value of the date interval with infinite upper bound
- o
SetDateInterval(CATTime&,CATTime&)
- Sets the value of the date interval.
- o
SetEndMilestone(CATICfgMileStone_var&)
- Sets the end milestone name
- o
SetInterval(CATICfgInterval_var&)
- Sets the range or the date interval of an Effectivity
- o
SetRangeInterval(int&)
- Sets the value of the range interval with infinite upper bound.
- o
SetRangeInterval(int&,int&)
- Sets the value of the range interval.
- o
SetSpecExp(CATICfgSpecANDExpression_var&)
- Sets the specexp of an Effectivity
- o
SetStartMilestone(CATICfgMileStone_var&)
- Sets the start milestone name
- o
SetUserInterval(CATUnicodeString&,CATUnicodeString&)
- Sets the user interval of an Effectivity
- o
ShareSpecExpFromEffectivity(CATICfgBasicEffectivity_var&)
- Sets the effectivity to share the specexp from.
- o
Substract(CATICfgBasicEffectivity_var&,CATListValCATICfgBasicEffectivity_var&)
- Removes a Basic Effectivity from a Basic Effectivity
Methods
o AddSpec
public virtual HRESULT AddSpec( | const int | iSign, |
| const CATICfgSimpleSpecification_var& | iSpec) = 0 |
-
Add a spec to the specexp of an Effectivity
Warning: If you have several specs to add, it's better to use SetSpecExp
- Parameters:
-
- iSpec
- The Spec to add.
o DoesAlreadyShare
public virtual HRESULT DoesAlreadyShare( | const CATICfgBasicEffectivity_var& | iEffectivity) = 0 |
-
Look if this or one of its ancestors shares an effectivity.
- Parameters:
-
- iEffectivity.
- The effectivity to check if it is already shared.
o GetDateInterval
-
Retrieves the value of the date interval.
- Parameters:
-
- oBegTime
- The lower bound of the date interval.
- oEndTime
- The upper bound of the date interval.
o GetEndMilestoneName
-
Retrieves the end milestone name.
- Parameters:
-
- oEndMilestoneName.
- The end milestone name.
o GetIntervals
public virtual HRESULT GetIntervals( | CATListValCATICfgInterval_var& | oIntervals) = 0 |
-
Retrieves the range and the date interval of an Effectivity
- Parameters:
-
- oDateInterval
- The Date interval.
- oRangeInterval
- The Range interval.
o GetRangeInterval
public virtual HRESULT GetRangeInterval( | int& | oStartRange, |
| int& | oEndRange) = 0 |
-
Retrieves the value of the range interval.
- Parameters:
-
- oStartRange
- The lower bound of the range interval.
- oEndRange
- The upper bound of the range interval.
o GetSpecExp
public virtual HRESULT GetSpecExp( | CATICfgSpecANDExpression_var& | oSpecExp) = 0 |
-
Retrieves the specexp of an Effectivity
- Parameters:
-
- oSpecExp
- The SpecExp to retrieve.
o GetStartMilestoneName
-
Retrieves the start milestone name.
- Parameters:
-
- oStartMilestoneName.
- The start milestone name.
o GetTheEffectivityShared
public virtual HRESULT GetTheEffectivityShared( | CATICfgBasicEffectivity_var& | oEffectivity) = 0 |
-
Retrieves the effectivity shared.
- Parameters:
-
- oEffectivity
- The effectivity shared.
o GetTheSharingEffectivities
public virtual HRESULT GetTheSharingEffectivities( | CATListValCATICfgBasicEffectivity_var& | oList) = 0 |
-
Retrieves all the effectivities sharing this effectivity.
- Parameters:
-
- oList.
- The effectivities sharing this effectivity.
o GetUserInterval
-
Retrieves the user interval of an Effectivity
- Parameters:
-
- oStart
- The start value of the interval to get.
- oEnd
- The end value of the interval to get.
o SetDateInterval
-
Sets the value of the date interval with infinite upper bound
- Parameters:
-
- iBegTime
- The lower bound of the date interval.
o SetDateInterval
-
Sets the value of the date interval.
- Parameters:
-
- iBegTime
- The lower bound of the date interval.
- iEndTime
- The upper bound of the date interval.
o SetEndMilestone
public virtual HRESULT SetEndMilestone( | const CATICfgMileStone_var& | iEndMilestoneName) = 0 |
-
Sets the end milestone name
- Parameters:
-
- iEndMilestoneName
- The end milestone name.
o SetInterval
public virtual HRESULT SetInterval( | const CATICfgInterval_var& | iInterval) = 0 |
-
Sets the range or the date interval of an Effectivity
- Parameters:
-
- iInterval
- The interval to set.
o SetRangeInterval
public virtual HRESULT SetRangeInterval( | const int& | iStartRange) = 0 |
-
Sets the value of the range interval with infinite upper bound.
- Parameters:
-
- iStartRange
- The lower bound of the range interval.
o SetRangeInterval
public virtual HRESULT SetRangeInterval( | const int& | iStartRange, |
| const int& | iEndRange) = 0 |
-
Sets the value of the range interval.
- Parameters:
-
- iStartRange
- The lower bound of the range interval.
- iEndRange
- The upper bound of the range interval.
o SetSpecExp
public virtual HRESULT SetSpecExp( | const CATICfgSpecANDExpression_var& | iSpecExp) = 0 |
-
Sets the specexp of an Effectivity
- Parameters:
-
- iSpecExp
- The SpecExp to set.
o SetStartMilestone
public virtual HRESULT SetStartMilestone( | const CATICfgMileStone_var& | iStartMilestoneName) = 0 |
-
Sets the start milestone name
- Parameters:
-
- iStartMilestoneName
- The start milestone name.
o SetUserInterval
-
Sets the user interval of an Effectivity
- Parameters:
-
- iStart
- The start value of the interval to set.
- iEnd
- The end value of the interval to set.
o ShareSpecExpFromEffectivity
public virtual HRESULT ShareSpecExpFromEffectivity( | const CATICfgBasicEffectivity_var& | iEffectivity) = 0 |
-
Sets the effectivity to share the specexp from.
- Parameters:
-
- iEffectivity
- The effectivity to share.
o Substract
public virtual HRESULT Substract( | const CATICfgBasicEffectivity_var& | iEffectivityToSubstract, |
| CATListValCATICfgBasicEffectivity_var& | oResult) = 0 |
-
Removes a Basic Effectivity from a Basic Effectivity
- Parameters:
-
- iEffectivity
- The effectivity to remove.
This object is included in the file: CATICfgBasicEffectivity.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces