All Frameworks Class Hierarchy This Framework Indexes
CATInstantCollabDesignCAAItf Interface CATIColMergeContextTable
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIColMergeContextTable
This interface defines the semantics used to represent all the linked feature of a collaborative feature.
The table contains a set of rows, each of them describing ONE link :
Example : context table for a pad aggregated under an hybrid body
----------------------------------------------------------------------------
ROLE NAME | Pointed Object | ContextRole | ContextFlag
----------------------------------------------------------------------------
Myfather | HybridBody | CATCol_PROTECTED_AGGREGATOR | CATCol_OPTIONAL
Myprofile | sketch | CATCol_FORCED_DEPENDENCY | CATCol_OPTIONAL
RoleName : string chosen by the developer to identify a link
Pointed object : the feature
Context role : the collaborative semantic
ContextFlag : not used .Default is CATCol_OPTIONAL
The table is built during the share step by a low level adapter which guarantees the feature model integrity.
The goal is to have a closed set of features.
The folowing methods provide access to the rows and the columns of the table and the possibility to add string property
inside the table. These properties are streamed whith the table.
Method Index
- o
CreateLink(CATIColMergeContextRole,CATUnicodeString&,CATBaseUnknown*,CATIColMergeContextFlag,int&)
- Add a new entry inside the table.
- o
CreateProperty(CATUnicodeString&,CATUnicodeString&)
- Add a string property (key,value) inside the table
- o
GetContextFlag(int,CATIColMergeContextFlag&)
- NOT USED : Get the ContextFlag column value of the row iIndex
- o
GetContextRole(int,CATIColMergeContextRole&)
- Get the context role column value of the row iIndex
- o
GetLink(int,CATIColMergeContextRole&,CATUnicodeString&,CATBaseUnknown*&,CATIColMergeContextFlag&)
- Get the entire entry iIndex from the table
- o
GetObject(int,CATBaseUnknown*&)
- Get the object column value of the row iIndex
- o
GetProperty(CATUnicodeString&,CATUnicodeString&)
- Return the value of a property from a key
- o
GetRoleName(int,CATUnicodeString&)
- Get the role name column value of the row iIndex
- o
GetRoleNumber(int&)
- Get the number of entries inside the table
- o
ListPropertyKeys(CATListOfCATUnicodeString&)
- List all the properties key
- o
LocateObject(CATBaseUnknown*)
- Find an entry inside the table from an input object
- o
RemoveLink(int)
- Remove an entry from the table
- o
RemoveProperty(CATUnicodeString&)
- Remove a property from a key
- o
SetContextFlag(int,CATIColMergeContextFlag)
- NOT USED :Valuate the context flag column of the row iIndex
- o
SetContextRole(int,CATIColMergeContextRole)
- Valuate the ContextRole column of the row iIndex
- o
SetObject(int,CATBaseUnknown*)
- Valuate the object column of the row iIndex.
- o
SetRoleName(int,CATUnicodeString&)
- Valuate the rolename column of the row iIndex
Methods
o CreateLink
| public virtual CreateLink( | | iRole, |
| | iRoleName, |
| | iValue, |
| | iFlag, |
| | oIndex) |
-
Add a new entry inside the table.
- Returns:
- The index inside the table of the new entry
o CreateProperty
| public virtual CreateProperty( | const | ikey, |
| const | value) |
-
Add a string property (key,value) inside the table
o GetContextFlag
| public virtual GetContextFlag( | | iIndex, |
| | oFlag) |
-
NOT USED : Get the ContextFlag column value of the row iIndex
o GetContextRole
| public virtual GetContextRole( | | iIndex, |
| | oCtxRole) |
-
Get the context role column value of the row iIndex
o GetLink
| public virtual GetLink( | | iIndex, |
| | oRole, |
| | oRoleName, |
| | oValue, |
| | oFlag) |
-
Get the entire entry iIndex from the table
o GetObject
| public virtual GetObject( | | iIndex, |
| | oValue) |
-
Get the object column value of the row iIndex
- Parameters:
-
- iIndex
- [in] The parameter role...
- oValue
- [out, CATBaseUnknown#Release] The parameter role...
- Returns:
-
S_OK if everything ran ok, otherwise...
o GetProperty
| public virtual GetProperty( | const | ikey, |
| | ovalue) |
-
Return the value of a property from a key
o GetRoleName
| public virtual GetRoleName( | | iIndex, |
| | oName) |
-
Get the role name column value of the row iIndex
o GetRoleNumber
| public virtual GetRoleNumber( | | oNumber) |
-
Get the number of entries inside the table
o ListPropertyKeys
| public virtual ListPropertyKeys( | | list) |
-
List all the properties key
o LocateObject
| public virtual LocateObject( | const | iObject) |
-
Find an entry inside the table from an input object
- Parameters:
-
- iObject
- feature to find inside the table
- Returns:
- the index inside the table of the link which contains iObject or -1 if not found
o RemoveLink
| public virtual RemoveLink( | | iIndex) |
-
Remove an entry from the table
o RemoveProperty
| public virtual RemoveProperty( | const | ikey) |
-
Remove a property from a key
o SetContextFlag
| public virtual SetContextFlag( | | iIndex, |
| | iFlag) |
-
NOT USED :Valuate the context flag column of the row iIndex
o SetContextRole
| public virtual SetContextRole( | | iIndex, |
| | iCtxRole) |
-
Valuate the ContextRole column of the row iIndex
o SetObject
| public virtual SetObject( | | iIndex, |
| | iValue) |
-
Valuate the object column of the row iIndex. If an object was already set, it is released
o SetRoleName
| public virtual SetRoleName( | | iIndex, |
| | iName) |
-
Valuate the rolename column of the row iIndex
This object is included in the file: CATIColMergeContextTable.h
If needed, your Imakefile.mk should include the module: CATInstantCollabDesignItf