All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DMAPSInterfaces Interface CATISPPActivityType

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATISPPActivityType
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISPPActivityType

Interface to manage different type of Activities.

Note:This interface concerns reference activities which are created in libraries.


Method Index


o AddAttribute(CATUnicodeString&,CATSPPAttrKind)
Adds attributes to an Activity type.
o CreateSubType(CATUnicodeString&,CATIContainer_var&)
Creates a new SubType for an Activity type.
o GetAttrList()
Returns the list of Attributes that are managed on an Activity Type.
o GetAuthorizedItemList()
Returns the list of types of item that may be managed on an Activity Type.
o GetIcon()
Retrieves the name of an icon associated to an Activity Type.
o GetOperatorLabel()
Returns the label of the operator associated to an Activity.
o GetSubType(CATISPPAbstractActivity_var&,int)
Returns list of Subtypes for an Activity type.
o GetSuperActivityType(CATISPPActivityType**)
Returns a CATISPPActivityType pointer to the super type of this activity type.
o GetSuperType()
Retrieves the super type of an Activity Type (the next higher type in the hierarchy of Activity types).
o GetType()
Retrieves the type of an Activity type.
o IsInstanciable()
Returns the instantiability of an activity.
o IsSubTypeOf(CATUnicodeString&)
Tests if a type is a subtype of another one.
o RemoveAttribute(CATUnicodeString&)
Removes attributes to an Activity type.
o RemoveAuthorizedItem(CATUnicodeString&)
Removes an element from the list of types of item that may be managed on an Activity Type.
o SetAuthorizedItem(CATUnicodeString&)
Adds an element to the list of items' types that may be managed on an Activity Type.
o SetInstanciable(CATBoolean)
Sets the instantiability of an activity.
o SetOperatorLabel(wchar_t*)
Sets the label of the operator associated to an Activity.

Methods


o AddAttribute
public virtual void AddAttribute( const CATUnicodeString& iAttributeName,
CATSPPAttrKind AttrType) const = 0
Adds attributes to an Activity type.
Parameters:
iAttributeName
The name of the type for which an attribute has to be added
AttrType
The type of the atribute to add : it may be today a string, an integer or a double
o CreateSubType
public virtual CATISPPActivityType_var CreateSubType( const CATUnicodeString& iTypeName,
const CATIContainer_var& iCont= NULL_var) = 0
Creates a new SubType for an Activity type.
Parameters:
iTypeName
The name of the type for which a subtype must be created
iCont
To be valuated if the activity has to be create in a specific container.
Returns:
Handler on the Activity type newly created
o GetAttrList
public virtual CATListValCATUnicodeString* GetAttrList()const = 0
Returns the list of Attributes that are managed on an Activity Type.
o GetAuthorizedItemList
public virtual CATListValCATUnicodeString* GetAuthorizedItemList()const = 0
Returns the list of types of item that may be managed on an Activity Type.
o GetIcon
public virtual CATUnicodeString GetIcon()const = 0
Retrieves the name of an icon associated to an Activity Type.
o GetOperatorLabel
public virtual wchar_t* GetOperatorLabel()const = 0
Returns the label of the operator associated to an Activity.
Returns:
The label of the operator associated to an Activity
o GetSubType
public virtual CATListValCATBaseUnknown_var* GetSubType( const CATISPPAbstractActivity_var& iAct= NULL_var,
int depth= 1) const = 0
Returns list of Subtypes for an Activity type.
Parameters:
iAct
context to search sub types.
depth
the depth to search in the hierarchy, by default it is equal to one
Returns:
Handler on the list of Subtypes for an Activity type
o GetSuperActivityType
public virtual HRESULT GetSuperActivityType(CATISPPActivityType** oSuperActType) const = 0
Returns a CATISPPActivityType pointer to the super type of this activity type.
Parameters:
oSuperActType
CATISPPActivityType pointer to the super activity type object
Returns:
E_INVALIDARG if oSuperActType==NULL S_OK The super activityType object is found and we successfully get an CATISPPACtivityType pointer on it E_FAIL The super activityType object is not found or we don t get an CATISPPActivityType pointer on it
o GetSuperType
public virtual CATISPPActivityType_var GetSuperType()const = 0
Retrieves the super type of an Activity Type (the next higher type in the hierarchy of Activity types).
Returns:
Handler on the SuperType
o GetType
public virtual CATUnicodeString GetType()const = 0
Retrieves the type of an Activity type.
o IsInstanciable
public virtual CATBoolean IsInstanciable()const = 0
Returns the instantiability of an activity.
Returns:
TRUE if the activity is instantiable else FALSE
o IsSubTypeOf
public virtual CATBoolean IsSubTypeOf( const CATUnicodeString& iTypeName) = 0
Tests if a type is a subtype of another one.
Parameters:
iTypeName
The name of the type which is tested to be a supertype
Returns:
TRUE
when this type is a subtype of the one put in parameter of this method
FALSE
this type is NOT a subtype of the one put in parameter of this method
o RemoveAttribute
public virtual void RemoveAttribute( const CATUnicodeString& iAttributeName) = 0
Removes attributes to an Activity type.
Parameters:
iAttributeName
The name of the attribute to remove
o RemoveAuthorizedItem
public virtual void RemoveAuthorizedItem( const CATUnicodeString& iItem= NULL_string) = 0
Removes an element from the list of types of item that may be managed on an Activity Type.
Parameters:
iItem
item type
If no string, all are removed.
o SetAuthorizedItem
public virtual void SetAuthorizedItem( const CATUnicodeString& iItem) = 0
Adds an element to the list of items' types that may be managed on an Activity Type.
Parameters:
iItem
item type.
o SetInstanciable
public virtual void SetInstanciable(CATBoolean iInst= TRUE) = 0
Sets the instantiability of an activity.
Parameters:
iInst
TRUE if the activity is instantiable, else FALSE
o SetOperatorLabel
public virtual void SetOperatorLabel(wchar_t* iOperatorLabel) = 0
Sets the label of the operator associated to an Activity.
Parameters:
iOperatorLabel
The label of the operator associated to an Activity

This object is included in the file: CATISPPActivityType.h
If needed, your Imakefile.mk should include the module: CATProcessInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.