All Categories  Class Hierarchy  This Category  Previous  Next  Indexes

Interface_Dispatcher Class CATCdpPart

Interface_Dispatcher.CATCdpObject
  |
  +---Interface_Dispatcher.CATCdpObjectOnInstance
    |
    +---CATCdpPart

public class CATCdpPart

Class to CATCdpPart.
Role CATCdpPart proxy defined to enable access to VPM Part Events and Information.

Method Index

o AddChild(CATCdpPart&,char*,double*,CATCdpProductStructureView*,CATCdpAssembly*&): Add a part component to a Part Version; this operation will be configured by a specific action.
o AddChild(CATCdpPart&,char*,double*,CATCdpProductStructureView*,unsigned char*,CATCdpAssembly*&): Add a part component to a Part Version; this operation will be configured by a specific action.
o AddChild(CATCdpPart&,double*,CATCdpAssembly*&): Add a part component to a Part Version.
o AnalyseCheckStatus(int&): Return a check in/out status of the Part Version to know if a check in/out operation is possible.
o AttachPartRepresentation(int,CATCdpAttributeAny* const,char*,char*,char*,CATCdpPartRepresentation*&): Attach a new Part Representation (model/Document) to a Part Version.
o ChangeMaturity(int,int)
o CheckInPart()
o CheckOutPart(int)
o CreatePart(char* const,int,CATCdpAttributeAny* const,CATCdpPart*&): Construct a CATCdpPart proxy.
o DeletePartVersion()
o Dump(int): Display CATCdpPart proxy.
o DumpAssemblyStructure(CATCdpAssemblyStructure&,int,int): Display assembly structure.
o GetAssemblyStructure(CATCdpAssemblyStructure&,char*,int)
o GetAttribute(char*,CATCdpAttributeAny&)
o GetAttribute(char*,char*&)
o GetAttribute(int&,CATCdpAttributeAny*&)
o GetChildList(CATCdpProductStructureView*,int&,CATCdpAssembly**&)
o GetChildList(CATCdpProductStructureView*,int&,CATCdpAssembly**&,char*,int)
o GetConfiguration(CATCdpProductStructureView*,int&,CATCdpEffectivity*&)
o GetConfiguration(CATCdpProductStructureView*,int&,int&,CATCdpEffectivity*&,int&,CATCdpEffectivity*&)
o GetEnvironment(int&,char*&)
o GetLastPartVersion(int,CATCdpPart*&)
o GetName(int&,char*&): Display CATCdpPart proxy.
o GetRepresentationList(int&,CATCdpPartRepresentation**&)
o GetStatus(int&,char*&)
o GetSubAssembly(CATCdpProductStructureView*,int&,CATCdpAssembly**&,CATCdpPart**&,char*,int,int,CATCdpAttributeAny* const)
o GetSubAssembly(CATCdpProductStructureView*,int&,CATCdpAssembly**&,CATCdpPart**&,int,CATCdpAttributeAny* const)
o IsConfigurable(int&)
o ModifyAttribute(int,CATCdpAttributeAny* const)
o NewPartVersion(char*)
o QueryPart(char* const,char* const,CATCdpListOfObject&)
o QueryPart(char* const,char* const,int&,CATCdpPart**&)
o QueryPart(char* const,int,CATCdpAttributeAny* const,CATCdpListOfObject&)
o QueryPart(char* const,int,CATCdpAttributeAny* const,int&,CATCdpPart**&)
o QueryPart(char* const,int,int*,int*,CATCdpAttributeAny* const,CATCdpListOfObject&)
o QueryPart(char* const,int,int*,int*,CATCdpAttributeAny* const,int&,CATCdpPart**&)
o RemoveChild(CATCdpAssembly&,CATCdpProductStructureView*)
o RemoveChild(CATCdpAssembly&,char*,CATCdpProductStructureView*)
o SetConfigurable(int,CATCdpEffectivity::CATCdpEffectivityType*)

o _cOldStatus
o _cStatus
o _lNewPartNumber

Methods

o AddChild

public int AddChild(	CATCdpPart&	`iChildPart`,
	const char*	`icActionNameID`,
	double*	`iaPosMatrix`,
	CATCdpProductStructureView*	`ixProductStructureView`,
	CATCdpAssembly*&	`oRelationCreated`)

Add a part component to a Part Version; this operation will be configured by a specific action.

Parameters:

iChildPart: Component Part to be added to the assembly definition.
icActionNameID: Action ID in which the relation is created (string).
iaPosMatrix: Matrix[12] defining the position of the Part Component relatively to the Assembly Part.
ixProductStructureView: The ProductStructure View context (optionnal)*
oRelationCreated: Part Assembly realtion added to the Part.

o AddChild

public int AddChild(	CATCdpPart&	`iChildPart`,
	const char*	`icActionNameID`,
	double*	`iaPosMatrix`,
	CATCdpProductStructureView*	`ixProductStructureView`,
	unsigned char*	`iCompid`,
	CATCdpAssembly*&	`oRelationCreated`)

Add a part component to a Part Version; this operation will be configured by a specific action.

Parameters:

iChildPart: Component Part to be added to the assembly definition.
icActionNameID: Action ID in which the relation is created (string).
iaPosMatrix: Matrix[12] defining the position of the Part Component relatively to the Assembly Part.
ixProductStructureView: The ProductStructure View context (optionnal)
iCompid: Compid to set for the link
oRelationCreated: Part Assembly realtion added to the Part.

o AddChild

public int AddChild(	CATCdpPart&	`iChildPart`,
	double*	`iaPosMatrix`,
	CATCdpAssembly*&	`oRelationCreated`)

Add a part component to a Part Version.

Parameters:

iChildPart: Component Part to be added to the assembly definition.
icActionNameID: Action ID in which the relation is created (string).
iaPosMatrix: Matrix[12] defining the position of the Part Component relatively to the Assembly Part.
oRelationCreated: Part Assembly realtion added to the Part.

o AnalyseCheckStatus

public int AnalyseCheckStatus( int& iReturnCheck)

Return a check in/out status of the Part Version to know if a check in/out operation is possible.

Parameters:

iReturnCheck: status.
Legal values: CHECK_OUT_BY_OTHER | CHECK_OUT_BY_USER | CHECK_NOT_CHECK_OUT | CHECK_FROZZEN

o AttachPartRepresentation

public CATCdpError AttachPartRepresentation(	int	`inbAttributeModel`,
	CATCdpAttributeAny* const	`iaAttributeModel`,
	const char*	`icAccesMethode`,
	const char*	`icUnixFileModel`,
	const char*	`icRepresentationTable`,
	CATCdpPartRepresentation*&	`oModelCreated`)

Attach a new Part Representation (model/Document) to a Part Version.

Parameters:

inbAttributeModel: number of Model/Document Attributes
iaAttributeModel: Array of the Part Representation Attributes
icAccesMethode: Type of stockage
Default value: DBLFAIX.BIN
icUnixFileModel: Default value: CATIA_MODEL Unix path of the CATIA model
icRepresentationTable: Name of the table where the representation is created oModelCreated

o ChangeMaturity

public int ChangeMaturity(	int	`cMaturity`,
	int	`cConfirm`	`= 0`)

o CheckInPart

public int CheckInPart(

)

o CheckOutPart

public int CheckOutPart( int olLockUnique = 1 )

o CreatePart

public static CATCdpError CreatePart(	char* const	`cEnvName`,
	int	`nAttr`,
	CATCdpAttributeAny* const	`xAttrList`,
	CATCdpPart*&	`xPart`)

Construct a CATCdpPart proxy.

Parameters:

cEnvName: Environment name.
nAttr: The Number of The Part Attributes.
xAttrList: The Part Attribute List.
xPart: Part that have been created.

o DeletePartVersion

public virtual int DeletePartVersion(

)

o Dump

public void Dump( int inModeDisplay = DISPLAY_MODE_UUID | DISPLAY_MODE_ATTRIBUTE | DISPLAY_MODE_NAME )

Display CATCdpPart proxy.

Parameters:

inModeDisplay: Legal values: DISPLAY_MODE_UUID | DISPLAY_MODE_ATTRIBUTE | DISPLAY_MODE_NAME

o DumpAssemblyStructure

public static void DumpAssemblyStructure(	const CATCdpAssemblyStructure&	`AssemblyStructure`,
	int	`nModeDisplay`	`= DISPLAY_MODE_UUID \| DISPLAY_MODE_ATTRIBUTE \| DISPLAY_MODE_NAME\| DISPLAY_MODE_NB_CHILD\| DISPLAY_MODE_RELATION`,
	int	`nLevel`	`= 0` )

Display assembly structure.

Parameters:

AssemblyStructure: Environment name.
nModeDisplay: The Number of The Part Attributes.
Legal values: DISPLAY_MODE_UUID | DISPLAY_MODE_ATTRIBUTE | DISPLAY_MODE_NAME
nLevel: Display mode mask.
Legal values: 0 (Optional, Default is Full display)

o GetAssemblyStructure

public CATCdpError GetAssemblyStructure(	CATCdpAssemblyStructure&	`CompleteAssemblyStructure`,
	const char*	`cOptionName`,
	int	`nOptionType`	`= OPTION_TYPE_MODIFICATION` )

o GetAttribute

public virtual int GetAttribute(	const char*	`cAttributeName`,
	CATCdpAttributeAny&	`xAttribute`)

o GetAttribute

public virtual int GetAttribute(	const char*	`cAttributeName`,
	const char*&	`cAttributeValue`)

o GetAttribute

public virtual int GetAttribute(	int&	`nAttribute`,
	CATCdpAttributeAny*&	`aAttribute`)

o GetChildList

public CATCdpError GetChildList(	CATCdpProductStructureView*	`xProductStructureView`,
	int&	`nbLink`,
	CATCdpAssembly**&	`xLinkList`)

o GetChildList

public CATCdpError GetChildList(	CATCdpProductStructureView*	`xProductStructureView`,
	int&	`nbLink`,
	CATCdpAssembly**&	`xLinkList`,
	const char*	`cOptionName`,
	int	`nOptionType`	`= OPTION_TYPE_MODIFICATION`)

o GetConfiguration

public CATCdpError GetConfiguration(	CATCdpProductStructureView*	`xProductStructureView`,
	int&	`nbEffectivitySelected`,
	CATCdpEffectivity*&	`xEffectivitySelected`)

o GetConfiguration

public int GetConfiguration(	CATCdpProductStructureView*	`xProductStructureView`,
	int&	`nAuthorizedEffectivity`,
	int&	`nbEffectivity`,
	CATCdpEffectivity*&	`xEffectivity`,
	int&	`nbEffectivitySelected`,
	CATCdpEffectivity*&	`xEffectivitySelected`)

o GetEnvironment

public int GetEnvironment(	int&	`nEnvSize`,
	char*&	`cEnv`)

o GetLastPartVersion

public int GetLastPartVersion(	int	`lNewVersion`,
	CATCdpPart*&	`xLastVersion`)

o GetName

public int GetName(	int&	`nNameSize`,
	char*&	`cName`)

Display CATCdpPart proxy.

Parameters:

nModeDisplay: Legal values: DISPLAY_MODE_UUID | DISPLAY_MODE_ATTRIBUTE | DISPLAY_MODE_NAME

o GetRepresentationList

public int GetRepresentationList(	int&	`nbDoc`,
	CATCdpPartRepresentation**&	`xDocList`)

o GetStatus

public int GetStatus(	int&	`nStatusSize`,
	char*&	`cStatus`)

o GetSubAssembly

public CATCdpError GetSubAssembly(	CATCdpProductStructureView*	`xProductStructureView`,
	int&	`nbChild`,
	CATCdpAssembly**&	`aLinkFound`,
	CATCdpPart**&	`aPartFound`,
	const char*	`cOptionName`,
	int	`nOptionType`	`= OPTION_TYPE_MODIFICATION` ,
	int	`nAttr`	`= 0` ,
	CATCdpAttributeAny* const	`xAttrList`	`= NULL` )

o GetSubAssembly

public CATCdpError GetSubAssembly(	CATCdpProductStructureView*	`xProductStructureView`,
	int&	`nbChild`,
	CATCdpAssembly**&	`aLinkFound`,
	CATCdpPart**&	`aPartFound`,
	int	`nAttr`	`= 0` ,
	CATCdpAttributeAny* const	`xAttrList`	`= NULL` )

o IsConfigurable

public CATCdpError IsConfigurable( int& cConf)

o ModifyAttribute

public virtual CATCdpError ModifyAttribute(	int	`nAttribute`,
	CATCdpAttributeAny* const	`aAttributeNew`)

o NewPartVersion

public virtual int NewPartVersion( const char* cVersion)

o QueryPart

public static CATCdpError QueryPart(	const char* const	`cEnvName`,
	const char* const	`cQueryClause`,
	CATCdpListOfObject&	`aPartFound`)

o QueryPart

public static CATCdpError QueryPart(	const char* const	`cEnvName`,
	const char* const	`cQueryClause`,
	int&	`nbPart`,
	CATCdpPart**&	`aPart`)

o QueryPart

public static CATCdpError QueryPart(	const char* const	`cEnvName`,
	int	`nAttr`,
	CATCdpAttributeAny* const	`xAttrList`,
	CATCdpListOfObject&	`aPartFound`)

o QueryPart

public static CATCdpError QueryPart(	const char* const	`cEnvName`,
	int	`nAttr`,
	CATCdpAttributeAny* const	`xAttrList`,
	int&	`nbPart`,
	CATCdpPart**&	`aPart`)

o QueryPart

public static CATCdpError QueryPart(	const char* const	`cEnvName`,
	int	`nAttr`,
	int*	`aComparator`,
	int*	`aRuleAndOr`,
	CATCdpAttributeAny* const	`xAttrList`,
	CATCdpListOfObject&	`aPartFound`)

o QueryPart

public static CATCdpError QueryPart(	const char* const	`cEnvName`,
	int	`nAttr`,
	int*	`aComparator`,
	int*	`aRuleAndOr`,
	CATCdpAttributeAny* const	`xAttrList`,
	int&	`nbPart`,
	CATCdpPart**&	`aPart`)

o RemoveChild

public int RemoveChild(	CATCdpAssembly&	`RelationToDestroy`,
	CATCdpProductStructureView*	`xProductStructureView`)

o RemoveChild

public int RemoveChild(	CATCdpAssembly&	`RelationToHide`,
	const char*	`cActionNameID`,
	CATCdpProductStructureView*	`xProductStructureView`)

o SetConfigurable

public int SetConfigurable(	int	`nEffectivityType`,
	CATCdpEffectivity::CATCdpEffectivityType*	`EffectivityType`)

Data Members

o _cOldStatus

  protected char * _cOldStatus

o _cStatus

  protected char * _cStatus

o _lNewPartNumber

  protected int _lNewPartNumber

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

Interface_Dispatcher Class CATCdpPart

Method Index

Data Member Index

Methods

Data Members