xc
Public Member Functions | Friends | List of all members
XC::CmbEdge::Side Class Reference

Component of a compound line. More...

#include <CmbEdge.h>

Inheritance diagram for XC::CmbEdge::Side:
Inheritance graph
[legend]
Collaboration diagram for XC::CmbEdge::Side:
Collaboration graph
[legend]

Public Member Functions

 Side (Edge *ptr=nullptr, const bool &s=true)
 Constructor.
 
bool equal (const Side &) const
 Comparison operator.
 
EdgegetEdge (void)
 Returns a pointer to the edge.
 
const EdgegetEdge (void) const
 Returns a constant pointer to the edge.
 
void SetEdge (Edge *l)
 Assigns the line.
 
const PntP1 (void) const
 Returns a constant pointer to the back end of the edge.
 
const PntP2 (void) const
 Returns a constant pointer to the front end of the edge.
 
PntP1 (void)
 Returns a constant pointer to the back end of the edge.
 
PntP2 (void)
 Returns a constant pointer to the front end of the edge.
 
bool areEndPoints (const Pnt *, const Pnt *) const
 Returns true if the points being passed as parameters are the endpoints of the side. More...
 
const std::string & getName (void) const
 Return the name of the line.
 
bool isDirect (void) const
 
void reverse (void)
 
size_t getTag (void) const
 Return the identifier of the line.
 
void setNDivHomologousEdges (const size_t &)
 Set the number of divisions of the side and the number of divisions of its homologous edges. More...
 
void setNDiv (const size_t &nd)
 Set the number of divisions of the side.
 
size_t NDiv (void) const
 Return the number of divisions of the line.
 
double getElemSize (void) const
 Return the element size.
 
Pos3dArray get_positions (void) const
 Return the positions on the line.
 
std::vector< int > getTagsNodesForward (void) const
 Return the identifiers of the nodes of the forward sequence.
 
std::vector< int > getTagsNodesReverse (void) const
 Return the identifiers of the nodes of the reverse sequence.
 
Pos3dArray getNodePosForward (void) const
 Return the positions of the nodes of the forward sequence.
 
Pos3dArray getNodePosReverse (void) const
 Return the positions of the nodes of the reverse sequence.
 
double getLength (void) const
 Return the side length.
 
Pos3d getCentroid (void) const
 Return the segment than links both ends.
 
bool In (const GeomObj3d &, const double &tol=0.0) const
 Returns true if this object lies inside the geometric object. More...
 
bool Out (const GeomObj3d &, const double &tol=0.0) const
 Returns true if this object lies outside the geometric object. More...
 
const VectorgetTang (const double &) const
 Returns a vector tangent to the side at the point s.
 
double getDist (const Pos3d &) const
 Returns the distance to the position being passed as parameter. More...
 
NodegetNodeForward (const size_t &i)
 Return the node which index is being passed as parameter empezando por el principio.
 
NodegetNodeReverse (const size_t &i)
 Return the node which index is being passed as parameter empezando por el final.
 
NodegetNode (const size_t &i)
 Return the node which index is being passed as parameter.
 
const NodegetNode (const size_t &i) const
 Return the node which index is being passed as parameter.
 
void genMesh (meshing_dir dm)
 Genertes a mesh from the corresponding line.
 
boost::python::dict getPyDict (void) const
 Return a Python dictionary with the object members values.
 
void setPyDict (LineMap &, 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.
 
CommandEntityOwner (void)
 Return a pointer to the object owner.
 
const CommandEntityOwner (void) const
 Return un puntero al objeto propietario de ESTE.
 
const StandardOutputWrappergetStandardOutputWrapper (void) const
 Return the regular output stream wrapper.
 
StandardOutputWrappergetStandardOutputWrapper (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.
 
virtual bool operator== (const EntityWithProperties &) const
 Comparison operator.
 
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.
 
EntityWithOwneroperator= (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.
 
EntityWithOwnerOwner (void)
 
const EntityWithOwnerOwner (void) const
 

Friends

bool operator== (const Side &il1, const Side &il2)
 Comparison operator.
 

Additional Inherited Members

- Public Types inherited from EntityWithProperties
typedef std::map< std::string, boost::python::object > PythonDict
 
- 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
 
- Static Protected Member Functions inherited from CommandEntity
static CommandEntityentcmd_cast (boost::any &data)
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

Component of a compound line.

A compound line is a sequence of pointers to lines (Line) (we call them lados here), such that the end of one of them is the origin of the edge that follows. Since the orientation of the line defined in the model, can not coincide with the orientation needed here, each pointer to line is accompanied by a boolean that indicates if the line must be taken with its reversed direction or not.

Member Function Documentation

◆ areEndPoints()

bool XC::CmbEdge::Side::areEndPoints ( const Pnt p1,
const Pnt p2 
) const

Returns true if the points being passed as parameters are the endpoints of the side.

◆ getDist()

double XC::CmbEdge::Side::getDist ( const Pos3d p) const

Returns the distance to the position being passed as parameter.

◆ In()

bool XC::CmbEdge::Side::In ( const GeomObj3d geomObj,
const double &  tol = 0.0 
) const

Returns true if this object lies inside the geometric object.

Parameters
geomObjobject to be contained in.
toltolerance.

◆ Out()

bool XC::CmbEdge::Side::Out ( const GeomObj3d geomObj,
const double &  tol = 0.0 
) const

Returns true if this object lies outside the geometric object.

Parameters
geomObjobject to be contained in.
toltolerance.

◆ setNDivHomologousEdges()

void XC::CmbEdge::Side::setNDivHomologousEdges ( const size_t &  nd)

Set the number of divisions of the side and the number of divisions of its homologous edges.


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