All Frameworks  Class Hierarchy  This Framework  Indexes   

CATPDMReconcile Class CATScmPDMObject

Usage: you must use this class as is. You should never derive it.


public class CATScmPDMObject

Information on a Object stored on VPDM Repository.
Role: Information on a Object stored on VPDM Repository in context of reconciliation operation. This class must be used in conjonction with CATScmObject.


Constructor and Destructor Index


o CATScmPDMObject(CATScmPDMObject&)
Constructs a Reconciliation object.
o CATScmPDMObject(CATPPRHubObjectDescriptor&,CATListValCATUnicodeString&)
Constructs a PDM object.
o ~CATScmPDMObject()

Method Index


o GetDescriptor(CATPPRHubObjectDescriptor**)
Gets access to the PDM object.
o GetDocId(CATIDocId*&)
Short role of the method.
o GetEnvironment()
Return the underlying environement of the PDMObject.
o GetExpositionMode()
Gets object exposition mode.
o GetFileExtension()
Gets File extension.
o GetLockOwner(int&)
Gets lock information.
o GetMaturityFreezeStatus()
Gets maturity freezed status.
o GetPdmName(CATUnicodeString&)
Gets PDM Id.
o GetPdmTimeStamp()
Gets VPDM object Timestamp.
o GetPdmType(CATUnicodeString&)
Gets PDM Type.
o GetPdmTypeAlias(CATUnicodeString&)
Gets PDM alias Type name.
o GetSequencePdmId(SEQUENCE(octet)&)
o GetSiteOwnership(int&)
Gets site ownership information.
o GetValues(CATListValCATUnicodeString&)
Gets list of Attribute values of a VPDM object.
o SetDescriptor(CATPPRHubObjectDescriptor*)
Sets access to the PDM object.
o SetExpositionMode(int)
Sets object exposition mode.
o SetFileExtension(CATUnicodeString&)
Sets File extension.
o SetLockOwner(int,CATUnicodeString&)
Sets lock information.
o SetMaturityFreezeStatus(int)
Sets maturity freezed status.
o SetPdmTimeStamp(CATTime&)
Sets VPDM object Timestamp.
o SetSiteOwnership(int,CATUnicodeString&)
Sets site ownership information.
o SetValues(CATListValCATUnicodeString&)
Sets list of Attribute values of a VPDM object.
o operator =(CATScmPDMObject&)
o operator ==(CATScmPDMObject&)

Constructor and Destructor


o CATScmPDMObject
public CATScmPDMObject( const )
Constructs a Reconciliation object.
Role: Constructs a Reconciliation object from one CATIA object.
Parameters:
iRecObj
CATIA Object.
o CATScmPDMObject
public CATScmPDMObject( iHubDesc,
iAttrValues)
Constructs a PDM object.
Role: Constructs a PDM object. Used in context of a Criterion as result of queries.
Parameters:
iHubDesc
VPDM Object descriptor (VPDM identification).
iAttrValues
List of attribute values as string (
CATIPDMCriterionScm ).
o ~CATScmPDMObject
public virtual ~CATScmPDMObject()

Methods


o GetDescriptor
public GetDescriptor( ixDesc)
Gets access to the PDM object. Role: Gets access to the PDM object in VPDM repository.
Post-condition: Result must not to be deleted by the caller
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
ixDesc
PDM descriptor (
CATPPRHubObjectDescriptor ).
o GetDocId
public GetDocId( oDocId)
Short role of the method.
Role: returned the CATIDocId of current PDMObject (if a doc...)
Parameters:
oDocId
[out, CATBaseUnknown#Release] The CATIDocId corresponding ot this, if this is mapping a document (NULL elsewhere) Pointer must be intialized to NULL prior to call the method
Returns:
E_INVALIDARG if oDocId was not intially set to NULL E_UNEXPECTED if this is not a PDMDocument E_FAIL if cannot collect all needed data to build CATIDocID S_OK if everything ran ok, otherwise...
o GetEnvironment
public GetEnvironment()
Return the underlying environement of the PDMObject.
Role: retunr the environment (LateType)
Returns:
The string containing the environment
o GetExpositionMode
public GetExpositionMode()
Gets object exposition mode.
Role: Gets object exposition mode. It enables to know if an object is Structure exposed (managed by ENOVIA) or Publication exposed (managed by CATIA).
Returns:
Identify object exposition mode.
Legal values:
0
No information about exposition mode.
1
Object in Publication exposed (managed by CATIA).
2
Object Structure exposed (managed by ENOVIA).
o GetFileExtension
public GetFileExtension()
Gets File extension.
Role: Gets File extension such as CATPart, model and so on.
Returns:
Returns file extension for a document (blank otherwise).
o GetLockOwner
public GetLockOwner( onLockStatus)
Gets lock information.
Role: Gets if object is locked and by whom it is locked.
Parameters:
onLockStatus
Identify lock status.
Legal values:
-1
Lock status not set.
0
Object not lock by anybody.
1
Object lock by current connected user.
2
Object lock by another user.
Returns:
User that has locked the object.
o GetMaturityFreezeStatus
public GetMaturityFreezeStatus()
Gets maturity freezed status.
Role: Gets maturity freezed status. It enables to know if maturity has reached a level that forbid modification of it.
Returns:
Identify if object has been frozen.
Legal values:
-1
No information about maturity status.
0
Object maturity authorizes modification.
1
Object maturity forbid object modification.
o GetPdmName
public GetPdmName( ocPdmId)
Gets PDM Id.
Role: Gets PDM Id.
Returns:
Returns error code
Parameters:
ocPdmId
PDM Type.
o GetPdmTimeStamp
public GetPdmTimeStamp()
Gets VPDM object Timestamp.
Role: Gets VPDM object Timestamp.
Returns:
Returns VPDM time stamp of this object
o GetPdmType
public GetPdmType( ocPdmType)
Gets PDM Type.
Role: Gets PDM type used in CATIA Log.
Returns:
Returns error code
Parameters:
ocPdmType
PDM Type.
o GetPdmTypeAlias
public GetPdmTypeAlias( ocPdmAliasType)
Gets PDM alias Type name.
Role: Gets PDM alias Type name.
Returns:
Returns error code
Parameters:
ocPdmAliasType
PDM Alias Type name.
o GetSequencePdmId
public GetSequencePdmId( osId)
o GetSiteOwnership
public GetSiteOwnership( onSiteOwnerStatus)
Gets site ownership information.
Role: Gets site ownership information to identify if an object has been shared with another location (replication). It enables also to know if object is editable or not on local sites.
Parameters:
onSiteOwnerStatus
Identify if object has been shared.
Legal values:
-1
No information about Site Ownership.
0
Object owned locally (could be edit on this site).
1
Object owned by another site, thus could not be modified on this site.
Returns:
Site owning this object (empty is owned locallly).
o GetValues
public GetValues( oAttrValues)
Gets list of Attribute values of a VPDM object. Role: Gets list of Attribute values of a VPDM object.
Those information are filled by the execution of a Criterion on a CATScmObject. The name of Attributes are found on CATScmObject.
Pre-condition: Assumes that the address of an already built CATLISTP(CATIPDMCriterionScm ) is passed.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
oAttrValues
List of values (
CATIPDMCriterionScm ).
o SetDescriptor
public SetDescriptor( oxDesc)
Sets access to the PDM object. Role: Sets access to the PDM object in VPDM repository.
Post-condition: Input descriptor is dupplicated by this method, so it must be deleted by the caller.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
oxDesc
PDM descriptor (
CATPPRHubObjectDescriptor ).
o SetExpositionMode
public SetExpositionMode( inExpositionMode)
Sets object exposition mode.
Role: Sets object exposition mode. It enables to know if an object is Structure exposed (managed by ENOVIA) or Publication exposed (managed by CATIA).
Returns:
Returns error code
Parameters:
inExpositionMode
Identify object exposition mode.
Legal values:
0
No information about exposition mode.
1
Object in Publication exposed (managed by CATIA).
2
Object Structure exposed (managed by ENOVIA).
o SetFileExtension
public SetFileExtension( const icFileExtension)
Sets File extension.
Role: Sets File extension such as CATPart, model and so on.
Returns:
Returns error code
Parameters:
icFileExtension
File extension.
o SetLockOwner
public SetLockOwner( inLockStatus,
const icLockOwner)
Sets lock information.
Role: Sets if object is locked and by whom it is locked.
Returns:
Returns error code
Parameters:
inLockStatus
Identify lock status.
Legal values:
-1
Lock status not set.
0
Object not lock by anybody.
1
Object lock by current connected user.
2
Object lock by another user.
icLockOwner
User that has locked the object.
o SetMaturityFreezeStatus
public SetMaturityFreezeStatus( inMaturityStatus)
Sets maturity freezed status.
Role: Sets maturity freezed status. It enables to know if maturity has reached a level that forbid modification of it.
Returns:
Returns error code
Parameters:
inMaturityStatus
Identify if object has been frozen.
Legal values:
-1
No information about maturity status.
0
Object maturity authorizes modification.
1
Object maturity forbid object modification.
o SetPdmTimeStamp
public SetPdmTimeStamp( const itTimeStamp)
Sets VPDM object Timestamp.
Role: Sets VPDM object Timestamp.
Returns:
Returns error code
Parameters:
itTimeStamp
VPMD timestamp.
o SetSiteOwnership
public SetSiteOwnership( inSiteOwnerStatus,
const icSiteOwnership)
Sets site ownership information.
Role: Sets site ownership information to identify if an object has been shared with another location (replication). It enables also to know if object is editable or not on local sites.
Returns:
Returns error code
Parameters:
inSiteOwnerStatus
Identify if object has been shared.
Legal values:
-1
No information about Site Ownership.
0
Object owned locally (could be edit on this site).
1
Object owned by another site, thus could not be modified on this site.
icSiteOwnership
Site owning this object (empty is owned locallly).
o SetValues
public SetValues( const iAttrValues)
Sets list of Attribute values of a VPDM object. Role: Sets list of Attribute values of a VPDM object.
Returns:
Method return code
Legal values: Returns S_OK if operation runs well.
Parameters:
iAttrValues
List of values.
o operator =
public operator =( const )
o operator ==
public operator ==( const )

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

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