KnowledgeInterfaces Interface CATIAllowUserInfo
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIAllowUserInfo
Interface to associate comment and URLs to feature.
Role:
Objects responding to the CATIAllowUserInfo interface can be enriched with a comment or with URLs.
An Example of an URL is http://www.catia.com. It is a string containing an absolute path.
It is not managed as a link but as a string.
This interface offers the services to manage these informations: add, remove, scan.
Method Index
- o
GetComment()
- Returns the comment associated to the instance.
- o
GetNameOfURL(CATUnicodeString&)
- Returns the name of a given url associated to the instance.
- o
GetNameOfURLs()
- Returns the list of URL's name/title associated to the instance.
- o
GetURL(CATUnicodeString&)
- Returns the URL with a given name/title associated to the instance.
- o
GetURLs()
- Returns the list of URLs associated to the instance.
- o
RemoveURL(int&)
- Removes an URL from the list of URLs associated to the instance by its position.
- o
RemoveURL(CATUnicodeString&)
- Removes an URL associated to the instance.
- o
RemoveURLByName(CATUnicodeString&)
- Removes an URL associated to the instance by name.
- o
SetComment(CATUnicodeString&)
- Sets the comment associated to the instance.
- o
SetURL(CATUnicodeString&,CATUnicodeString&,int)
- Adds an URL to the list of URLs associated to the instance.
Methods
o GetComment
| public virtual GetComment( | ) |
-
Returns the comment associated to the instance.
- Returns:
- the string of the comment.
o GetNameOfURL
| public virtual GetNameOfURL( | | iurl) |
-
Returns the name of a given url associated to the instance.
The name of the URL is specified during the association with the
method.
- Parameters:
-
- iurl
- URL of which you want the name.
- Returns:
- the URL's name.
o GetNameOfURLs
| public virtual GetNameOfURLs( | ) |
-
Returns the list of URL's name/title associated to the instance.
The name of the URL is specified during the association with the
method. You have to delete the list.
- Returns:
- the list of URL's name.
o GetURL
| public virtual GetURL( | | iname) |
-
Returns the URL with a given name/title associated to the instance.
The name of the URL is specified during the association with the
method.
- Parameters:
-
- iname
- the name of the URL you want to get.
- Returns:
- the string URL.
o GetURLs
-
Returns the list of URLs associated to the instance.
You have to delete the list.
- Returns:
- the list of URLs.
o RemoveURL
| public virtual RemoveURL( | | iposition) |
-
Removes an URL from the list of URLs associated to the instance by its position.
- Parameters:
-
- iposition
- the index of the URL in the list.
o RemoveURL
| public virtual RemoveURL( | const | iurl) |
-
Removes an URL associated to the instance.
- Parameters:
-
- iurl
- the URL you want to remove.
o RemoveURLByName
| public virtual RemoveURLByName( | const | iname) |
-
Removes an URL associated to the instance by name.
The name of the URL is specified during the association with the
method.
- Parameters:
-
- iname
- the name of the URL you want to remove.
o SetComment
| public virtual SetComment( | const | iComment) |
-
Sets the comment associated to the instance.
- Parameters:
-
- iComment
- the string you want to associate as a comment.
o SetURL
| public virtual SetURL( | const | iurl, |
| const | iname, |
| | iindex | = 0) |
-
Adds an URL to the list of URLs associated to the instance.
- Parameters:
-
- iurl
- the URL you want to add into the list of URLs.
- iname
- the name/title of the new URL.
- iindex
- the position of the URL in the list of URLs. Its default value 0 puts the URL at end of the list.
This object is included in the file: CATIAllowUserInfo.h
If needed, your Imakefile.mk should include the module: KnowledgeItf
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.