Ref< SC > Class Template Reference

Base class for reference systems. More...

#include <Ref.h>

Inheritance diagram for Ref< SC >:

Collaboration diagram for Ref< SC >:

Public Types
typedef SC::VGlobal	VGlobal
	Dimension of the global vector.
typedef SC::DGlobal	DGlobal
	Dimension of the global direction.
typedef SC::PGlobal	PGlobal
	Dimension of the global point.
typedef SC::VLocal	VLocal
	Dimension of the local vector.
typedef SC::PLocal	PLocal
	Dimension of the local point.
Public Types inherited from EntityWithProperties
typedef std::map< std::string, boost::python::object >	PythonDict

Public Member Functions
	Ref (const PGlobal &o, const SC &sc=SC())
	Ref (const PGlobal &o, const VGlobal &vX)
	Ref (const PGlobal &o, const DGlobal &dirX)
	Ref (const PGlobal &o, const PGlobal &p)
virtual bool	operator== (const Ref &) const
	Comparison operator.
PGlobal &	Org (void)
const PGlobal &	Org (void) const
void	setOrg (const PGlobal &p)
void	move (const VGlobal &v)
SC &	Trf (void)
const SC &	Trf (void) const
void	setTrf (const SC &t)
VGlobal	getAxisVDir (const size_t &i) const
PGlobal	getGlobalPosition (const PLocal &p) const
	Return the global coordinates of the position vector of the point. More...
VGlobal	getGlobalCoordinates (const VLocal &v) const
	Return the local coordinates of the vector. More...
PLocal	getLocalPosition (const PGlobal &p) const
	Return the position of the point p (expressed in global coordinates) expresssed in local coordinates. More...
VLocal	getLocalCoordinates (const VGlobal &v) const
	Return the local coordinates of the vector. More...
boost::python::dict	getPyDict (void) const
	Return a Python dictionary with the object members values.
void	setPyDict (const boost::python::dict &)
	Set the values of the object members from a Python dictionary.
Public Member Functions inherited from ProtoGeom
	ProtoGeom (void)
	False when solution is not possible: intersection of parallel planes. More...
virtual void	Print (std::ostream &os) const
void	setExists (bool e)
bool	exists (void) const
boost::python::dict	getPyDict (void) const
	Return a Python dictionary with the object members values.
void	setPyDict (const boost::python::dict &)
	Set the values of the object members from a Python dictionary.
Public Member Functions inherited from CommandEntity
	CommandEntity (CommandEntity *owr=nullptr)
	Default constructor.
CommandEntity *	Owner (void)
	Return a pointer to the object owner.
const CommandEntity *	Owner (void) const
	Return un puntero al objeto propietario de ESTE.
const StandardOutputWrapper &	getStandardOutputWrapper (void) const
	Return the regular output stream wrapper.
StandardOutputWrapper &	getStandardOutputWrapper (void)
	Return the regular output stream wrapper.
const std::string &	getLogFileName (void) const
	Returns log file name.
void	setLogFileName (const std::string &)
	Sets log file name.
const std::string &	getErrFileName (void) const
	Returns err file name.
void	setErrFileName (const std::string &)
	Sets error file name.
const std::string &	getOutputFileName (void) const
	Returns regular output file name.
void	setOutputFileName (const std::string &)
	Sets regular output file name.
boost::python::object	evalPy (boost::python::object dict, const std::string &)
	Return the Python object that results from evaluating the argument.
boost::python::object	execPy (boost::python::object dict, const std::string &)
	Return the Python objects that results from executing the code in the string argument.
boost::python::object	execFilePy (boost::python::object dict, const std::string &)
	Return the Python object that results from executing the code in the file.
Public Member Functions inherited from EntityWithProperties
	EntityWithProperties (EntityWithProperties *owr=nullptr)
	Default constructor.
void	clearPyProps (void)
	Clear python properties map.
bool	hasPyProp (const std::string &)
	Returns true if property exists.
boost::python::object	getPyProp (const std::string &str)
	Return the Python object with the name being passed as parameter.
void	setPyProp (std::string str, boost::python::object val)
	Sets/appends a value tho the Python object's dictionary.
void	copyPropsFrom (const EntityWithProperties &)
	Copy the properties from the argument.
boost::python::list	getPropNames (void) const
	Return the names of the object properties weightings.
const PythonDict &	getPropertiesDict (void) const
	Return a std::map container with the properties of the object.
boost::python::dict	getPyDict (void) const
	Return a Python dictionary containing the object members values.
void	setPyDict (const boost::python::dict &)
	Set the values of the object members from a Python dictionary.
Public Member Functions inherited from EntityWithOwner
	EntityWithOwner (EntityWithOwner *owr=nullptr)
	Default constructor.
	EntityWithOwner (const EntityWithOwner &)
	Copy constructor.
EntityWithOwner &	operator= (const EntityWithOwner &)
	Assignment operator.
virtual bool	operator== (const EntityWithOwner &) const
	Comparison operator.
virtual	~EntityWithOwner (void)
	Virtual destructor.
virtual std::string	getClassName (void) const
	Returns demangled class name.
void	set_owner (EntityWithOwner *owr)
	Assigns the owner of the object.
EntityWithOwner *	Owner (void)
const EntityWithOwner *	Owner (void) const

Protected Attributes
PGlobal	org
	Origin of the coordinate system.
SC	trf
	local –> global coordinate system axis transformation.

Friends
std::ostream &	operator<< (std::ostream &os, const Ref< SC > &r)

Additional Inherited Members
Static Public Member Functions inherited from CommandEntity
static void	resetStandardOutput (void)
	Reset the standard output streams to its defaults buffers.
Static Public Member Functions inherited from EntityWithOwner
static int	getVerbosityLevel (void)
	Get the value of the verbosity level.
static void	setVerbosityLevel (const int &)
	Set the value of the verbosity level.
Protected Member Functions inherited from CommandEntity
template<class T >
void	string_to (T &, const std::string &) const
Protected Member Functions inherited from EntityWithProperties
bool	isEqual (const EntityWithProperties &) const
	Return true if both objects are equal.
Protected Member Functions inherited from EntityWithOwner
virtual bool	isEqual (const EntityWithOwner &) const
	Return true if both objects are equal.
Static Protected Member Functions inherited from CommandEntity
static CommandEntity *	entcmd_cast (boost::any &data)
Static Protected Attributes inherited from EntityWithOwner
static int	verbosity = 1
	Object that owns THIS ONE. More...

Detailed Description

template<class SC>
class Ref< SC >

Base class for reference systems.

Member Function Documentation

getGlobalCoordinates()

template<class SC >

Ref< SC >::VGlobal Ref< SC >::getGlobalCoordinates

(

const VLocal &

v

)

const

Return the local coordinates of the vector.

Parameters

v	local coordinates of the vector.

getGlobalPosition()

template<class SC >

Ref< SC >::PGlobal Ref< SC >::getGlobalPosition

(

const PLocal &

p

)

const

Return the global coordinates of the position vector of the point.

Parameters

p	local coordinates of the point.

getLocalCoordinates()

template<class SC >

Ref< SC >::VLocal Ref< SC >::getLocalCoordinates

(

const VGlobal &

v

)

const

Return the local coordinates of the vector.

Parameters

v	global coordinates of the vector.

getLocalPosition()

template<class SC >

Ref< SC >::PLocal Ref< SC >::getLocalPosition

(

const PGlobal &

p

)

const

Return the position of the point p (expressed in global coordinates) expresssed in local coordinates.

---

The documentation for this class was generated from the following file:

• src/utility/geom/coo_sys/ref_sys/Ref.h