All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPlantShipInterfaces Interface CATIPspResource

System.IUnknown
  |
  +---CATIPspResource
 

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


interface CATIPspResource

Interface to get application resources.
Role: Get application resources.


Method Index


o GetAnnotationCatalogPath(CATUnicodeString&,CATUnicodeString&)
Get the Annotation catalog.
o GetCableClearanceValue(double&)
Get the cable clearance value.
o GetCntrAttrFileName(CATUnicodeString&,CATUnicodeString&)
Get the Connector Attribute file name.
o GetComputedAttrFileName(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Get the Computed Attribute file name.
o GetDesignRulesCatalogPath(CATUnicodeString&,CATUnicodeString&)
Get the Design Rules catalog.
o GetDisciplineClassesFileName(CATUnicodeString&,CATUnicodeString&)
Get the discipline super classes file name.
o GetDiscreteValuesDir(CATUnicodeString&,CATUnicodeString&)
Get the Discrete Values directory.
o GetFunctionDrivenFlag(CATUnicodeString&)
Get the Function Driven flag default value.
o GetGraphicNamesDir(CATUnicodeString&,CATUnicodeString&)
Get the Schematic graphic names directory.
o GetGraphicRepFileName(CATUnicodeString&,CATUnicodeString&)
Get the Graphic Representaion file name.
o GetGrowthFactorValue(double&)
Get the growth factor value.
o GetIDSchemaDir(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Get the ID Schema directory.
o GetIDSequenceNumberDir(CATUnicodeString&,CATUnicodeString&)
Get the ID sequence number definition directory.
o GetInsulationSpecCatalogPath(CATUnicodeString&,CATUnicodeString&)
Get the Insulation Specification catalog.
o GetLineCatalogPath(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Get the logical line catalog.
o GetOffsheetCatalogPath(CATUnicodeString&,CATUnicodeString&)
Get the on/off sheet symbol catalog.
o GetPartCatalogPath(CATUnicodeString&,CATUnicodeString&)
Get the Part catalog.
o GetReportDefinitionDir(CATUnicodeString&,CATUnicodeString&)
Get the Report Definition directory.
o GetResolvedPartCatalogDir(CATUnicodeString&,CATUnicodeString&)
Get the Resolved Part catalog.
o GetResourcePath(CATUnicodeString&,CATUnicodeString&)
Get the path of a resource.
o GetResourceValue(CATUnicodeString&,CATUnicodeString&)
Get the value defined for a resource.
o GetSchematicDrivenFlag(CATUnicodeString&,CATUnicodeString&)
Get the Schematic Driven flag default value.
o GetSpecificationCatalogPath(CATUnicodeString&,CATUnicodeString&)
Get the Specification catalog.
o GetStandardsCatalogPath(CATUnicodeString&,CATUnicodeString&)
Get the Standards catalog.
o GetUserDictFileName(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Get the User dictionary file name.
o GetZoneCatalogPath(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Get the zone catalog.
o OpenResource(CATUnicodeString&,CATDocument*&)
Open the document associated to the resource.

Methods


o GetAnnotationCatalogPath
public virtual HRESULT GetAnnotationCatalogPath(CATUnicodeString& oPath,
CATUnicodeString& oResourceName)= 0
Get the Annotation catalog.
Parameters:
oPath
Annotation catalog path.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetCableClearanceValue
public virtual HRESULT GetCableClearanceValue(double& oCableClearance)= 0
Get the cable clearance value.
Parameters:
oCableClearance
Cable clearance value.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetCntrAttrFileName
public virtual HRESULT GetCntrAttrFileName(CATUnicodeString& oFileName,
CATUnicodeString& oResourceName)= 0
Get the Connector Attribute file name.
Parameters:
oFileName
Connector Attribute file name.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetComputedAttrFileName
public virtual HRESULT GetComputedAttrFileName( const CATUnicodeString& iDomainName,
CATUnicodeString& oFileName,
CATUnicodeString& oResourceName)= 0
Get the Computed Attribute file name.
Parameters:
iDomainName
Domain Name.
oFileName
Computed attribute file name.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetDesignRulesCatalogPath
public virtual HRESULT GetDesignRulesCatalogPath(CATUnicodeString& oPath,
CATUnicodeString& oResourceName)= 0
Get the Design Rules catalog.
Parameters:
oPath
Design Rules catalog path.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetDisciplineClassesFileName
public virtual HRESULT GetDisciplineClassesFileName(CATUnicodeString& oFileName,
CATUnicodeString& oResourceName)= 0
Get the discipline super classes file name.
Parameters:
oFileName
Discipline super classes file name.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetDiscreteValuesDir
public virtual HRESULT GetDiscreteValuesDir(CATUnicodeString& oDirectory,
CATUnicodeString& oResourceName)= 0
Get the Discrete Values directory.
Parameters:
oDirectory
Discrete Values directory.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetFunctionDrivenFlag
public virtual HRESULT GetFunctionDrivenFlag(CATUnicodeString& oFlagValue)= 0
Get the Function Driven flag default value.
Parameters:
oFlagValue
Function driven flag value = On or Off
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetGraphicNamesDir
public virtual HRESULT GetGraphicNamesDir(CATUnicodeString& oDirectory,
CATUnicodeString& oResourceName)= 0
Get the Schematic graphic names directory.
Parameters:
oPath
Graphic names directory.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetGraphicRepFileName
public virtual HRESULT GetGraphicRepFileName(CATUnicodeString& oFileName,
CATUnicodeString& oResourceName)= 0
Get the Graphic Representaion file name.
Parameters:
oFileName
Graphic Representaion file name.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetGrowthFactorValue
public virtual HRESULT GetGrowthFactorValue(double& oGrowthFactor)= 0
Get the growth factor value.
Parameters:
oGrowthFactor
Growth factor value.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetIDSchemaDir
public virtual HRESULT GetIDSchemaDir( const CATUnicodeString& iDomainName,
CATUnicodeString& oDirectory,
CATUnicodeString& oResourceName)= 0
Get the ID Schema directory.
Parameters:
iDomainName
Domain Name.
oDirectory
ID Schema directory.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetIDSequenceNumberDir
public virtual HRESULT GetIDSequenceNumberDir(CATUnicodeString& oDirectory,
CATUnicodeString& oResourceName)= 0
Get the ID sequence number definition directory.
Parameters:
oDirectory
ID sequence number definition directory.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetInsulationSpecCatalogPath
public virtual HRESULT GetInsulationSpecCatalogPath(CATUnicodeString& oPath,
CATUnicodeString& oResourceName)= 0
Get the Insulation Specification catalog.
Parameters:
oPath
Insulation Specification catalog path.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetLineCatalogPath
public virtual HRESULT GetLineCatalogPath( const CATUnicodeString& iClassType,
CATUnicodeString& oPath,
CATUnicodeString& oResourceName)= 0
Get the logical line catalog.
Parameters:
iClassType
Logical line class type.
oPath
Logical line catalog path.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetOffsheetCatalogPath
public virtual HRESULT GetOffsheetCatalogPath(CATUnicodeString& oPath,
CATUnicodeString& oResourceName)= 0
Get the on/off sheet symbol catalog.
Parameters:
oPath
On/off sheet catalog path.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetPartCatalogPath
public virtual HRESULT GetPartCatalogPath(CATUnicodeString& oPath,
CATUnicodeString& oResourceName)= 0
Get the Part catalog.
Parameters:
oPath
Part catalog path.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetReportDefinitionDir
public virtual HRESULT GetReportDefinitionDir(CATUnicodeString& oDirectory,
CATUnicodeString& oResourceName)= 0
Get the Report Definition directory.
Parameters:
oDirectory
Report Definition directory.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetResolvedPartCatalogDir
public virtual HRESULT GetResolvedPartCatalogDir(CATUnicodeString& oDirectory,
CATUnicodeString& oResourceName)= 0
Get the Resolved Part catalog.
Parameters:
oDirectory
Resolved Part catalog directory.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetResourcePath
public virtual HRESULT GetResourcePath( const CATUnicodeString& iResourceName,
CATUnicodeString& oPath)= 0
Get the path of a resource.
Parameters:
iResourceName
Resource Name.
oPath
Resource path.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetResourceValue
public virtual HRESULT GetResourceValue( const CATUnicodeString& iResourceName,
CATUnicodeString& oValue)= 0
Get the value defined for a resource.
Parameters:
iResourceName
Resource Name.
oValue
Resource value.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetSchematicDrivenFlag
public virtual HRESULT GetSchematicDrivenFlag(CATUnicodeString& oFlagValue,
CATUnicodeString& oResourceName)= 0
Get the Schematic Driven flag default value.
Parameters:
oFlagValue
Schematic driven flag value = On or Off
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetSpecificationCatalogPath
public virtual HRESULT GetSpecificationCatalogPath(CATUnicodeString& oPath,
CATUnicodeString& oResourceName)= 0
Get the Specification catalog.
Parameters:
oPath
Specification catalog path.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetStandardsCatalogPath
public virtual HRESULT GetStandardsCatalogPath(CATUnicodeString& oPath,
CATUnicodeString& oResourceName)= 0
Get the Standards catalog.
Parameters:
oPath
Standards catalog path.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetUserDictFileName
public virtual HRESULT GetUserDictFileName( const CATUnicodeString& iDomainName,
CATUnicodeString& oFileName,
CATUnicodeString& oResourceName)= 0
Get the User dictionary file name.
Parameters:
iDomainName
Domain Name.
oFileName
User dictionary file name.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetZoneCatalogPath
public virtual HRESULT GetZoneCatalogPath( const CATUnicodeString& iClassType,
CATUnicodeString& oPath,
CATUnicodeString& oResourceName)= 0
Get the zone catalog.
Parameters:
iClassType
Zone class type.
oPath
Zone catalog path.
oResourceName
Resource Name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o OpenResource
public virtual HRESULT OpenResource( const CATUnicodeString& iResourceName,
CATDocument*& opDocument)= 0
Open the document associated to the resource.
Parameters:
iResourceName
Resource Name.
opDocument
Document associated to the resource.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIPspResource.h

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