SIMLIB/C++ 3.09
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
simlib3::Status Class Reference

State variables (memory) base for blocks with internal state (Relay, ...) More...

#include <simlib.h>

Inheritance diagram for simlib3::Status:
Inheritance graph
[legend]
Collaboration diagram for simlib3::Status:
Collaboration graph
[legend]

Public Member Functions

 Status (Input i, double initvalue=0)
 
 ~Status ()
 
void Init (double initvalue)
 set initial value
 
void Init ()
 
void Set (double value)
 set state variable value (step change)
 
virtual void Eval () override
 evaluate without loop detection
 
virtual double Value () override
 value of state variable
 
void Save ()
 
void Restore ()
 
void SetState (double s)
 
double GetState (void)
 
void SetOldState (double s)
 
double GetOldState (void)
 
void SetValid (bool flag)
 
- Public Member Functions inherited from simlib3::aContiBlock1
 aContiBlock1 (Input i)
 constructor for blocks with single input
 
double InputValue ()
 
- Public Member Functions inherited from simlib3::aContiBlock
 aContiBlock ()
 
virtual void _Eval ()
 evaluate block (with loop detection)
 
virtual double Value ()=0
 get block output value
this method should be defined in classes derived from aContiBlock
 
- Public Member Functions inherited from simlib3::SimObject
bool TestAndSetFlag (bool new_value, unsigned n)
 internal method for flag manipulation is used for algebraic loop checking in continuous blocks
 
 SimObject ()
 constructor
 
virtual ~SimObject ()
 virtual destructor
 
void * operator new (size_t size)
 allocate object, set _flags
 
void operator delete (void *ptr)
 deallocate object
 
void * operator new[] (size_t size)=delete
 
void operator delete[] (void *ptr)=delete
 
bool isAllocated () const
 
virtual std::string Name () const
 get object name
 
bool HasName () const
 
void SetName (const std::string &name)
 assign the name
 
virtual void Output () const
 print object to default output
 

Public Attributes

double st
 status
 
double stl
 status from previous step
 

Protected Member Functions

void CtrInit ()
 

Protected Attributes

double initval
 initial value
 
bool ValueOK
 
StatusContainer::iterator it_list
 position in list of status variables
 
- Protected Attributes inherited from simlib3::aContiBlock
bool isEvaluated
 
- Protected Attributes inherited from simlib3::SimObject
unsigned _flags
 bool flags for internal use (TODO bitfield?)
 

Additional Inherited Members

- Public Types inherited from simlib3::SimObject
enum  _Flags { _CLEAR_ALL_FLAGS = 0 , _ALLOCATED_FLAG = 1<<0 , _EVAL_FLAG = 1<<1 , _HAS_NAME_FLAG = 1<<2 }
 

Detailed Description

State variables (memory) base for blocks with internal state (Relay, ...)

Definition at line 1335 of file simlib.h.

Constructor & Destructor Documentation

◆ Status()

simlib3::Status::Status ( Input  i,
double  initvalue = 0 
)

Definition at line 398 of file intg.cc.

References CtrInit(), and initval.

◆ ~Status()

simlib3::Status::~Status ( )

Member Function Documentation

◆ CtrInit()

void simlib3::Status::CtrInit ( )
protected

◆ Eval()

void simlib3::Status::Eval ( )
overridevirtual

evaluate without loop detection

Reimplemented from simlib3::aContiBlock.

Reimplemented in simlib3::Hyst, simlib3::Blash, and simlib3::Relay.

Definition at line 469 of file intg.cc.

References simlib3::aContiBlock1::InputValue(), st, and ValueOK.

◆ GetOldState()

double simlib3::Status::GetOldState ( void  )
inline

Definition at line 1358 of file simlib.h.

References stl.

◆ GetState()

double simlib3::Status::GetState ( void  )
inline

Definition at line 1356 of file simlib.h.

References st.

◆ Init() [1/2]

void simlib3::Status::Init ( )
inline

Definition at line 1347 of file simlib.h.

References Init(), and initval.

Referenced by Init().

◆ Init() [2/2]

void simlib3::Status::Init ( double  initvalue)

set initial value

Definition at line 419 of file intg.cc.

References initval, st, and ValueOK.

◆ Restore()

void simlib3::Status::Restore ( )

Definition at line 439 of file intg.cc.

References st, stl, and ValueOK.

◆ Save()

void simlib3::Status::Save ( )
inline

Definition at line 1353 of file simlib.h.

References st, and stl.

◆ Set()

void simlib3::Status::Set ( double  value)

set state variable value (step change)

Definition at line 429 of file intg.cc.

References st, and ValueOK.

◆ SetOldState()

void simlib3::Status::SetOldState ( double  s)
inline

Definition at line 1357 of file simlib.h.

References stl.

◆ SetState()

void simlib3::Status::SetState ( double  s)
inline

Definition at line 1355 of file simlib.h.

References st.

◆ SetValid()

void simlib3::Status::SetValid ( bool  flag)
inline

Definition at line 1359 of file simlib.h.

References simlib3::flag, and ValueOK.

◆ Value()

double simlib3::Status::Value ( )
overridevirtual

value of state variable

Implements simlib3::aContiBlock.

Definition at line 448 of file intg.cc.

References simlib3::aContiBlock::_Eval(), st, and ValueOK.

Referenced by Sample().

Member Data Documentation

◆ initval

double simlib3::Status::initval
protected

initial value

Definition at line 1337 of file simlib.h.

Referenced by Init(), and Status().

◆ it_list

StatusContainer::iterator simlib3::Status::it_list
protected

position in list of status variables

Definition at line 1340 of file simlib.h.

Referenced by CtrInit(), and ~Status().

◆ st

double simlib3::Status::st

◆ stl

double simlib3::Status::stl

status from previous step

Definition at line 1343 of file simlib.h.

Referenced by simlib3::Hyst::Eval(), simlib3::Blash::Eval(), simlib3::Relay::Eval(), GetOldState(), Restore(), Save(), and SetOldState().

◆ ValueOK

bool simlib3::Status::ValueOK
protected

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