All Frameworks Class Hierarchy This Framework Previous Next Indexes
StructureInterfaces Interface CATIStructureMember
System.IUnknown
|
+---StructureInterfaces.CATIStructureObject
|
+---CATIStructureMember
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIStructureMember
Interface to manage the member information.
Role: To retrieve data from a member such as
member attributes, materials, start coordinates and
end coordinates.
Method Index
- o
Compute()
- Calculate the member object information.
- o
Flip()
- Flip the member's section profile orientation.
- o
GetAngle(CATICkeParm**)
- Get the member's orientation.
- o
GetCatalogName(CATUnicodeString&)
- Get the member section catalog name.
- o
GetCurrentSetPoint(CATUnicodeString&)
- Get the member's current anchor point.
- o
GetCurrentSetPoint(CatStrPlacementPoint&)
- Get the member's current anchor point.
- o
GetEndCoord(CATMathPoint&)
- Get the location for the member's end point.
- o
GetEndCutback(CatStrCutbackType&,CATICkeParm**)
- Get the member end cutback type.
- o
GetEndOffset(CATICkeParm**)
- Get the offset for the member's end point.
- o
GetFamilyName(CATUnicodeString&)
- Get the member section family name.
- o
GetMemberLength(double&)
- Get the member's length.
- o
GetMemberReference(CATISpecObject**)
- Get the member section reference object.
- o
GetMemberSectionAxis(CATMathAxis&)
- Get the member section axis.
- o
GetMemberSupport(CATISpecObject**)
- Get the member support.
- o
GetProfileType(CATUnicodeString&)
- Get the member section profile type.
- o
GetSection(CATDocument*&)
- Get the member section profile document.
- o
GetSectionName(CATUnicodeString&)
- Get the member section name.
- o
GetSectionOrientation(CATMathVector&,CATMathVector&)
- Get the member's absolute orientation of the section.
- o
GetSectionOrientation(CatStrMaterialOrientation&)
- Get the member's section orientation.
- o
GetSideOrientation(CatStrMaterialOrientation&)
- Get the member's section side orientation.
- o
GetStartCoord(CATMathPoint&)
- Get the location for the member's start point.
- o
GetStartCutback(CatStrCutbackType&,CATICkeParm**)
- Get the member start cutback type.
- o
GetStartOffset(CATICkeParm**)
- Get the offset for the member's start point.
- o
ReplaceMemberSection(CATDocument*,CATUnicodeString,CATUnicodeString)
- Replace the current member section profile.
- o
SetAngle(double)
- Set the member's orientation.
- o
SetCurrentSetPoint(CATUnicodeString)
- Set the member's current anchor point.
- o
SetEndCoord(CATMathPoint)
- Set the location for the member's end point.
- o
SetMemberReference(CATISpecObject*)
- Set the member section reference object.
- o
SetMemberSupport(CATISpecObject*)
- Set the member object's support.
- o
SetSection(CATDocument*)
- Set the member section profile document.
- o
SetSectionOrientation(CATMathVector,CATMathVector)
- Set the member's absolute orientation of the section.
- o
SetSectionOrientation(CatStrMaterialOrientation&)
- Set the member's section orientation.
- o
SetSideOrientation(CatStrMaterialOrientation&)
- Set the member's section side orientation.
- o
SetStartCoord(CATMathPoint)
- Set the location for the member's start point.
Methods
o Compute
-
Calculate the member object information. It is only useful when creating a new
member, it is not necessary to use this method when modifying an existing member.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Flip
-
Flip the member's section profile orientation.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetAngle
-
Get the member's orientation.
- Parameters:
-
- CATICkeParm
- [out, CATICkeParm#Release] Returns the orientation of the section on the support object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetCatalogName
-
Get the member section catalog name.
- Parameters:
-
- CATUnicodeString
- Returns the parameter defining catalog name.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetCurrentSetPoint
-
Get the member's current anchor point.
- Parameters:
-
- CATUnicodeString
- Returns the current anchor point used to locate the section on the support object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetCurrentSetPoint
public virtual HRESULT GetCurrentSetPoint( | CatStrPlacementPoint& | oSetPoint)=0 |
-
Get the member's current anchor point.
- Parameters:
-
- CatStrPlacementPoint
- Returns the current anchor point used to locate the section on the support object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetEndCoord
-
Get the location for the member's end point.
- Parameters:
-
- CATMathPoint
- Returns the parameter defining the coordinates for the member's end point.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetEndCutback
-
Get the member end cutback type.
- Parameters:
-
- CatStrCutbackType
- Returns the parameter defining member's end cutback type.
- CATICkeParm
- [out, CATICkeParm#Release] Returns the parameter defining member's end cutback value.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetEndOffset
-
Get the offset for the member's end point.
- Parameters:
-
- CATICkeParm
- [out, CATICkeParm#Release] Returns the parameter defining the offset for the member's end point value.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetFamilyName
-
Get the member section family name.
- Parameters:
-
- CATUnicodeString
- Returns the parameter defining the section family name.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetMemberLength
public virtual HRESULT GetMemberLength( | double& | oLength)=0 |
-
Get the member's length.
- Parameters:
-
- double
- Returns the value of member's length.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetMemberReference
-
Get the member section reference object.
- Parameters:
-
- CATISpecObject
- Returns the member section reference object defining the orientation of the member.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetMemberSectionAxis
-
Get the member section axis.
- Parameters:
-
- CATMathAxis
- Returns the member section axis defining the positioning of the member.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetMemberSupport
-
Get the member support.
- Parameters:
-
- CATISpecObject
- [out, CATISpecObject#Release] Returns the member support as CATISpecObject.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetProfileType
-
Get the member section profile type.
- Parameters:
-
- CATUnicodeString
- Returns the parameter defining the section profile type.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetSection
-
Get the member section profile document.
- Parameters:
-
- CATDocument
- Returns the parameter defining the profile document
of the section.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetSectionName
-
Get the member section name.
- Parameters:
-
- CATUnicodeString
- Returns the parameter defining the section name.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetSectionOrientation
-
Get the member's absolute orientation of the section.
- Parameters:
-
- CATMathVector
- Returns the member's section absolute orientation on U.
- CATMathVector
- Returns the member's section absolute orientation on V.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetSectionOrientation
public virtual HRESULT GetSectionOrientation( | CatStrMaterialOrientation& | oSectionOrientation)=0 |
-
Get the member's section orientation.
- Parameters:
-
- CatStrMaterialOrientation
- Returns the member's section orientation on the support object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetSideOrientation
public virtual HRESULT GetSideOrientation( | CatStrMaterialOrientation& | oSideOrientation)=0 |
-
Get the member's section side orientation.
- Parameters:
-
- CatStrMaterialOrientation
- Returns the member's section side orientation on the support object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetStartCoord
-
Get the location for the member's start point.
- Parameters:
-
- CATMathPoint
- Returns the parameter defining the coordinates for the member's start point.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetStartCutback
-
Get the member start cutback type.
- Parameters:
-
- CatStrCutbackType
- Returns the parameter defining member's start cutback type.
- CATICkeParm
- [out, CATICkeParm#Release] Returns the parameter defining member's start cutback value.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetStartOffset
-
Get the offset for the member's start point.
- Parameters:
-
- CATICkeParm
- [out, CATICkeParm#Release] Returns the parameter defining the offset for the member's start point value.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ReplaceMemberSection
-
Replace the current member section profile.
- Parameters:
-
- CATDocument
- Inputs the parameter defining the profile document
of the section.
- CATUnicodeString
- Inputs the parameter defining the section catalog path.
- CATUnicodeString
- Inputs the parameter defining the section name.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetAngle
public virtual HRESULT SetAngle( | const double | iAngle)=0 |
-
Set the member's orientation.
- Parameters:
-
- double
- Inputs the orientation of the section on the support object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetCurrentSetPoint
-
Set the member's current anchor point.
- Parameters:
-
- CATUnicodeString
- Inputs the current anchor point used to locate the section on the support object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetEndCoord
-
Set the location for the member's end point. It is only useful when creating a new
member, it should not be used to change the end coordinate of an existing member.
- Parameters:
-
- CATMathPoint
- Inputs the parameter defining the coordinates for the member's end point.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetMemberReference
-
Set the member section reference object.
- Parameters:
-
- CATISpecObject
- inputs reference object defining the member section orientation.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetMemberSupport
-
Set the member object's support.
- Parameters:
-
- CATISpecObject
- inputs defining the member object's support.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetSection
-
Set the member section profile document. It is only useful when creating a new
member, it should not be used to repalce section of an existing member.
- Parameters:
-
- CATDocument
- Inputs the parameter defining the profile document
of the section.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetSectionOrientation
-
Set the member's absolute orientation of the section.
- Parameters:
-
- CATMathVector
- Inputs defining the member's section absolute orientation on U.
- CATMathVector
- Inputs defining the member's section absolute orientation on V.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetSectionOrientation
public virtual HRESULT SetSectionOrientation( | CatStrMaterialOrientation& | iSectionOrientation)=0 |
-
Set the member's section orientation.
- Parameters:
-
- CatStrMaterialOrientation
- Inputs the parameter defining the member's section orientation on the support object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetSideOrientation
public virtual HRESULT SetSideOrientation( | CatStrMaterialOrientation& | iSideOrientation)=0 |
-
Set the member's section side orientation.
- Parameters:
-
- CatStrMaterialOrientation
- Inputs the parameter defining the member's section side orientation on the support object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetStartCoord
-
Set the location for the member's start point. It is only useful when creating a new
member, it should not be used to change the end coordinate of an existing member.
- Parameters:
-
- CATMathPoint
- Inputs the parameter defining the coordinates for the member's start point.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIStructureMember.h