IDGenerator Class Reference

Class that manage the ID generation. More...

Public Member Functions
def	__init__ (self)
	The class constructor. More...
def	GenerateIDElement (self)
	Method that generate a unique element ID. More...
def	GenerateIDFiber (self)
	Method that generate a unique fiber ID. More...
def	GenerateIDMat (self)
	Method that generate a unique material ID. More...
def	GenerateIDNode (self)
	Method that generate a unique node ID. More...

Public Attributes
	current_element_ID
	current_fiber_ID
	current_mat_ID
	current_node_ID

Detailed Description

Class that manage the ID generation.

USE ONLY IF EVERY NODE IS DEFINED BY THE USER (because the OpenSeesPyAssistant modules use the convention defined in the functions above).

Definition at line 412 of file FunctionalFeatures.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

The class constructor.

Definition at line 416 of file FunctionalFeatures.py.

    def __init__(self):
        """The class constructor.
        """
        self.current_node_ID = 0
        self.current_element_ID = 0
        self.current_mat_ID = 0
        self.current_fiber_ID = 0
 

Member Function Documentation

GenerateIDElement()

def GenerateIDElement

(

self

)

Method that generate a unique element ID.

Returns

int: The element ID.

Definition at line 433 of file FunctionalFeatures.py.

    def GenerateIDElement(self):
        """
        Method that generate a unique element ID.
 
        @returns int: The element ID.
        """
        self.current_element_ID = self.current_element_ID + 1
        return self.current_element_ID
 

GenerateIDFiber()

def GenerateIDFiber

(

self

)

Method that generate a unique fiber ID.

Returns

int: The fiber ID.

Definition at line 451 of file FunctionalFeatures.py.

    def GenerateIDFiber(self):
        """
        Method that generate a unique fiber ID.
 
        @returns int: The fiber ID.
        """
        self.current_fiber_ID = self.current_fiber_ID + 1
        return self.current_fiber_ID
 
 

GenerateIDMat()

def GenerateIDMat

(

self

)

Method that generate a unique material ID.

Returns

int: The material ID.

Definition at line 442 of file FunctionalFeatures.py.

    def GenerateIDMat(self):
        """
        Method that generate a unique material ID.
 
        @returns int: The material ID.
        """
        self.current_mat_ID = self.current_mat_ID + 1
        return self.current_mat_ID
 

GenerateIDNode()

def GenerateIDNode

(

self

)

Method that generate a unique node ID.

Returns

int: The node ID.

Definition at line 424 of file FunctionalFeatures.py.

    def GenerateIDNode(self):
        """
        Method that generate a unique node ID.
 
        @returns int: The node ID.
        """
        self.current_node_ID = self.current_node_ID + 1
        return self.current_node_ID
 

Member Data Documentation

current_element_ID

current_element_ID

Definition at line 420 of file FunctionalFeatures.py.

current_fiber_ID

current_fiber_ID

Definition at line 422 of file FunctionalFeatures.py.

current_mat_ID

current_mat_ID

Definition at line 421 of file FunctionalFeatures.py.

current_node_ID

current_node_ID

Definition at line 419 of file FunctionalFeatures.py.

---

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

• /media/carmine/DATA/Programmi/OpenSeesPyAssistant/FunctionalFeatures.py