All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMGridSet

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIGSMGridSet
 

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


interface CATIGSMGridSet

Interface to GridSet feature.

Role: Allows you to access/modify data of the GridSet feature.
GridSet feature allows to generate sets of parallel GridFaces.

See also:
CATIGSMFactory.CreateGridSet
See also:
CATIGSMGridSubset, CATIGSMGridFace


Method Index


o AddExtremeFace(double,CATIGSMGridSubset_var&,boolean,CATIGSMGridFace_var&)
Adds a face at the end of GridSet.
o AddFace(double,CATIGSMGridSubset_var&,CATIGSMGridFace_var&)
Adds a face.
o AddSubset(CATUnicodeString&,CATIGSMGridSubset_var&)
Adds a subset.
o Build(CATListOfDouble,CATListOfCATUnicodeString)
Build or modify a GridSet.
o ChangeFaceRelOffset(CATIGSMGridFace_var&,double)
Changes the relative offset of a face (It also moves next faces).
o ChangeFaceSubset(CATIGSMGridFace_var&,CATIGSMGridSubset_var&)
Changes the subset aggregation of a face.
o ChangeSubsetPrefix(CATIGSMGridSubset_var&,CATUnicodeString&)
Changes the prefix of a subset.
o GetDirection(CATIGSMDirection_var&)
Gets the direction.
o GetExtremeFaces(CATIGSMGridFace_var&,CATIGSMGridFace_var&,double&,double&)
Gets the both (before and after origin) farthest GridFace according to origin.
o GetFace(double,CATIGSMGridFace_var&)
Gets a face.
o GetFaces(CATLISTV(CATISpecObject_var)&)
Gets all faces.
o GetFacesSorted(CATLISTV(CATISpecObject_var)&)
Gets all faces sorted by absolute offsets.
o GetFacesSorted(CATLISTV(CATISpecObject_var)&,CATIGSMGridFace_var&,CATLISTV(CATISpecObject_var)&)
Gets all GridFaces (except the origin one) sorted by absolute offsets.
o GetFacesSorted(CATLISTV(CATISpecObject_var)&,CATIGSMGridFace_var&,CATLISTV(CATISpecObject_var)&,CATListOfDouble&,CATListOfDouble&)
Gets all GridFaces (except the origin one) sorted by absolute offsets.
o GetFacesSorted(CATLISTV(CATISpecObject_var)&,CATListOfDouble&)
Gets all faces sorted by absolute offsets.
o GetNbFaces(int&)
Gets the number of faces.
o GetNbFaces(int&,CATBoolean&,int&)
Gets the number of faces.
o GetNbSubsets(int&)
Gets the number of subsets.
o GetOrientation(CATBoolean&)
Gets the orientation.
o GetOrigin(CATISpecObject_var&)
Gets the origin.
o GetSubset(CATUnicodeString&,CATIGSMGridSubset_var&)
Gets a subset.
o GetSubsets(CATLISTV(CATISpecObject_var)&)
Gets all subsets.
o InvertOrientation()
Inverts the GridSet's orientation.
o RemoveExtremeFaces(int,int)
Shrink GridSet (deleted faces are extreme ones).
o RemoveFace(CATIGSMGridFace_var&)
Removes a face (It also moves next faces).
o RemoveFaces()
Removes all GridFaces.
o RemoveSubset(CATIGSMGridSubset_var&)
Removes a subset and all its agregated faces.
o RemoveSubsets()
Removes all subsets and all faces.
o SetDirection(CATIGSMDirection_var&)
Sets the direction.
o SetOrientation(CATBoolean)
Sets the orientation.
o SetOrigin(CATISpecObject_var&)
Sets the origin.

Methods


o AddExtremeFace
public virtual HRESULT AddExtremeFace(double iRelOffset,
const CATIGSMGridSubset_var& ihISubset,
boolean iAfterOrigin,
CATIGSMGridFace_var& ohIFace) =0
Adds a face at the end of GridSet. Remark: In a same GridSet, two GridFaces could not have the same offset.
Parameters:
iRelOffset
The relative offset of the face to add according to the extremum face.
ihISubset
The subset where the face must be aggregated.
iAfterOrigin
Determine at which extremity the face must be added.
ohIFace
The created face.
Returns:
S_OK if the face has been created E_INVALIDARG if "ihISubset" is equal to NULL_VAR or if "iRelOffset" is less than or equal to 0 E_FAIL if an error occured
See also:
CATIGSMGridSubset
See also:
CATIGSMGridFace
o AddFace
public virtual HRESULT AddFace(double iAbsOffset,
const CATIGSMGridSubset_var& ihISubset,
CATIGSMGridFace_var& ohIFace) =0
Adds a face. Remark: In a same GridSet, two GridFaces could not have the same offset.
Parameters:
iAbsOffset
The absolute offset of the face to add.
ihISubset
The subset where the face must be aggregated.
ohIFace
The created face.
Returns:
S_OK if the face has been created E_INVALIDARG if "ihISubset" is equal to NULL_VAR or if a face with the same offset already exist E_FAIL if an error occured
See also:
CATIGSMGridSubset
See also:
CATIGSMGridFace
o AddSubset
public virtual HRESULT AddSubset( const CATUnicodeString& iPrefix,
CATIGSMGridSubset_var& ohISubset) =0
Adds a subset. Remark: in a same GridSet, two GridSubsets could not have the same prefix.
Parameters:
iPrefix
The prefix of the subset to add.
ohISubset
The created subset.
Returns:
S_OK if the subset has been created E_INVALIDARG if a subset with the same prefix already exist or if prefix is an empty string E_FAIL if an error occured
See also:
CATIGSMGridSubset
o Build
public virtual HRESULT Build(CATListOfDouble iAbsOffsets,
CATListOfCATUnicodeString iSubsetsPrefix) =0
Build or modify a GridSet. Remark: In modification cases, existing faces are re-used (but not subsets). The face order is kept to avoid losing associativities.
Parameters:
iAbsOffsets
The absolute offsets where the faces must be created.
iSubsetsPrefix
The prefix of subsets where to add the faces. The subset prefix must be specified for each face.
Returns:
S_OK all is done E_INVALIDARG if lists does not have the same size or if 2 faces have the same absolute offsets E_FAIL an error occured
o ChangeFaceRelOffset
public virtual HRESULT ChangeFaceRelOffset( const CATIGSMGridFace_var& ihIFace,
double iRelOffset) =0
Changes the relative offset of a face (It also moves next faces).
Parameters:
ihIFace
The face where the offset must be changed.
iRelOffset
The new relative offset (in absolute value).
Returns:
S_OK if the face has been moved E_INVALIDARG if "ihIFace" is equal to NULL_var, "iRelOffset" is smaller than zero. E_FAIL if an error occured
See also:
CATIGSMGridFace
o ChangeFaceSubset
public virtual HRESULT ChangeFaceSubset( const CATIGSMGridFace_var& ihIFace,
const CATIGSMGridSubset_var& ihISubset) =0
Changes the subset aggregation of a face.
Parameters:
ihIFace
The face where the subset must be changed.
ihISubset
The new subset.
Returns:
S_OK if the face has been moved E_INVALIDARG if "ihIFace" or "ihISubset" is NULL_var E_FAIL if an error occured
See also:
CATIGSMGridSubset
See also:
CATIGSMGridFace
o ChangeSubsetPrefix
public virtual HRESULT ChangeSubsetPrefix( const CATIGSMGridSubset_var& ihISubset,
const CATUnicodeString& iPrefix) =0
Changes the prefix of a subset.
Parameters:
ihISubset
The subset where the prefix must be changed.
iPrefix
The new prefix.
Returns:
S_OK if the prefix has been changed E_INVALIDARG if a subset with the same prefix already exist or if "ihISubset" is equal to NULL_var E_FAIL if an error occured
See also:
CATIGSMGridSubset
See also:
CATUnicodeString
o GetDirection
public virtual HRESULT GetDirection(CATIGSMDirection_var& ohIDirection) =0
Gets the direction.
Parameters:
ohIDirection
GridSet's direction.
See also:
CATIGSMDirection
o GetExtremeFaces
public virtual HRESULT GetExtremeFaces(CATIGSMGridFace_var& ohIFaceBfr,
CATIGSMGridFace_var& ohIFaceAft,
double& oAbsOffsetBfr,
double& oAbsOffsetAft) =0
Gets the both (before and after origin) farthest GridFace according to origin.
Parameters:
ohIFaceBfr
The farthest GridFace before origin Return NULL_var if there is (no GridFace before origin) and (no GridFace at origin)
ohIFaceAft
The farthest GridFace after origin Return NULL_var if there is (no GridFace after origin) and (no GridFace at origin)
oAbsOffsetBfr
Signed absolute offset (in model unit (mm)) of "ohIFaceBfr" Return 0.0 if there is (no GridFace before origin) and (no GridFace at origin)
oAbsOffsetAft
Signed absolute offset (in model unit (mm)) of "ohIFaceAft" Return 0.0 if there is (no GridFace after origin) and (no GridFace at origin)
See also:
CATIGSMGridFace
o GetFace
public virtual HRESULT GetFace(double iAbsOffset,
CATIGSMGridFace_var& ohIFace) =0
Gets a face.
Parameters:
iAbsOffset
The absolute offset to retrieve.
ohIFace
The returned face (NULL_var if not found).
Returns:
S_OK if the face was found E_INVALIDARG if the face was not found E_FAIL if an error occured
See also:
CATIGSMGridFace
o GetFaces
public virtual HRESULT GetFaces(CATLISTV(CATISpecObject_var)& oLstFaces) =0
Gets all faces.
Parameters:
oLstFaces
List of faces.
See also:
CATIGSMGridFace
o GetFacesSorted
public virtual HRESULT GetFacesSorted(CATLISTV(CATISpecObject_var)& oLstFaces) =0
Gets all faces sorted by absolute offsets.
Parameters:
oLstFaces
List of faces sorted by absolute offsets (increasing order).
See also:
CATIGSMGridFace
o GetFacesSorted
public virtual HRESULT GetFacesSorted(CATLISTV(CATISpecObject_var)& oLstFacesBfr,
CATIGSMGridFace_var& ohIOriginFace,
CATLISTV(CATISpecObject_var)& oLstFacesAft)=0
Gets all GridFaces (except the origin one) sorted by absolute offsets.
Parameters:
oLstFacesBfr
List of GridFaces (before the origin) sorted by absolute offsets (decreasing order).
oOriginFace
The origin face.
oLstFacesAft
List of GridFaces (after the origin) sorted by absolute offsets (increasing order).
See also:
CATIGSMGridFace
o GetFacesSorted
public virtual HRESULT GetFacesSorted(CATLISTV(CATISpecObject_var)& oLstFacesBfr,
CATIGSMGridFace_var& ohIOriginFace,
CATLISTV(CATISpecObject_var)& oLstFacesAft,
CATListOfDouble& oLstAbsOffsetsBfr,
CATListOfDouble& oLstAbsOffsetsAft) =0
Gets all GridFaces (except the origin one) sorted by absolute offsets.
Parameters:
oLstFacesBfr
List of GridFaces (before the origin) sorted by absolute offsets (decreasing order).
oOriginFace
The origin face.
oLstFacesAft
List of GridFaces (after the origin) sorted by absolute offsets (increasing order).
oLstAbsOffsetsBfr
List of absolute offsets (in model unit (mm)) of "oLstFacesBfr".
oLstAbsOffsetsAft
List of absolute offsets (in model unit (mm)) of "oFacesAftOrg".
See also:
CATIGSMGridFace
o GetFacesSorted
public virtual HRESULT GetFacesSorted(CATLISTV(CATISpecObject_var)& oLstFaces,
CATListOfDouble& oLstAbsOffsets) =0
Gets all faces sorted by absolute offsets.
Parameters:
oLstFaces
List of faces sorted by absolute offsets (increasing order).
oLstAbsOffsets
List of absolute offsets (in model unit (mm)) of "oLstFaces".
See also:
CATIGSMGridFace
o GetNbFaces
public virtual HRESULT GetNbFaces(int& oNbFaces) =0
Gets the number of faces.
Parameters:
oNbFaces
The number of faces.
o GetNbFaces
public virtual HRESULT GetNbFaces(int& oNbFacesBfr,
CATBoolean& oOriginFaceExist,
int& oNbFacesAft) =0
Gets the number of faces.
Parameters:
oNbFacesBfr
The number of faces before origin.
oOriginFaceExist
If this subset contains the origin face.
oNbFacesAft
The number of faces after origin.
o GetNbSubsets
public virtual HRESULT GetNbSubsets(int& oNbSubsets) =0
Gets the number of subsets.
Parameters:
oNbSubsets
The number of subsets.
o GetOrientation
public virtual HRESULT GetOrientation(CATBoolean& oOrient) =0
Gets the orientation.
Parameters:
oOrient
GridSet's orientation. (TRUE means that orientation is the same as direction)
o GetOrigin
public virtual HRESULT GetOrigin(CATISpecObject_var& ohIOrigin) =0
Gets the origin.
Parameters:
ohIOrigin
GridSet's origin: a point.
See also:
CATISpecObject
o GetSubset
public virtual HRESULT GetSubset( const CATUnicodeString& iPrefix,
CATIGSMGridSubset_var& ohISubset) =0
Gets a subset.
Parameters:
iPrefix
The prefix to retrieve.
ohISubset
The returned subset (NULL_var if not found).
Returns:
S_OK if the subset has been found E_INVALIDARG if the prefix has not been found E_FAIL if an error occured
See also:
CATIGSMGridSubset
o GetSubsets
public virtual HRESULT GetSubsets(CATLISTV(CATISpecObject_var)& oLstSubsets) =0
Gets all subsets.
Parameters:
oLstSubsets
List of subsets.
See also:
CATIGSMGridSubset
o InvertOrientation
public virtual HRESULT InvertOrientation()=0
Inverts the GridSet's orientation.
o RemoveExtremeFaces
public virtual HRESULT RemoveExtremeFaces(int iNbToCropBfr,
int iNbToCropAft) =0
Shrink GridSet (deleted faces are extreme ones). The origin face will never been deleted with this method.
Parameters:
iNbToCropBfr
Number of before origin GridFace to remove
iNbToCropAft
Number of after origin GridFace to remove
o RemoveFace
public virtual HRESULT RemoveFace(CATIGSMGridFace_var& iohIFace) =0
Removes a face (It also moves next faces).
Parameters:
iohIFace
The face to remove. "iohIFace" is set to NULL_var if the remove operation ended successfully.
Returns:
S_OK if the face has been removed E_INVALIDARG if "iohIFace" is equal to NULL_var E_FAIL if an error occured
See also:
CATIGSMGridFace
o RemoveFaces
public virtual HRESULT RemoveFaces()=0
Removes all GridFaces.
o RemoveSubset
public virtual HRESULT RemoveSubset(CATIGSMGridSubset_var& iohISubset) =0
Removes a subset and all its agregated faces.
Parameters:
iohISubset
The subset to remove. "iohISubset" is set to NULL_var if the remove operation ended successfully.
Returns:
S_OK if the subset has been removed E_INVALIDARG if "iohISubset" is equal to NULL_var E_FAIL if an error occured
See also:
CATIGSMGridSubset
o RemoveSubsets
public virtual HRESULT RemoveSubsets()=0
Removes all subsets and all faces.
o SetDirection
public virtual HRESULT SetDirection( const CATIGSMDirection_var& ihIDirection) =0
Sets the direction.
Parameters:
ihIDirection
GridSet's direction.
Returns:
S_OK if the direction has been set S_FALSE if the direction was already "ihIDirection" E_FAIL if an error occured
See also:
CATIGSMDirection
o SetOrientation
public virtual HRESULT SetOrientation(CATBoolean iOrient) =0
Sets the orientation.
Parameters:
iOrient
GridSet's orientation. (TRUE means that orientation will be the same as direction)
Returns:
S_OK if the orientation has been set S_FALSE if the orientation was already "iOrient" E_FAIL if an error occured
o SetOrigin
public virtual HRESULT SetOrigin( const CATISpecObject_var& ihIOrigin) =0
Sets the origin.
Parameters:
ihIOrigin
GridSet's origin: a point.
Returns:
S_OK if the origin has been set S_FALSE if the origin was already "ihIOrigin" E_FAIL if an error occured
See also:
CATISpecObject

This object is included in the file: CATIGSMGridSet.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces

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