FGFCSChannel Class Reference

Detailed Description

Definition at line 72 of file FGFCSChannel.h.

Public Member Functions
	FGFCSChannel (FGFCS *FCS, const std::string &name, int execRate, SGPropertyNode *node=nullptr)
	Constructor.
	~FGFCSChannel ()
	Destructor.
void	Add (FGFCSComponent *comp)
	Adds a component to a channel.
void	Execute ()
	Executes all the components in a channel.
FGFCSComponent *	GetComponent (unsigned int i)
	Retrieves a specific component.
std::string	GetName ()
	Retrieves the name of the channel.
size_t	GetNumComponents ()
	Returns the number of components in the channel.
int	GetRate (void) const
	Get the channel rate.
void	Reset ()
	Reset the components that can be reset.

Constructor & Destructor Documentation

FGFCSChannel()

FGFCSChannel ( FGFCS *  FCS, const std::string &  name, int  execRate, SGPropertyNode *  node = nullptr  )

inline

Constructor.

Definition at line 75 of file FGFCSChannel.h.

    : fcs(FCS), OnOffNode(node), Name(name)
  {
    ExecRate = execRate < 1 ? 1 : execRate;
    // Set ExecFrameCountSinceLastRun so that each components are initialized
    ExecFrameCountSinceLastRun = ExecRate;
  }

~FGFCSChannel()

~FGFCSChannel ( )

inline

Destructor.

Definition at line 85 of file FGFCSChannel.h.

                  {
    for (unsigned int i=0; i<FCSComponents.size(); i++) delete FCSComponents[i];
    FCSComponents.clear();
  }

Member Function Documentation

Add()

void Add ( FGFCSComponent *  comp )

inline

Adds a component to a channel.

Definition at line 93 of file FGFCSChannel.h.

                                 {
    FCSComponents.push_back(comp);
  }

Here is the caller graph for this function:

Execute()

void Execute ( )

inline

Executes all the components in a channel.

Definition at line 118 of file FGFCSChannel.h.

                 {
    // If there is an on/off property supplied for this channel, check
    // the value. If it is true, permit execution to continue. If not, return
    // and do not execute the channel.
    if (OnOffNode && !OnOffNode->getBoolValue()) return;
 
    if (fcs->GetDt() != 0.0) {
      if (ExecFrameCountSinceLastRun >= ExecRate) {
        ExecFrameCountSinceLastRun = 0;
      }
 
      ++ExecFrameCountSinceLastRun;
    }
 
    // channel will be run at rate 1 if trimming, or when the next execrate
    // frame is reached
    if (fcs->GetTrimStatus() || ExecFrameCountSinceLastRun >= ExecRate) {
      for (unsigned int i=0; i<FCSComponents.size(); i++)
        FCSComponents[i]->Run();
    }
  }

GetComponent()

FGFCSComponent * GetComponent ( unsigned int  i )

inline

Retrieves a specific component.

Definition at line 99 of file FGFCSChannel.h.

                                               {
    if (i < GetNumComponents()) {
      return FCSComponents[i];
    } else {
      FGLogging log(LogLevel::ERROR);
      log << "Tried to get nonexistent component\n";
      return nullptr;
    }
  }

Here is the call graph for this function:

GetName()

std::string GetName ( )

inline

Retrieves the name of the channel.

Definition at line 90 of file FGFCSChannel.h.

{return Name;}

GetNumComponents()

size_t GetNumComponents ( )

inline

Returns the number of components in the channel.

Definition at line 97 of file FGFCSChannel.h.

{return FCSComponents.size();}

Here is the caller graph for this function:

GetRate()

int GetRate ( void  ) const

inline

Get the channel rate.

Definition at line 140 of file FGFCSChannel.h.

{ return ExecRate; }

Reset()

void Reset ( )

inline

Reset the components that can be reset.

Definition at line 109 of file FGFCSChannel.h.

               {
    for (unsigned int i=0; i<FCSComponents.size(); i++)
      FCSComponents[i]->ResetPastStates();
 
    // Set ExecFrameCountSinceLastRun so that each components are initialized
    // after a reset.
    ExecFrameCountSinceLastRun = ExecRate;
  }

---

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

• FGFCSChannel.h