OCC Main Page | FoundationClasses | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

FoundationClasses
TKMath
TopLoc


TopLoc_Location Class Reference

A Location is a composite transition. It comprises a
series of elementary reference coordinates, i.e.
objects of type TopLoc_Datum3D, and the powers to
which these objects are raised.
.

#include <TopLoc_Location.hxx>


Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT TopLoc_Location ()
 Constructs an empty local coordinate system object.
Note: A Location constructed from a default datum is said to be "empty".
.
Standard_EXPORT TopLoc_Location (const gp_Trsf &T)
 Constructs the local coordinate system object defined
by the transformation T. T invokes in turn, a TopLoc_Datum3D object.
.
Standard_EXPORT TopLoc_Location (const Handle(TopLoc_Datum3D)&D)
 Constructs the local coordinate system object defined by the 3D datum D.
Exceptions
Standard_ConstructionError if the transformation
T does not represent a 3D coordinate system.
.
Standard_Boolean IsIdentity () const
 Returns true if this location is equal to the Identity transformation.
.
void Identity ()
 Resets this location to the Identity transformation.
.
const Handle_TopLoc_Datum3D & FirstDatum () const
 Returns the first elementary datum of the
Location. Use the NextLocation function recursively to access
the other data comprising this location.
Exceptions
Standard_NoSuchObject if this location is empty.
.
Standard_Integer FirstPower () const
 Returns the power elevation of the first
elementary datum.
Exceptions
Standard_NoSuchObject if this location is empty.
.
const TopLoc_LocationNextLocation () const
 Returns a Location representing <me> without the
first datum. We have the relation :

<me> = NextLocation() * FirstDatum() ^ FirstPower()
Exceptions
Standard_NoSuchObject if this location is empty.
.
Standard_EXPORT const gp_TrsfTransformation () const
 Returns the transformation associated to the
coordinate system.

.
Standard_EXPORT operator gp_Trsf () const
Standard_EXPORT TopLoc_Location Inverted () const
 Returns the inverse of <me>.

<me> * Inverted() is an Identity.
.
Standard_EXPORT TopLoc_Location Multiplied (const TopLoc_Location &Other) const
 Returns <me> * <other>, the elementary datums are
concatenated.

.
TopLoc_Location operator * (const TopLoc_Location &Other) const
Standard_EXPORT TopLoc_Location Divided (const TopLoc_Location &Other) const
 Returns <me> / <other>.

.
TopLoc_Location operator/ (const TopLoc_Location &Other) const
Standard_EXPORT TopLoc_Location Predivided (const TopLoc_Location &Other) const
 Returns <other>.Inverted() * <me>.
.
Standard_EXPORT TopLoc_Location Powered (const Standard_Integer pwr) const
 Returns me at the power <pwr>. If <pwr> is zero
returns Identity. <pwr> can be lower than zero
(usual meaning for powers).
.
Standard_EXPORT Standard_Integer HashCode (const Standard_Integer Upper) const
 Returns a hashed value for this local coordinate system.
This value is used, with map tables, to store and
retrieve the object easily, and is in the range [ 1..Upper ].
.
Standard_EXPORT Standard_Boolean IsEqual (const TopLoc_Location &Other) const
 Returns true if this location and the location Other
have the same elementary data, i.e. contain the same
series of TopLoc_Datum3D and respective powers.
This method is an alias for operator ==.
.
Standard_Boolean operator== (const TopLoc_Location &Other) const
Standard_EXPORT Standard_Boolean IsDifferent (const TopLoc_Location &Other) const
 Returns true if this location and the location Other do
not have the same elementary data, i.e. do not
contain the same series of TopLoc_Datum3D and respective powers.
This method is an alias for operator !=.
.
Standard_Boolean operator!= (const TopLoc_Location &Other) const
Standard_EXPORT void ShallowDump (Standard_OStream &S) const
 Prints the contents of <me> on the stream <s>.
.

Private Attributes

TopLoc_SListOfItemLocation myItems


Constructor & Destructor Documentation

Standard_EXPORT TopLoc_Location::TopLoc_Location  ) 
 

Standard_EXPORT TopLoc_Location::TopLoc_Location const gp_Trsf T  ) 
 

Standard_EXPORT TopLoc_Location::TopLoc_Location const Handle(TopLoc_Datum3D)&  D  ) 
 


Member Function Documentation

Standard_EXPORT TopLoc_Location TopLoc_Location::Divided const TopLoc_Location Other  )  const
 

const Handle_TopLoc_Datum3D& TopLoc_Location::FirstDatum  )  const
 

Standard_Integer TopLoc_Location::FirstPower  )  const [inline]
 

Standard_EXPORT Standard_Integer TopLoc_Location::HashCode const Standard_Integer  Upper  )  const
 

void TopLoc_Location::Identity  )  [inline]
 

Standard_EXPORT TopLoc_Location TopLoc_Location::Inverted  )  const
 

Standard_EXPORT Standard_Boolean TopLoc_Location::IsDifferent const TopLoc_Location Other  )  const
 

Standard_EXPORT Standard_Boolean TopLoc_Location::IsEqual const TopLoc_Location Other  )  const
 

Standard_Boolean TopLoc_Location::IsIdentity  )  const [inline]
 

Standard_EXPORT TopLoc_Location TopLoc_Location::Multiplied const TopLoc_Location Other  )  const
 

const TopLoc_Location & TopLoc_Location::NextLocation  )  const [inline]
 

TopLoc_Location TopLoc_Location::operator * const TopLoc_Location Other  )  const [inline]
 

void TopLoc_Location::operator delete void *  anAddress  )  [inline]
 

Standard_EXPORT TopLoc_Location::operator gp_Trsf  )  const
 

void* TopLoc_Location::operator new size_t  size  )  [inline]
 

void* TopLoc_Location::operator new size_t  ,
void *  anAddress
[inline]
 

Standard_Boolean TopLoc_Location::operator!= const TopLoc_Location Other  )  const [inline]
 

TopLoc_Location TopLoc_Location::operator/ const TopLoc_Location Other  )  const [inline]
 

Standard_Boolean TopLoc_Location::operator== const TopLoc_Location Other  )  const [inline]
 

Standard_EXPORT TopLoc_Location TopLoc_Location::Powered const Standard_Integer  pwr  )  const
 

Standard_EXPORT TopLoc_Location TopLoc_Location::Predivided const TopLoc_Location Other  )  const
 

Standard_EXPORT void TopLoc_Location::ShallowDump Standard_OStream S  )  const
 

Standard_EXPORT const gp_Trsf& TopLoc_Location::Transformation  )  const
 


Field Documentation

TopLoc_SListOfItemLocation TopLoc_Location::myItems [private]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:14:08 2008 for OpenCASCADE by  doxygen 1.4.1