All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ManufacturingInterfaces Interface CATIMfgAgregate

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

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


interface CATIMfgAgregate

Interface to manage manufacturing aggregate.

The aggregate contains many elements that can be sorted according to their types.
The type of the elements is the name of an interface that all these elements implement.


Method Index


o AddElement(CATBaseUnknown_var&,int)
Adds an element in the aggregate.
o Beginning()
Sets the first element in the aggregate as current element.
o ChangePosition(CATBaseUnknown_var&,int,int)
Moves an element in the aggregate.
o End()
Sets the last element in the aggregate as current element.
o GetAllElements(CATClassId)
Returns list of the elements of a given type in the aggregate.
o GetCurrent()
Returns the current element in the aggregate.
o GetElement(long,CATClassId)
Returns the element of a given type and for a given position in the aggregate.
o GetNumberOfElements(CATClassId)
Returns the count of elements of a given type in the aggregate.
o InsertAfter(CATBaseUnknown_var&,int)
Inserts an element after the current element in the aggregate.
o InsertBefore(CATBaseUnknown_var&,int)
Inserts an element before the current element in the aggregate.
o Next(CATClassId)
Sets the next element of a given type in the aggregate as current element.
o Previous(CATClassId)
Sets the previous element of a given type in the aggregate as current element.
o RemoveAll(int)
Removes all elements in the aggregate.
o RemoveElement(CATBaseUnknown_var&,int)
Removes an element in the aggregate.
o SetCurrent(CATBaseUnknown_var&)
Set an element as the current element in the aggregate.

Methods


o AddElement
public virtual void AddElement( const CATBaseUnknown_var& iMember,
int iNotify=1) = 0
Adds an element in the aggregate.
Parameters:
iMember
The element to add
iNotify
The flag to indicate whether an event is sent.
Legal values:
  • = 1 : an event is sent to notify the change
  • other value : no event sent
o Beginning
public virtual void Beginning()= 0
Sets the first element in the aggregate as current element.
o ChangePosition
public virtual void ChangePosition( const CATBaseUnknown_var& iMember,
int iNewPosition,
int iNotify=1) = 0
Moves an element in the aggregate.
Parameters:
iMember
The element to move in the aggregate
iNewPosition
The new position of the element in the aggregate
iNotify
The flag to indicate whether an event is sent.
Legal values:
  • = 1 : an event is sent to notify the change
  • other value : no event sent
o End
public virtual void End()= 0
Sets the last element in the aggregate as current element.
o GetAllElements
public virtual CATListValCATBaseUnknown_var* GetAllElements(CATClassId intfName=0) = 0
Returns list of the elements of a given type in the aggregate.
Parameters:
intfName
The name of an interface describing the type of the elements
Returns:
The list of the elements of the given type
o GetCurrent
public virtual CATBaseUnknown_var GetCurrent()= 0
Returns the current element in the aggregate.
o GetElement
public virtual CATBaseUnknown_var GetElement(long iPosition,
CATClassId intfName=0) = 0
Returns the element of a given type and for a given position in the aggregate.
Parameters:
iPosition
The position of the element in the agregate
intfName
The name of an interface describing the type of the elements
Returns:
The element of the given type and the given position in the aggregate
o GetNumberOfElements
public virtual long GetNumberOfElements(CATClassId intfName=0) = 0
Returns the count of elements of a given type in the aggregate.
Parameters:
intfName
The name of an interface describing the type of the elements
Returns:
The number of elements of the given type
o InsertAfter
public virtual int InsertAfter( const CATBaseUnknown_var& iMember,
int iNotify=1) = 0
Inserts an element after the current element in the aggregate.
Parameters:
iMember
The element to insert
iNotify
The flag to indicate whether an event is sent.
Legal values:
  • = 1 : an event is sent to notify the change
  • other value : no event sent
Returns:
The position of the element in the aggregate.
Legal values:
  • = 0 : insertion has failed
  • other value : position of the inserted element in the aggregate
o InsertBefore
public virtual int InsertBefore( const CATBaseUnknown_var& iMember,
int iNotify=1) = 0
Inserts an element before the current element in the aggregate.
Parameters:
iMember
The element to insert
iNotify
The flag to indicate whether an event is sent.
Legal values:
  • = 1 : an event is sent to notify the change
  • other value : no event sent
Returns:

Legal values:
  • = 0 : insertion has failed
  • other value : position of the inserted element in the aggregate
o Next
public virtual int Next(CATClassId intfName=0) = 0
Sets the next element of a given type in the aggregate as current element.
Parameters:
intfName
The name of an interface describing the type of the elements
Returns:
The position of the element in the aggregate.
Legal values:
  • = 0 : no next element in the aggregate
  • other value : position of the next element in the aggregate
o Previous
public virtual int Previous(CATClassId intfName=0) = 0
Sets the previous element of a given type in the aggregate as current element.
Parameters:
intfName
The name of an interface describing the type of the elements
Returns:
The position of the element in the aggregate.
Legal values:
  • = 0 : no previous element in the aggregate
  • other value : position of the previous element in the aggregate
o RemoveAll
public virtual void RemoveAll(int iNotify=1) = 0
Removes all elements in the aggregate.
Parameters:
iNotify
The flag to indicate whether an event is sent.
Legal values:
  • = 1 : an event is sent to notify the change
  • other value : no event sent
o RemoveElement
public virtual void RemoveElement( const CATBaseUnknown_var& iMember,
int iNotify=1) = 0
Removes an element in the aggregate.
Parameters:
iMember
The element to remove
iNotify
The flag to indicate whether an event is sent.
Legal values:
  • = 1 : an event is sent to notify the change
  • other value : no event sent
o SetCurrent
public virtual int SetCurrent( const CATBaseUnknown_var& iMember) = 0
Set an element as the current element in the aggregate.
Parameters:
iMember
The element to set as current element
Returns:
The position of the element in the aggregate.
Legal values:
  • = 0 : element not found in the aggregate
  • other value : position of the element in the aggregate

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

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