All Categories  Class Hierarchy  This Category  Previous  Next  Indexes

ActionFlow Interface CATINEOVpmAFAffectedObjectLink

CATINEOVpmAFAffectedObjectLink

interface CATINEOVpmAFAffectedObjectLink

Interface for manipulating an Action "affected object link" in VPM.
(cf @see CATINEOVpmAFAffectedObject )

Method Index

o AddObject(CATINEOVpmAFAffectedObject_var&,CATVpmAFEndOfLinkType): Adds a new source or target object in the link.
o GetDesc(): Returns the description of the AO-link.
o GetIndexedObject(long,CATVpmAFEndOfLinkType): Retrieves an "affected object" pointed to by the AO-link.
o GetName(): Returns the name of the AO-link.
o GetObjectsCount(CATVpmAFEndOfLinkType): Reads the number of "affected objects" pointed to by the AO-link.
o GetType(): Returns the type of the AO-link.
o IsValid(): Checks if the AO-link is valid.
o LocateObject(CATINEOVpmAFAffectedObject_var&,CATVpmAFEndOfLinkType): Determines if an "affected object" is pointed to by the AO-link.
o RemoveObjects(long,CATINEOVpmAFAffectedObject_var*,CATVpmAFEndOfLinkType): Removes "affected objects" from the AO-link.
o RemoveObjects(long,long*,CATVpmAFEndOfLinkType): Removes "affected objects" from the AO-link.
o SetDesc(CATUnicodeString&): Sets the description of the AO-link.
o SetName(CATUnicodeString&): Sets the name of the AO-link.
o SetType(CATUnicodeString&): Sets the type of the AO-link.
o SetValidity(short unsigned): Sets the validity of the AO-link.

Methods

o AddObject

public virtual void AddObject(	const CATINEOVpmAFAffectedObject_var&	`iObject`,
	CATVpmAFEndOfLinkType	`iSide`	`=CATVpmAFEOLBasedOnFlowType` )=0

Adds a new source or target object in the link. The side of the link
to add to can be automatically determined by the flow type
of the "affected object", using CATVpmAFEOLBasedOnFlowType for iSide. In this case,
input objects will be on the source side, and ouput ones will be on the target side.

Parameters:

iObject: Handler for "affected object"
iSide: Determines which side (CATVpmAFEOLSource or CATVpmAFEOLTarget or CATVpmAFEOLBasedOnFlowType) to add to

See also:

CATINEOVpmAFAffectedObject.GetFlowType

o GetDesc

public virtual CATUnicodeString GetDesc(

)=0

Returns the description of the AO-link.

o GetIndexedObject

public virtual CATINEOVpmAFAffectedObject_var GetIndexedObject(	long	`iIndex`,
	CATVpmAFEndOfLinkType	`iSide`	`=CATVpmAFEOLAny` )=0

Retrieves an "affected object" pointed to by the AO-link. When reading
from both sides, indexation starts with source objects.

Parameters:

iIndex: Index of object to retrieve (from 1 to GetObjectsCount(iSide))
iSide: Determines which side (CATVpmAFEOLSource or CATVpmAFEOLTarget or CATVpmAFEOLAny) to read from

Returns:

handler for "affected objects"

o GetName

public virtual CATUnicodeString GetName(

)=0

Returns the name of the AO-link.

Parameters:

oConfigList: list of configuration handlers

Returns:

0 if no error

o GetObjectsCount

public virtual long GetObjectsCount( CATVpmAFEndOfLinkType iSide =CATVpmAFEOLAny)=0

Reads the number of "affected objects" pointed to by the AO-link.

Parameters:

iSide: Determines which side (source or target or both) to read from

Returns:

number of "affected objects"

o GetType

public virtual CATUnicodeString GetType(

)=0

Returns the type of the AO-link.

o IsValid

public virtual short unsigned IsValid(

)=0

Checks if the AO-link is valid.

Returns:: TRUE if AO-link is valid

o LocateObject

public virtual long LocateObject(	const CATINEOVpmAFAffectedObject_var&	`iObject`,
	CATVpmAFEndOfLinkType	`iSide`	`=CATVpmAFEOLAny` )=0

Determines if an "affected object" is pointed to by the AO-link.

Parameters:

iObject: Handler for "affected object"
iSide: Determines which side (CATVpmAFEOLSource or CATVpmAFEOLTarget or CATVpmAFEOLAny) to read from

Returns:

index of affected object (from 1 to GetObjectsCount(iSide))

o RemoveObjects

public virtual long RemoveObjects(	long	`iObjCount`	`=0`,
	const CATINEOVpmAFAffectedObject_var*	`iObjects`	`=NULL`,
	CATVpmAFEndOfLinkType	`iSide`	`=CATVpmAFEOLAny` )=0

Removes "affected objects" from the AO-link.

Parameters:

iObjCount: Number of objects to remove (0 for all)
iObjects: Array of objects to remove
iSide: Determines which side (CATVpmAFEOLSource or CATVpmAFEOLTarget or CATVpmAFEOLAny) to remove from

Returns:

number of actually removed objects

o RemoveObjects

public virtual long RemoveObjects(	long	`iObjCount`	`=0`,
	const long*	`iObjectIndices`	`=NULL`,
	CATVpmAFEndOfLinkType	`iSide`	`=CATVpmAFEOLAny` )=0

Removes "affected objects" from the AO-link.

Parameters:

iObjCount: Number of objects to remove (0 for all)
iObjectIndices: Array of indices of the objects to remove
iSide: Determines which side (CATVpmAFEOLSource or CATVpmAFEOLTarget or CATVpmAFEOLAny) to remove from

Returns:

number of actually removed objects

o SetDesc

public virtual void SetDesc( const CATUnicodeString& iDesc)=0

Sets the description of the AO-link.

Parameters:

iDesc: AO-link decsription

o SetName

public virtual void SetName( const CATUnicodeString& iName)=0

Sets the name of the AO-link.

Parameters:

iName: AO-link name

o SetType

public virtual void SetType( const CATUnicodeString& iType)=0

Sets the type of the AO-link.

Parameters:

iType: AO-link type (see #define statements in header for list of managed types)

o SetValidity

public virtual void SetValidity( short unsigned isValid)=0

Sets the validity of the AO-link.

Parameters:

isValid: AO-link validity (TRUE or FALSE)

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