DELTimeAnalysisAsIsItf Interface DELITimeAnalysisAuth
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface DELITimeAnalysisAuth
Interface to author the Time Analysis model.
Method Index
- o
CreateTimeAnalysis(CATIPLMNavOccurrence_var&,CATBaseUnknown_var&)
- Creates a Time Analysis reference.
- o
CreateTimeAnalysisLines(CATBaseUnknown_var&,int)
- Creates empty Time Analysis Lines
- o
DeleteTimeAnalysis(CATBaseUnknown_var&)
- Deletes a Time Analysis reference.
- o
GetNumberOfTimeAnalysisLines(CATBaseUnknown_var&,int&)
- Get number of Time Analysis Lines
- o
GetTimeAnalysisLineProperty(CATBaseUnknown_var&,int,DELTimeAnalysisLineProperty&,int&)
- Gets the value of a Time Analysis Line property of integer type.
- o
GetTimeAnalysisLineProperty(CATBaseUnknown_var&,int,DELTimeAnalysisLineProperty&,double&)
- Gets the value of a Time Analysis Line property of double type.
- o
GetTimeAnalysisLineProperty(CATBaseUnknown_var&,int,DELTimeAnalysisLineProperty&,CATUnicodeString&)
- Gets the value of a Time Analysis Line property of string type.
- o
GetTimeAnalysisProperty(CATBaseUnknown_var&,DELTimeAnalysisProperty&,int&)
- Get Value of Time Analysis property of integer type
- o
GetTimeAnalysisProperty(CATBaseUnknown_var&,DELTimeAnalysisProperty&,double&)
- Get Value of Time Analysis property of double type
- o
GetTimeAnalysisProperty(CATBaseUnknown_var&,DELTimeAnalysisProperty&,CATUnicodeString&)
- Get Value of Time Analysis property of string type
- o
RemoveAllTimeAnalysisLines(CATBaseUnknown_var&)
- Remove Time Analysis Lines
- o
SetTimeAnalysisLineProperty(CATBaseUnknown_var&,int,DELTimeAnalysisLineProperty&,int)
- Assigns the value for a Time Analysis Line property of integer type
- o
SetTimeAnalysisLineProperty(CATBaseUnknown_var&,int,DELTimeAnalysisLineProperty&,double)
- Assigns the value for a Time Analysis Line property of double type
- o
SetTimeAnalysisLineProperty(CATBaseUnknown_var&,int,DELTimeAnalysisLineProperty&,CATUnicodeString&)
- Assigns the value for a Time Analysis Line property of string type
- o
SetTimeAnalysisProperty(CATBaseUnknown_var&,DELTimeAnalysisProperty&,int)
- Assigns value to Time Analysis property of integer type
- o
SetTimeAnalysisProperty(CATBaseUnknown_var&,DELTimeAnalysisProperty&,double)
- Assigns value to Time Analysis property of double type
- o
SetTimeAnalysisProperty(CATBaseUnknown_var&,DELTimeAnalysisProperty&,CATUnicodeString&)
- Assigns value to Time Analysis property of String type
Methods
o CreateTimeAnalysis
public virtual CreateTimeAnalysis( | const | ihOperation, |
| | ohTimeAnalysisRepRef) |
-
Creates a Time Analysis reference.
- Parameters:
-
- ihOperation
- The operation under which the time analysis needs to be aggregated.
- ohTimeAnalysisReference
- The created Time Analysis reference
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- if the type is not valid
E_NOINTERFACE
- if the requested interface is not implemented on the resulting object
E_FAIL
- if the method fails for any other reason
o CreateTimeAnalysisLines
public virtual CreateTimeAnalysisLines( | const | ihTimeAnalysis, |
| | iNumTALines) |
-
Creates empty Time Analysis Lines
- Parameters:
-
- ihTimeAnalysis
- The Time Analysis reference
- iNumTALines
- Number of Time Analysis lines to be created
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o DeleteTimeAnalysis
public virtual DeleteTimeAnalysis( | const | ihOperation) |
-
Deletes a Time Analysis reference.
- Parameters:
-
- ihOperation
- The operation from which the time analysis needs to be deleted. *
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- if the type is not valid
E_NOINTERFACE
- if the requested interface is not implemented on the resulting object
E_FAIL
- if the method fails for any other reason
o GetNumberOfTimeAnalysisLines
public virtual GetNumberOfTimeAnalysisLines( | const | ihTimeAnalysis, |
| | oNumTALLines) |
-
Get number of Time Analysis Lines
- Parameters:
-
- ihTimeAnalysis
- The Time Analysis reference
- oNumTALLines
- Number of Time Analysis Lines
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o GetTimeAnalysisLineProperty
public virtual GetTimeAnalysisLineProperty( | const | ihTimeAnalysisLine, |
| | iTALineId, |
| const | iTALProperty, |
| | oValue) |
-
Gets the value of a Time Analysis Line property of integer type.
- Parameters:
-
- ihTimeAnalysis
- The Time Analysis Reference
- iTALineId
- The Index of Time Analysis Line
Legal values: Any value greater than or equal to 1
- iTALProperty
- The Time Analysis Line Property
- oValue
- The value of property
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o GetTimeAnalysisLineProperty
public virtual GetTimeAnalysisLineProperty( | const | ihTimeAnalysisLine, |
| | iTALineId, |
| const | iTALProperty, |
| | oValue) |
-
Gets the value of a Time Analysis Line property of double type.
- Parameters:
-
- ihTimeAnalysis
- The Time Analysis Reference
- iTALineId
- The Index of Time Analysis Line
Legal values: Any value greater than or equal to 1
- iTALProperty
- The Time Analysis Line Property
- oValue
- The value of property
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o GetTimeAnalysisLineProperty
public virtual GetTimeAnalysisLineProperty( | const | ihTimeAnalysisLine, |
| | iTALineId, |
| const | iTALProperty, |
| | oValue) |
-
Gets the value of a Time Analysis Line property of string type.
- Parameters:
-
- ihTimeAnalysis
- The Time Analysis Reference
- iTALineId
- The Index of Time Analysis Line
Legal values: Any value greater than or equal to 1
- iTALProperty
- The Time Analysis Line Property
- oValue
- The value of property
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o GetTimeAnalysisProperty
public virtual GetTimeAnalysisProperty( | const | ihTimeAnalysis, |
| const | iProperty, |
| | oValue) |
-
Get Value of Time Analysis property of integer type
- Parameters:
-
- ihTimeAnalysis
- The Time Analysis reference
- iProperty
- The type of property
- oValue
- The value of property
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o GetTimeAnalysisProperty
public virtual GetTimeAnalysisProperty( | const | ihTimeAnalysis, |
| const | iProperty, |
| | oValue) |
-
Get Value of Time Analysis property of double type
- Parameters:
-
- ihTimeAnalysis
- The Time Analysis reference
- iProperty
- The type of property
- oValue
- The value of property
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o GetTimeAnalysisProperty
public virtual GetTimeAnalysisProperty( | const | ihTimeAnalysis, |
| const | iProperty, |
| | oValue) |
-
Get Value of Time Analysis property of string type
- Parameters:
-
- ihTimeAnalysis
- The Time Analysis reference
- iProperty
- The type of property
- oValue
- The value of property
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o RemoveAllTimeAnalysisLines
public virtual RemoveAllTimeAnalysisLines( | const | ihTimeAnalysis) |
-
Remove Time Analysis Lines
- Parameters:
-
- ihTimeAnalysis
- The Time Analysis reference
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o SetTimeAnalysisLineProperty
public virtual SetTimeAnalysisLineProperty( | const | ihTimeAnalysis, |
| | iTALineId, |
| const | iTALProperty, |
| | iValue) |
-
Assigns the value for a Time Analysis Line property of integer type
- Parameters:
-
- ihTimeAnalysisLine
- The Time Analysis Line
- iTALineId
- The Index of Time Analysis Line
Legal values: Any value greater than or equal to 1
- iTALProperty
- The Time Analysis Line Property
- iValue
- The value of property
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o SetTimeAnalysisLineProperty
public virtual SetTimeAnalysisLineProperty( | const | ihTimeAnalysis, |
| | iTALineId, |
| const | iTALProperty, |
| | iValue) |
-
Assigns the value for a Time Analysis Line property of double type
- Parameters:
-
- ihTimeAnalysisLine
- The Time Analysis Line
- iTALineId
- The Index of Time Analysis Line
Legal values: Any value greater than or equal to 1
- iTALProperty
- The Time Analysis Line Property
- iValue
- The value of property
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o SetTimeAnalysisLineProperty
public virtual SetTimeAnalysisLineProperty( | const | ihTimeAnalysis, |
| | iTALineId, |
| const | iTALProperty, |
| const | iValue) |
-
Assigns the value for a Time Analysis Line property of string type
- Parameters:
-
- ihTimeAnalysisLine
- The Time Analysis Line
- iTALineId
- The Index of Time Analysis Line
Legal values: Any value greater than or equal to 1
- iTALProperty
- The Time Analysis Line Property
- iValue
- The value of property
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o SetTimeAnalysisProperty
public virtual SetTimeAnalysisProperty( | const | ihTimeAnalysis, |
| const | iProperty, |
| | iValue) |
-
Assigns value to Time Analysis property of integer type
- Parameters:
-
- ihTimeAnalysis
- The Time Analysis reference
- iProperty
- The type of property
- iValue
- The value of property
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o SetTimeAnalysisProperty
public virtual SetTimeAnalysisProperty( | const | ihTimeAnalysis, |
| const | iProperty, |
| | iValue) |
-
Assigns value to Time Analysis property of double type
- Parameters:
-
- ihTimeAnalysis
- The Time Analysis reference
- iProperty
- The type of property
- iValue
- The value of property
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
o SetTimeAnalysisProperty
public virtual SetTimeAnalysisProperty( | const | ihTimeAnalysis, |
| const | iProperty, |
| const | iValue) |
-
Assigns value to Time Analysis property of String type
- Parameters:
-
- ihTimeAnalysis
- The Time Analysis reference
- iProperty
- The type of property
- iValue
- The value of property
- Returns:
-
S_OK
- if the method succeeds
E_INVALIDARG
- for an invalid argument
E_FAIL
- if the method fails for any other reason
This object is included in the file: DELITimeAnalysisAuth.h
If needed, your Imakefile.mk should include the module: DELTimeAnalysisAsIsItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.