All Categories Class Hierarchy This Category Previous Next Indexes
ActionFlow Interface CATINEOVpmAFAffectedObject
CATINEOVpmAFAffectedObject
interface CATINEOVpmAFAffectedObject
Interface for manipulating an Action "affected object" in VPM.
(@see CATINEOVpmAFAction )
Method Index
- o
GetConfigList(CATLISTV(CATINEOVpmConfigHandler_var)&)
- If the object is a part, retrieves the assocated list of configuration handlers.
- o
GetDesc()
- Returns object description.
- o
GetFlowType()
- Returns object flow type ("I" for input, "O" for output).
- o
GetId()
- Returns object unique identifier (uuid) : for instance, if the object
is a reference to a part (CATVpmAffObjPART), uuid of the part.
- o
GetMaturity()
- Returns object maturity : (maturity is not managed).
- o
GetName()
- Returns object name.
- o
GetPartObj()
- Returns product structure interface for the object (to access product structure
and configuration information).
- o
GetReferringLinks(CATVpmAFEndOfLinkType)
- Returns a list of links that point to this affected object
(within the same action).
- o
GetRelatedActions()
- Returns a list of actions that refer to this affected object.
- o
GetType()
- Returns object type (see #define statement in header).
- o
GetVarious(int)
- Returns object indicators map.
- o
Initialize()
- To be called once after the object is created to be able to use following accessors.
- o
Open()
- Opens object within appropriate editor (for example, PSN for a part).
- o
Promote()
- Increments object maturity (not used).
- o
RemoveData()
- Removes object associated data from the database
(only if type is CATVpmAffObjBLOB or CATVpmAffObjIPEX).
- o
SaveData()
- Updates/Imports object associated data into the database
(only if type is CATVpmAffObjBLOB or CATVpmAffObjIPEX).
- o
SetDesc(CATUnicodeString&)
- Sets the object description (see GetDesc).
- o
SetFlowType(CATUnicodeString&)
- Sets the object flow type (see GetFlowType).
- o
SetId(SEQUENCE(octet)&)
- Sets the object uuid (see GetId).
- o
SetMaturity(int&)
- Sets the object maturity (see GetMaturity).
- o
SetName(CATUnicodeString&)
- Sets the object name (see GetName).
- o
SetPartObj(CATINEOVpmPStempo_var&)
- Sets the product structure interface object (see GetPartObj).
- o
SetType(CATUnicodeString&)
- Sets the object type (see GetType).
- o
SetVarious(int,short unsigned)
- Sets object indicators map (see GetVarious).
Methods
o GetConfigList
| public virtual int GetConfigList( | CATLISTV(CATINEOVpmConfigHandler_var)& | oConfigList)=0 |
-
If the object is a part, retrieves the assocated list of configuration handlers.
- Parameters:
-
- oConfigList
- list of configuration handlers
- Returns:
- 0 if no error
o GetDesc
| public virtual CATUnicodeString GetDesc( | )=0 |
-
Returns object description.
o GetFlowType
| public virtual CATUnicodeString GetFlowType( | )=0 |
-
Returns object flow type ("I" for input, "O" for output).
o GetId
| public virtual SEQUENCE(octet) GetId( | )=0 |
-
Returns object unique identifier (uuid) : for instance, if the object
is a reference to a part (CATVpmAffObjPART), uuid of the part.
o GetMaturity
| public virtual int GetMaturity( | )=0 |
-
Returns object maturity : (maturity is not managed).
o GetName
| public virtual CATUnicodeString GetName( | )=0 |
-
Returns object name.
o GetPartObj
-
Returns product structure interface for the object (to access product structure
and configuration information).
o GetReferringLinks
| public virtual CATLISTV(CATINEOVpmAFAffectedObjectLink_var) GetReferringLinks( | CATVpmAFEndOfLinkType | iSide)=0 |
-
Returns a list of links that point to this affected object
(within the same action).
o GetRelatedActions
| public virtual CATLISTV(CATINEOVpmAFAction_var) GetRelatedActions( | )=0 |
-
Returns a list of actions that refer to this affected object.
o GetType
| public virtual CATUnicodeString GetType( | )=0 |
-
Returns object type (see #define statement in header).
o GetVarious
| public virtual unsigned short GetVarious( | int | iPos)=0 |
-
Returns object indicators map.
The first two indicators are used to manage the update of an external file
through an external editor and that has to be re-imported in the database.
position 1 : value=1 if object has just been created
position 2 : value=1 if object is open
position 3 : unusued
- Parameters:
-
- iPos
- indicator position (from 1 to 3)
- Returns:
- TRUE if indicator is set
o Initialize
| public virtual void Initialize( | )=0 |
-
To be called once after the object is created to be able to use following accessors.
The Id is mandatory to retreive the object in the Database (not useful for files).
o Open
| public virtual int Open( | )=0 |
-
Opens object within appropriate editor (for example, PSN for a part).
- Returns:
- 0 if no error
o Promote
| public virtual void Promote( | )=0 |
-
Increments object maturity (not used).
o RemoveData
| public virtual int RemoveData( | )=0 |
-
Removes object associated data from the database
(only if type is CATVpmAffObjBLOB or CATVpmAffObjIPEX).
- Returns:
- 1 always
o SaveData
| public virtual int SaveData( | )=0 |
-
Updates/Imports object associated data into the database
(only if type is CATVpmAffObjBLOB or CATVpmAffObjIPEX).
- Returns:
- 0 if no error
o SetDesc
| public virtual void SetDesc( | const CATUnicodeString& | iDesc)=0 |
-
Sets the object description (see GetDesc).
- Parameters:
-
- iDesc
- affected object descrition
o SetFlowType
| public virtual void SetFlowType( | const CATUnicodeString& | iType)=0 |
-
Sets the object flow type (see GetFlowType).
- Parameters:
-
- iType
- ="I" for input, "O" for output
o SetId
| public virtual void SetId( | const SEQUENCE(octet)& | iId)=0 |
-
Sets the object uuid (see GetId).
- Parameters:
-
- iId
- VPM object uuid
- How to build the uuid?
- CATDMUsrInstance Inst (coid, compid, caenv, catab);
- char uuid [50];
- int lenuuid = 0;
- Error Err = Inst.GetUUID (uuid);
- if (!Err.Ier)
- lenUUID = 50;
- SEQUENCE(octet) seq;
- seq.length (lenUUID);
- for(int i = 0; i < lenUUID; i++)
- seq [i] = uuid [i];
o SetMaturity
| public virtual void SetMaturity( | const int& | iMaturity)=0 |
-
Sets the object maturity (see GetMaturity).
- Parameters:
-
- iMaturity
- affected object maturity
o SetName
| public virtual void SetName( | const CATUnicodeString& | iName)=0 |
-
Sets the object name (see GetName).
- Parameters:
-
- iName
- affected object name
o SetPartObj
| public virtual void SetPartObj( | const CATINEOVpmPStempo_var& | iPart)=0 |
-
Sets the product structure interface object (see GetPartObj).
- Parameters:
-
- iPart
- affected object interface to product structure
o SetType
| public virtual void SetType( | const CATUnicodeString& | iType)=0 |
-
Sets the object type (see GetType).
- Parameters:
-
- iType
- affected object type
o SetVarious
| public virtual void SetVarious( | int | iPos, |
| short unsigned | iValue)=0 |
-
Sets object indicators map (see GetVarious).
- Parameters:
-
- iPos
- indicator position (from 1 to 3)
- iValue
- indicator value (0 or 1)
This object is included in the file: CATINEOVpmAFAffectedObject.h
If needed, your Imakefile.mk should include the module: GUIDVirtualAction