All Frameworks Class Hierarchy This Framework Previous Next Indexes
SPAkern Class LAW
SPAbase.ACIS_OBJECT
|
+---SPAkern.ENTITY
|
+---LAW
Usage: you must use this class as is. You should never derive it.
public class LAW
Stores a law mathematics function as an entity for saving to and restoring from a SAT file.
Role: This class permits a law mathematic function to be written to a SAT file without
the requirement of it being attached to some model topology. This is used in conjunction with
api_law_to_entity. As such, equations used in some model analysis have some permanence from
session to session.
- See also:
- law
Constructor and Destructor Index
- o
LAW()
- Constructs a LAW (default constructor).
- o
LAW(LAW*)
- Constructs a LAW from the specified LAW object (copy constructor).
- o
LAW(law*)
- Constructs a LAW from the specified LAW object.
Method Index
- o
def()
- Returns the law mathematic function enclosed within the LAW entity.
- o
identity(int)
- Returns a type identifier for this object.
- o
lose()
- Posts a delete bulletin to the bulletin board indicating this LAW is no
longer used in the active model.
- o
operator*=(SPAtransf&)
- Transforms a LAW.
- o
restore_common()
- Restores this LAW from a SAT file.
- o
set_def(law*)
- Specifies a new law function to store in the LAW entity.
- o
type_name()
- Returns the string "LAW".
Constructor and Destructor
o LAW
-
Constructs a LAW (default constructor).
Role: The allocation constructor is used primarily by restore. Applications should
call this constructor only with the overloaded new operator, as doing so
reserves the memory on the heap, a requirement to support roll back and history management.
o LAW
| public LAW( | LAW* | law_math_func) |
-
Constructs a LAW from the specified LAW object (copy constructor).
Role: Applications should call this constructor only with the overloaded new
operator, as doing so reserves the memory on the heap, a requirement to support roll back
and history management.
- Parameters:
-
- law_math_func
- law entity to copy.
o LAW
| public LAW( | law* | law_copy) |
-
Constructs a LAW from the specified LAW object.
Role: Applications should call this constructor only with the overloaded new
operator, as doing so reserves the memory on the heap, a requirement to support roll back
and history management.
- Parameters:
-
- law_copy
- law mathematic function.
Methods
o def
-
Returns the law mathematic function enclosed within the LAW entity.
o identity
| public virtual int identity( | int | level | = 0 )const |
-
Returns a type identifier for this object.
Role: If level is unspecified or 0, returns the type identifier LAW_TYPE. If
level is specified, returns LAW_TYPE for that level of derivation from ENTITY. The
level of this class is defined as LAW_LEVEL.
- Parameters:
-
- level
- the derivation level at which the object is to be identified.
o lose
| public virtual void lose( | ) |
-
Posts a delete bulletin to the bulletin board indicating this LAW is no
longer used in the active model.
Role: The lose methods for attached attributes are also called.
o operator*=
| public void operator*=( | const SPAtransf& | out_trans) |
-
Transforms a LAW.
Role: Before performing the change, this method checks whether or not the data
structure is posted on the bulletin board. If not, the routine calls backup to
put an entry on the bulletin board.
- Parameters:
-
- out_trans
- output transform.
o restore_common
| public void restore_common( | ) |
-
Restores this LAW from a SAT file.
Role: The RESTORE_DEF macro expands to the restore_common method,
which is used in reading information from a SAT file. This method is never called
directly. It is called by a higher hierarchical function if an item in the SAT file
is determined to be of this class type. An instance of this class will already have
been created through the allocation constructor. This method then populates the class
instance with the appropriate data from the SAT file.
restore_law Restore the underlying law mathematic function
o set_def
| public void set_def( | law* | in_law) |
-
Specifies a new law function to store in the LAW entity.
- Parameters:
-
- in_law
- new law.
o type_name
| public virtual const char * type_name( | )const |
-
Returns the string "LAW".
This object is included in the file: lawent.hxx