ScreenStructureSpec Class Reference

Class containing the specification for a net object. More...

#include <ScreenStructureSpec.h>

Inheritance diagram for ScreenStructureSpec:

Collaboration diagram for ScreenStructureSpec:

Public Member Functions
	ScreenStructureSpec (ISimObjectLogger *logger)
	The constructor sets the pointer to the output object and the parser object.
virtual	~ScreenStructureSpec ()
	The destructor deletes dynamically allocated memory.
virtual void	FromFile (std::string fileName, std::string filePath)
void	FromBinaryFile (std::string fileName, std::string filePath)
int	CreateExternalNodeMap (std::vector< std::string > VsInputNodes, VSPairStrInt &VsNodes)
int	GetNumNodesCalc ()
int	GetNumNodesOriginal ()
std::vector< const ScreenElementDef * >	GetNetPanels ()
std::vector< const ScreenElementDef * >	GetNetScreens ()
std::vector< const NetCableElementSpec * >	GetCableElements ()
SAdaptationSpec_t	GetAdaptationSpec ()
bool	GetCatsRefinementMode ()
void	PrintInfo ()
Public Member Functions inherited from NetStructureSpec
	NetStructureSpec (ISimObjectLogger *logger)
	The constructor sets the pointer to the output object and the parser object.
virtual	~NetStructureSpec ()
	The destructor deletes dynamically allocated memory.
void	FromBinaryFile (std::string fileName, std::string filePath)
int	CreateExternalNodeMap (std::vector< std::string > VsInputNodes, VSPairStrInt &VsNodes)
int	GetNumNodesCalc ()
int	GetNumNodesOriginal ()
std::vector< const NetElementDef * >	GetNetPanels ()
std::vector< const NetCableElementSpec * >	GetCableElements ()
SAdaptationSpec_t	GetAdaptationSpec ()
bool	GetCatsRefinementMode ()
void	PrintInfo ()

Protected Member Functions
virtual void	ReadInputFile (std::string fileName, std::string filePath, ISimObjectLogger *logger)
virtual void	ReadBinaryInputFile (std::string fileName, std::string filePath, ISimObjectLogger *logger)
void	FindNodesToDivide (int nodesToDivide[2], double *length, double *lengthFactor)
void	RefineMesh ()
void	RefineMesh2 ()
void	CheckNodeNumber (int nodeNumber, ISimObjectLogger *const logger, std::string nodeDescription="")
void	CheckNodes (ISimObjectLogger *logger)
unsigned short	AddCalcNode (int aiNodes[2])
unsigned short	DivideCableElement (int CableNum)
Protected Member Functions inherited from NetStructureSpec
void	FindNodesToDivide (int nodesToDivide[2], double *length, double *lengthFactor)
void	RefineMesh ()
void	RefineMesh2 ()
void	CheckNodeNumber (int nodeNumber, ISimObjectLogger *const logger, std::string nodeDescription="")
void	CheckNodes (ISimObjectLogger *logger)
unsigned short	AddCalcNode (int aiNodes[2])
unsigned short	DivideCableElement (int CableNum)

Protected Attributes
int	m_numPanelsCalc
	The number of elements the net is divided into.
int	m_numCablesCalc
	The number of elements the cable is divided into.
int	m_numNodesOriginal
	The number of original nodes of the net.
int	m_numNodesCalc
	The number of nodes of the net after refinement.
std::vector< const ScreenElementDef * >	m_VSScreenData
	A vector of structs containing the net screen data read from the input file.
std::vector< const NetCableElementSpec * >	m_VCableElements
	A vector of structs containing the cable data read from the input file.
int	m_foldingPointRefinement
	refinement by folding points on each cable (Cats mode)
double	m_maxSideLengthFactor
	The maximum element side length factor.
double	m_minSideLength
	The side length limit for the elements to be further subdivided.
int	m_maxNumNodes
	The maximum number of nodes used for net calculations.
int	m_maxNumPanels
	The maximum number of net panels used for the calculations.
int	m_maxNumCables
	The maximum number of cable elements used for the calculations.
double	m_scale
	The scale of the trawl net in relation to the specifications.
std::string	m_netName
	The identification name of the net.
VSPairStrInt	m_VsNodesAvailable
	The tag names and indices of the available external nodes.
SAdaptationSpec_t	m_SAdaptationSpec
	A struct containing adaptations for faster integration of the net structure.
int	m_iD
ISimObjectLogger *	m_logger
Protected Attributes inherited from NetStructureSpec
int	m_numPanelsCalc
	The number of elements the net is divided into.
int	m_numCablesCalc
	The number of elements the cable is divided into.
int	m_numNodesOriginal
	The number of original nodes of the net.
int	m_numNodesCalc
	The number of nodes of the net after refinement.
std::vector< const NetElementDef * >	m_VSPanelData
	A vector of structs containing the section data read from the input file.
std::vector< const NetCableElementSpec * >	m_VCableElements
	A vector of structs containing the cable data read from the input file.
int	m_foldingPointRefinement
	refinement by folding points on each cable (Cats mode)
double	m_maxSideLengthFactor
	The maximum element side length factor.
double	m_minSideLength
	The side length limit for the elements to be further subdivided.
int	m_maxNumNodes
	The maximum number of nodes used for net calculations.
int	m_maxNumPanels
	The maximum number of net panels used for the calculations.
int	m_maxNumCables
	The maximum number of cable elements used for the calculations.
double	m_scale
	The scale of the trawl net in relation to the specifications.
std::string	m_netName
	The identification name of the net.
VSPairStrInt	m_VsNodesAvailable
	The tag names and indices of the available external nodes.
SAdaptationSpec_t	m_SAdaptationSpec
	A struct containing adaptations for faster integration of the net structure.
int	m_iD
ISimObjectLogger *	m_logger

Static Protected Attributes
static int	s_iID
Static Protected Attributes inherited from NetStructureSpec
static int	s_iID

Detailed Description

Author

Karl-Johan Reite A struct containing adaptations for faster integration of the net structure

Member Function Documentation

FromFile()

virtual void ScreenStructureSpec::FromFile ( std::string  fileName, std::string  filePath  )

virtual

Reimplemented from NetStructureSpec.

ReadBinaryInputFile()

virtual void ScreenStructureSpec::ReadBinaryInputFile ( std::string  fileName, std::string  filePath, ISimObjectLogger *  logger  )

protectedvirtual

Reimplemented from NetStructureSpec.

ReadInputFile()

virtual void ScreenStructureSpec::ReadInputFile ( std::string  fileName, std::string  filePath, ISimObjectLogger *  logger  )

protectedvirtual

Reimplemented from NetStructureSpec.

---

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

• /update_root/webfhsim/reloadrepos/fhsim_marine_elements/src/net/ScreenStructureSpec.h