All Frameworks Class Hierarchy This Framework Indexes
KnowledgeInterfaces Interface CATILieReportGenerationSheetSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATILieReportGenerationSheetSettingAtt
The interface to access a CATILieReportGenerationSheetSettingAtt.
This interface may be used to read or modify in the CATIA\Tools\Option the settings values
of Units sheet.
Method Index
- o
GetAllChecksReportInfo(CATSettingInfo*)
- Retrieves the state of the AllChecksReport parameter.
- o
GetAllChecksReport(int*)
- Retrieves the AllChecksReport attribute.
- o
GetCheckReportHtmlInfo(CATSettingInfo*)
- Retrieves the state of the CheckReportHtml parameter.
- o
GetCheckReportHtml(int*)
- Retrieves the CheckReportHtml attribute.
- o
GetDirectoryForInputXslInfo(CATSettingInfo*)
- Retrieves the state of the DirectoryForInputXsl parameter.
- o
GetDirectoryForInputXsl(CATUnicodeString&)
- Retrieves the DirectoryForInputXsl attribute.
- o
GetReportCheckAdvisorInfo(CATSettingInfo*)
- Retrieves the state of the ReportCheckAdvisor parameter.
- o
GetReportCheckAdvisor(int*)
- Retrieves the ReportCheckAdvisor attribute.
- o
GetReportCheckExpertInfo(CATSettingInfo*)
- Retrieves the state of the ReportCheckExpert parameter.
- o
GetReportCheckExpert(int*)
- Retrieves the ReportCheckExpert attribute.
- o
GetReportHtmlInCatiaSessionInfo(CATSettingInfo*)
- Retrieves the state of the ReportHtmlInCatiaSession parameter.
- o
GetReportHtmlInCatiaSession(int*)
- Retrieves the ReportHtmlInCatiaSession attribute.
- o
GetReportObjectsInformationInfo(CATSettingInfo*)
- Retrieves the state of the ReportObjectsInformation parameter.
- o
GetReportObjectsInformation(int*)
- Retrieves the ReportObjectsInformation attribute.
- o
GetReportOutputDirectoryInfo(CATSettingInfo*)
- Retrieves the state of the ReportOutputDirectory parameter.
- o
GetReportOutputDirectory(CATUnicodeString&)
- Retrieves the ReportOutputDirectory attribute.
- o
GetReportParametersInformationInfo(CATSettingInfo*)
- Retrieves the state of the ReportParametersInformation parameter.
- o
GetReportParametersInformation(int*)
- Retrieves the ReportParametersInformation attribute.
- o
GetReportPassedObjectsInfo(CATSettingInfo*)
- Retrieves the state of the ReportPassedObjects parameter.
- o
GetReportPassedObjects(int*)
- Retrieves the ReportPassedObjects attribute.
- o
SetAllChecksReportLock(unsigned char)
- Locks or unlocks the AllChecksReport parameter.
- o
SetAllChecksReport(int*)
- Sets the AllChecksReport attribute.
- o
SetCheckReportHtmlLock(unsigned char)
- Locks or unlocks the CheckReportHtml parameter.
- o
SetCheckReportHtml(int*)
- Sets the CheckReportHtml attribute.
- o
SetDirectoryForInputXslLock(unsigned char)
- Locks or unlocks the DirectoryForInputXsl parameter.
- o
SetDirectoryForInputXsl(CATUnicodeString&)
- Sets the DirectoryForInputXsl attribute.
- o
SetReportCheckAdvisorLock(unsigned char)
- Locks or unlocks the ReportCheckAdvisor parameter.
- o
SetReportCheckAdvisor(int*)
- Sets the ReportCheckAdvisor attribute.
- o
SetReportCheckExpertLock(unsigned char)
- Locks or unlocks the ReportCheckExpert parameter.
- o
SetReportCheckExpert(int*)
- Sets the ReportCheckExpert attribute.
- o
SetReportHtmlInCatiaSessionLock(unsigned char)
- Locks or unlocks the ReportHtmlInCatiaSession parameter.
- o
SetReportHtmlInCatiaSession(int*)
- Sets the ReportHtmlInCatiaSession attribute.
- o
SetReportObjectsInformationLock(unsigned char)
- Locks or unlocks the ReportObjectsInformation parameter.
- o
SetReportObjectsInformation(int*)
- Sets the ReportObjectsInformation attribute.
- o
SetReportOutputDirectoryLock(unsigned char)
- Locks or unlocks the ReportOutputDirectory parameter.
- o
SetReportOutputDirectory(CATUnicodeString&)
- Sets the ReportOutputDirectory attribute.
- o
SetReportParametersInformationLock(unsigned char)
- Locks or unlocks the ReportParametersInformation parameter.
- o
SetReportParametersInformation(int*)
- Sets the ReportParametersInformation attribute.
- o
SetReportPassedObjectsLock(unsigned char)
- Locks or unlocks the ReportPassedObjects parameter.
- o
SetReportPassedObjects(int*)
- Sets the ReportPassedObjects attribute.
Methods
o GetAllChecksReportInfo
| public virtual GetAllChecksReportInfo( | | oInfo) |
-
Retrieves the state of the AllChecksReport parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAllChecksReport
| public virtual GetAllChecksReport( | | ioAllChecksReport) |
-
Retrieves the AllChecksReport attribute.
Role:Return the AllChecksReport parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioAllChecksReport
- Legal values:
0 : report of only failed checks
1 : report of all checks.
o GetCheckReportHtmlInfo
| public virtual GetCheckReportHtmlInfo( | | oInfo) |
-
Retrieves the state of the CheckReportHtml parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetCheckReportHtml
| public virtual GetCheckReportHtml( | | ioCheckReportHtml) |
-
Retrieves the CheckReportHtml attribute.
Role:Return the CheckReportHtml parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioCheckReportHtml
- Legal values:
0 : to have check report in Xml
1 : to have check report in Html.
o GetDirectoryForInputXslInfo
| public virtual GetDirectoryForInputXslInfo( | | oInfo) |
-
Retrieves the state of the DirectoryForInputXsl parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDirectoryForInputXsl
| public virtual GetDirectoryForInputXsl( | | ioDirectoryForInputXsl) |
-
Retrieves the DirectoryForInputXsl attribute.
Role:Return the DirectoryForInputXsl parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- oDirectoryForInputXsl
- Directory for the report file with Xml extension.
o GetReportCheckAdvisorInfo
| public virtual GetReportCheckAdvisorInfo( | | oInfo) |
-
Retrieves the state of the ReportCheckAdvisor parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportCheckAdvisor
| public virtual GetReportCheckAdvisor( | | ioReportCheckAdvisor) |
-
Retrieves the ReportCheckAdvisor attribute.
Role:Return the ReportCheckAdvisor parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportCheckAdvisor
- Legal values:
0 : not report of check Advisor
1 : report of check Advisor.
o GetReportCheckExpertInfo
| public virtual GetReportCheckExpertInfo( | | oInfo) |
-
Retrieves the state of the ReportCheckExpert parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportCheckExpert
| public virtual GetReportCheckExpert( | | ioReportCheckExpert) |
-
Retrieves the ReportCheckExpert attribute.
Role:Return the ReportCheckExpert parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportCheckExpert
- Legal values:
0 : not report of check Advisor
1 : report of check Advisor.
o GetReportHtmlInCatiaSessionInfo
| public virtual GetReportHtmlInCatiaSessionInfo( | | oInfo) |
-
Retrieves the state of the ReportHtmlInCatiaSession parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportHtmlInCatiaSession
| public virtual GetReportHtmlInCatiaSession( | | ioReportHtmlInCatiaSession) |
-
Retrieves the ReportHtmlInCatiaSession attribute.
Role:Return the ReportHtmlInCatiaSession parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportHtmlInCatiaSession
- Legal values:
0 : report Html outside CATIA session
1 : report Html in CATIA session.
o GetReportObjectsInformationInfo
| public virtual GetReportObjectsInformationInfo( | | oInfo) |
-
Retrieves the state of the ReportObjectsInformation parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportObjectsInformation
| public virtual GetReportObjectsInformation( | | ioReportObjectsInformation) |
-
Retrieves the ReportObjectsInformation attribute.
Role:Return the ReportObjectsInformation parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportObjectsInformation
- Legal values:
0 : not report objects information
1 : report objects information.
o GetReportOutputDirectoryInfo
| public virtual GetReportOutputDirectoryInfo( | | oInfo) |
-
Retrieves the state of the ReportOutputDirectory parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportOutputDirectory
| public virtual GetReportOutputDirectory( | | ioReportOutputDirectory) |
-
Retrieves the ReportOutputDirectory attribute.
Role:Return the ReportOutputDirectory parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportOutputDirectory
- The output directory for report of checks expert and checks advisor.
o GetReportParametersInformationInfo
| public virtual GetReportParametersInformationInfo( | | oInfo) |
-
Retrieves the state of the ReportParametersInformation parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportParametersInformation
| public virtual GetReportParametersInformation( | | ioReportParametersInformation) |
-
Retrieves the ReportParametersInformation attribute.
Role:Return the ReportParametersInformation parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportParametersInformation
- Legal values:
0 : not check Advisor parameter information
1 : check Advisor parameter information.
o GetReportPassedObjectsInfo
| public virtual GetReportPassedObjectsInfo( | | oInfo) |
-
Retrieves the state of the ReportPassedObjects parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportPassedObjects
| public virtual GetReportPassedObjects( | | ioReportPassedObjects) |
-
Retrieves the ReportPassedObjects attribute.
Role:Return the ReportPassedObjects parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportPassedObjects
- Legal values:
0 : not report passed objects
1 : report passed objects.
o SetAllChecksReportLock
| public virtual SetAllChecksReportLock( | | iLocked) |
-
Locks or unlocks the AllChecksReport parameter.
Role: Locks or unlocks the AllChecksReport parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAllChecksReport
| public virtual SetAllChecksReport( | | iAllChecksReport) |
-
Sets the AllChecksReport attribute.
Role:Set the AllChecksReport parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iAllChecksReport
- Legal values:
0 : report of only failed checks
1 : report of all checks.
o SetCheckReportHtmlLock
| public virtual SetCheckReportHtmlLock( | | iLocked) |
-
Locks or unlocks the CheckReportHtml parameter.
Role: Locks or unlocks the CheckReportHtml parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetCheckReportHtml
| public virtual SetCheckReportHtml( | | iCheckReportHtml) |
-
Sets the CheckReportHtml attribute.
Role:Set the CheckReportHtml parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iCheckReportHtml
- Legal values:
0 : to have check report in Xml
1 : to have check report in Html.
o SetDirectoryForInputXslLock
| public virtual SetDirectoryForInputXslLock( | | iLocked) |
-
Locks or unlocks the DirectoryForInputXsl parameter.
Role: Locks or unlocks the DirectoryForInputXsl parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDirectoryForInputXsl
| public virtual SetDirectoryForInputXsl( | | iDirectoryForInputXsl) |
-
Sets the DirectoryForInputXsl attribute.
Role:Set the DirectoryForInputXsl parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- oDirectoryForInputXsl
- Directory for the report file with Xml extension.
o SetReportCheckAdvisorLock
| public virtual SetReportCheckAdvisorLock( | | iLocked) |
-
Locks or unlocks the ReportCheckAdvisor parameter.
Role: Locks or unlocks the ReportCheckAdvisor parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetReportCheckAdvisor
| public virtual SetReportCheckAdvisor( | | iReportCheckAdvisor) |
-
Sets the ReportCheckAdvisor attribute.
Role:Set the ReportCheckAdvisor parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportCheckAdvisor
- Legal values:
0 : not report of check Advisor
1 : report of check Advisor.
o SetReportCheckExpertLock
| public virtual SetReportCheckExpertLock( | | iLocked) |
-
Locks or unlocks the ReportCheckExpert parameter.
Role: Locks or unlocks the ReportCheckExpert parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetReportCheckExpert
| public virtual SetReportCheckExpert( | | iReportCheckExpert) |
-
Sets the ReportCheckExpert attribute.
Role:Set the ReportCheckExpert parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportCheckExpert
- Legal values:
0 : not report of check Advisor
1 : report of check Advisor.
o SetReportHtmlInCatiaSessionLock
| public virtual SetReportHtmlInCatiaSessionLock( | | iLocked) |
-
Locks or unlocks the ReportHtmlInCatiaSession parameter.
Role: Locks or unlocks the ReportHtmlInCatiaSession parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetReportHtmlInCatiaSession
| public virtual SetReportHtmlInCatiaSession( | | iReportHtmlInCatiaSession) |
-
Sets the ReportHtmlInCatiaSession attribute.
Role:Set the ReportHtmlInCatiaSession parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportHtmlInCatiaSession
- Legal values:
0 : report Html outside CATIA session
1 : report Html in CATIA session.
o SetReportObjectsInformationLock
| public virtual SetReportObjectsInformationLock( | | iLocked) |
-
Locks or unlocks the ReportObjectsInformation parameter.
Role: Locks or unlocks the ReportObjectsInformation parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetReportObjectsInformation
| public virtual SetReportObjectsInformation( | | iReportObjectsInformation) |
-
Sets the ReportObjectsInformation attribute.
Role:Set the ReportObjectsInformation parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportObjectsInformation
- Legal values:
0 : not report objects information
1 : report objects information.
o SetReportOutputDirectoryLock
| public virtual SetReportOutputDirectoryLock( | | iLocked) |
-
Locks or unlocks the ReportOutputDirectory parameter.
Role: Locks or unlocks the ReportOutputDirectory parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetReportOutputDirectory
| public virtual SetReportOutputDirectory( | | iReportOutputDirectory) |
-
Sets the ReportOutputDirectory attribute.
Role:Set the ReportOutputDirectory parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportOutputDirectory
- The output directory for report of checks expert and checks advisor.
o SetReportParametersInformationLock
| public virtual SetReportParametersInformationLock( | | iLocked) |
-
Locks or unlocks the ReportParametersInformation parameter.
Role: Locks or unlocks the ReportParametersInformation parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetReportParametersInformation
| public virtual SetReportParametersInformation( | | iReportParametersInformation) |
-
Sets the ReportParametersInformation attribute.
Role:Set the ReportParametersInformation parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportParametersInformation
- Legal values:
0 : not check Advisor parameter information
1 : check Advisor parameter information.
o SetReportPassedObjectsLock
| public virtual SetReportPassedObjectsLock( | | iLocked) |
-
Locks or unlocks the ReportPassedObjects parameter.
Role: Locks or unlocks the ReportPassedObjects parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetReportPassedObjects
| public virtual SetReportPassedObjects( | | iReportPassedObjects) |
-
Sets the ReportPassedObjects attribute.
Role:Set the ReportPassedObjects parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportPassedObjects
- Legal values:
0 : not report passed objects
1 : report passed objects.
This object is included in the file: CATILieReportGenerationSheetSettingAtt.h
If needed, your Imakefile.mk should include the module: KnowledgeItf