bbtk::BlackBoxInputConnector Class Reference

#include <bbtkBlackBoxInputConnector.h>

Collaboration diagram for bbtk::BlackBoxInputConnector:

[legend]

List of all members.

Classes
class	Pimpl
	The Pimpl. More...
Public Member Functions
	BlackBoxInputConnector (BlackBoxPointer b)
	Ctor.
	~BlackBoxInputConnector ()
	Dtor.
void	SetConnection (Connection *c)
	Sets a connection.
void	UnsetConnection (Connection *c)
Connection *	GetConnection () const
	Returns the connection plugged into this input (const).
bool	IsConnected () const
	Returns true iff a connection is connected to it.
void	RecursiveExecute ()
IOStatus	GetStatus () const
	Returns the status of the input.
void	SetStatus (IOStatus s)
	Sets the status of the input.
BlackBoxPointer	GetBlackBox () const
	Returns the black box which owns the connector.
Private Member Functions
void	PimplConstruct ()
void	PimplCopyConstruct (const BlackBoxInputConnector &)
void	PimplDestruct ()
	BlackBoxInputConnector (const BlackBoxInputConnector &)
	Purposedly not implemented.
Private Attributes
Pimpl *	p

---

Detailed Description

Definition at line 54 of file bbtkBlackBoxInputConnector.h.

---

Constructor & Destructor Documentation

bbtk::BlackBoxInputConnector::BlackBoxInputConnector

(

BlackBoxPointer

b

)

Ctor.

bbtk::BlackBoxInputConnector::~BlackBoxInputConnector

(

)

Dtor.

Definition at line 78 of file bbtkBlackBoxInputConnector.cxx.

References bbtkDebugMessage, and PimplDestruct().

  {
    bbtkDebugMessage("kernel",9,
                     "[DEAD BOX] ~BlackBoxInputConnector()"
                     <<std::endl);
    PimplDestruct();
  }

Here is the call graph for this function:

bbtk::BlackBoxInputConnector::BlackBoxInputConnector

(

const BlackBoxInputConnector &

)

[private]

Purposedly not implemented.

---

Member Function Documentation

BlackBoxPointer bbtk::BlackBoxInputConnector::GetBlackBox

(

)

const

Returns the black box which owns the connector.

Definition at line 125 of file bbtkBlackBoxInputConnector.cxx.

References bbtk::BlackBoxInputConnector::Pimpl::mBox, and p.

    { 
      return p->mBox.lock(); 
    } 

Connection * bbtk::BlackBoxInputConnector::GetConnection

(

)

const

Returns the connection plugged into this input (const).

Definition at line 89 of file bbtkBlackBoxInputConnector.cxx.

References bbtk::BlackBoxInputConnector::Pimpl::mConnection, and p.

  { 
    return p->mConnection; 
  }

IOStatus bbtk::BlackBoxInputConnector::GetStatus

(

)

const

Returns the status of the input.

Definition at line 107 of file bbtkBlackBoxInputConnector.cxx.

References bbtk::BlackBoxInputConnector::Pimpl::mStatus, and p.

   { 
     return p->mStatus; 
   }

bool bbtk::BlackBoxInputConnector::IsConnected

(

)

const

Returns true iff a connection is connected to it.

Definition at line 98 of file bbtkBlackBoxInputConnector.cxx.

References bbtk::BlackBoxInputConnector::Pimpl::mConnection, and p.

  { 
    return (p->mConnection != 0); 
  }

void bbtk::BlackBoxInputConnector::PimplConstruct

(

)

[private]

Definition at line 61 of file bbtkBlackBoxInputConnector.cxx.

void bbtk::BlackBoxInputConnector::PimplCopyConstruct

(

const BlackBoxInputConnector &

o

)

[private]

Definition at line 61 of file bbtkBlackBoxInputConnector.cxx.

void bbtk::BlackBoxInputConnector::PimplDestruct

(

)

[private]

Definition at line 61 of file bbtkBlackBoxInputConnector.cxx.

References bbtkDebugMessage.

Referenced by ~BlackBoxInputConnector().

Here is the caller graph for this function:

void bbtk::BlackBoxInputConnector::RecursiveExecute

(

)

Definition at line 154 of file bbtkBlackBoxInputConnector.cxx.

References bbtkDebugMessage, bbtk::BlackBoxInputConnector::Pimpl::mBox, bbtk::BlackBoxInputConnector::Pimpl::mConnection, bbtk::BlackBoxInputConnector::Pimpl::mStatus, bbtk::OUTOFDATE, p, and bbtk::Connection::RecursiveExecute().

  {
    // If connected and OUTOFDATE : recursive update
    // Post-update status is updated by the connection 
    // (either MODIFIED or OUTOFDATE)
    if ( p->mConnection && (p->mStatus == OUTOFDATE) )
      {
        p->mConnection->RecursiveExecute();
      }
    else
      {
        if (!p->mBox.expired())
          bbtkDebugMessage("process",5,"["<<p->mBox.lock()->bbGetName()
                           <<"] --> BlackBoxInputConnector::RecursiveExecute() : "
                           <<"No connection or input not Out-of-date : nothing to do"
                           <<std::endl);
        else
          bbtkDebugMessage("process",5,
                           "[DEAD BOX] --> BlackBoxInputConnector::RecursiveExecute() : "
                           <<"No connection or input not Out-of-date : nothing to do"
                           <<std::endl);
          
      }
  }

Here is the call graph for this function:

void bbtk::BlackBoxInputConnector::SetConnection

(

Connection *

c

)

Sets a connection.

Definition at line 133 of file bbtkBlackBoxInputConnector.cxx.

References bbtkDebugMessage, bbtk::BlackBoxInputConnector::Pimpl::mBox, bbtk::BlackBoxInputConnector::Pimpl::mConnection, and p.

  { 
    bbtkDebugMessage("kernel",9,
                     "["<<p->mBox.lock()->bbGetName()
                     <<"] BlackBoxInputConnector::SetConnection("<<c<<")"<<std::endl);
    p->mConnection = c; 
  }

void bbtk::BlackBoxInputConnector::SetStatus

(

IOStatus

s

)

Sets the status of the input.

Definition at line 115 of file bbtkBlackBoxInputConnector.cxx.

References bbtk::BlackBoxInputConnector::Pimpl::mStatus, and p.

Referenced by bbtk::BlackBox::bbSetStatusAndPropagate().

    { 
      p->mStatus = s; 
    }

Here is the caller graph for this function:

void bbtk::BlackBoxInputConnector::UnsetConnection

(

Connection *

c

)

Unsets the connection The parameter is USELESS today but would be useful if we allow multiple connections on inputs

Definition at line 143 of file bbtkBlackBoxInputConnector.cxx.

References bbtkDebugMessage, bbtk::BlackBoxInputConnector::Pimpl::mBox, bbtk::BlackBoxInputConnector::Pimpl::mConnection, and p.

  { 
    bbtkDebugMessage("kernel",9,
                     "["<<p->mBox.lock()->bbGetName()
                     <<"] BlackBoxInputConnector::UnsetConnection("
                     <<c<<")"<<std::endl);
    p->mConnection = 0; 
  }

---

Member Data Documentation

Pimpl* bbtk::BlackBoxInputConnector::p [private]

Definition at line 88 of file bbtkBlackBoxInputConnector.h.

Referenced by GetBlackBox(), GetConnection(), GetStatus(), IsConnected(), RecursiveExecute(), SetConnection(), SetStatus(), and UnsetConnection().

---

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

• /Users/davila/Creatis/All5/creatools_source/bbtk/kernel/src/bbtkBlackBoxInputConnector.h
• /Users/davila/Creatis/All5/creatools_source/bbtk/kernel/src/bbtkBlackBoxInputConnector.cxx