Implementation class for RateGroupDriver. More...

#include <Svc/RateGroupDriver/RateGroupDriver.hpp>

Inheritance diagram for Svc::RateGroupDriver:

Classes
class	Divider
	Struct describing a divider. More...

class	DividerSet
	Struct containing an array of dividers. More...

Public Member Functions
	RateGroupDriver (const char *compName)
	RateGroupDriver constructor. More...

void	configure (const DividerSet &dividersSet)
	RateGroupDriver configuration function. More...

	~RateGroupDriver ()
	RateGroupDriverImpl destructor. More...

Public Member Functions inherited from Svc::RateGroupDriverComponentBase
void	init (NATIVE_INT_TYPE instance=0)
	Initialize RateGroupDriverComponentBase object. More...

Svc::InputCyclePort *	get_CycleIn_InputPort (NATIVE_INT_TYPE portNum)

void	set_CycleOut_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputCyclePort *port)
	Connect port to CycleOut[portNum]. More...

Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base. More...

U32	getIdBase () const

Static Public Attributes
static const NATIVE_UINT_TYPE	DIVIDER_SIZE = NUM_CYCLEOUT_OUTPUT_PORTS
	Size of the divider table, provided as a constants to users passing the table in. More...

Additional Inherited Members
Protected Types inherited from Svc::RateGroupDriverComponentBase
enum	{ NUM_CYCLEIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_CYCLEOUT_OUTPUT_PORTS = 3 }
	Enumerations for numbers of typed output ports. More...

Protected Member Functions inherited from Svc::RateGroupDriverComponentBase
	RateGroupDriverComponentBase (const char *compName="")
	Construct RateGroupDriverComponentBase object. More...

virtual	~RateGroupDriverComponentBase ()
	Destroy RateGroupDriverComponentBase object. More...

NATIVE_INT_TYPE	getNum_CycleIn_InputPorts () const

NATIVE_INT_TYPE	getNum_CycleOut_OutputPorts () const

bool	isConnected_CycleOut_OutputPort (NATIVE_INT_TYPE portNum)

void	CycleIn_handlerBase (NATIVE_INT_TYPE portNum, Svc::TimerVal &cycleStart)
	Handler base-class function for input port CycleIn. More...

void	CycleOut_out (NATIVE_INT_TYPE portNum, Svc::TimerVal &cycleStart)
	Invoke output port CycleOut. More...

Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor. More...

virtual	~PassiveComponentBase ()
	Destructor. More...

void	init (NATIVE_INT_TYPE instance)
	Initialization function. More...

NATIVE_INT_TYPE	getInstance () const

Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor. More...

virtual	~ObjBase ()
	Destructor. More...

void	init ()
	Object initializer. More...

Detailed Description

Implementation class for RateGroupDriver.

Takes the input from CycleIn and divides it. Output rate is CycleIn rate/divider[port]

Definition at line 33 of file RateGroupDriver.hpp.

Constructor & Destructor Documentation

◆ RateGroupDriver()

Svc::RateGroupDriver::RateGroupDriver ( const char * compName )

RateGroupDriver constructor.

The constructor takes the divider array and stores it for use when the CycleIn port is called.

Parameters

compName component name

Definition at line 9 of file RateGroupDriver.cpp.

◆ ~RateGroupDriver()

Svc::RateGroupDriver::~RateGroupDriver ( )

RateGroupDriverImpl destructor.

Definition at line 40 of file RateGroupDriver.cpp.

Member Function Documentation

◆ configure()

void Svc::RateGroupDriver::configure ( const DividerSet & dividersSet )

RateGroupDriver configuration function.

Parameters

dividersSet set of dividers used to divide down input tick

Definition at line 15 of file RateGroupDriver.cpp.

Member Data Documentation

◆ DIVIDER_SIZE

const NATIVE_UINT_TYPE Svc::RateGroupDriver::DIVIDER_SIZE = NUM_CYCLEOUT_OUTPUT_PORTS

static

Size of the divider table, provided as a constants to users passing the table in.

Definition at line 37 of file RateGroupDriver.hpp.

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

Svc/RateGroupDriver/RateGroupDriver.hpp
Svc/RateGroupDriver/RateGroupDriver.cpp

Classes

Public Member Functions

Static Public Attributes

Additional Inherited Members