CompoundPacketQueueTutorialStep

network

(no description)

Usage diagram

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Properties

Name	Value	Description
isNetwork
display	bgb=600,200

Unassigned submodule parameters

Name	Type	Default value	Description
producer.displayStringTextFormat	string	"created %p pk (%l)"	determines the text that is written on top of the submodule
producer.packetNameFormat	string	"%a-%c"	see directives in module documentation
producer.packetRepresentation	string	"byteCount"	determines the chunk of the packet data
producer.packetLength	int
producer.packetData	int	-1
producer.attachCreationTimeTag	bool	true
producer.attachIdentityTag	bool	true
producer.attachDirectionTag	bool	true
producer.clockModule	string	""	relative path of a module that implements IClock(1,2); optional
producer.initialProductionOffset	double	0s
producer.productionInterval	double		elapsed time between subsequent packets pushed to the connected packet consumer
producer.scheduleForAbsoluteTime	bool	true	when a clock is used relative means that setting the clock will not affect the simulation time of the event
queue.classifier.displayStringTextFormat	string	"classified %p pk (%l)"	determines the text that is written on top of the submodule
queue.classifier.reverseOrder	bool	false
queue.classifier.weights	string
queue.queue1.displayStringTextFormat	string	"contains %p pk (%l) pushed %u\npulled %o removed %r dropped %d"	determines the text that is written on top of the submodule
queue.queue1.packetCapacity	int	-1	maximum number of packets in the queue, no limit by default
queue.queue1.dataCapacity	int	-1b	maximum total length of packets in the queue, no limit by default
queue.queue1.dropperClass	string	""	determines which packets are dropped when the queue is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class
queue.queue1.comparatorClass	string	""	determines the order of packets in the queue, insertion order by default; the parameter must be the name of a C++ class which implements the IPacketComparatorFunction C++ interface and is registered via Register_Class
queue.queue1.bufferModule	string	""	relative module path to the IPacketBuffer module used by this queue, implicit buffer by default
queue.queue2.displayStringTextFormat	string	"contains %p pk (%l) pushed %u\npulled %o removed %r dropped %d"	determines the text that is written on top of the submodule
queue.queue2.packetCapacity	int	-1	maximum number of packets in the queue, no limit by default
queue.queue2.dataCapacity	int	-1b	maximum total length of packets in the queue, no limit by default
queue.queue2.dropperClass	string	""	determines which packets are dropped when the queue is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class
queue.queue2.comparatorClass	string	""	determines the order of packets in the queue, insertion order by default; the parameter must be the name of a C++ class which implements the IPacketComparatorFunction C++ interface and is registered via Register_Class
queue.queue2.bufferModule	string	""	relative module path to the IPacketBuffer module used by this queue, implicit buffer by default
queue.queue3.displayStringTextFormat	string	"contains %p pk (%l) pushed %u\npulled %o removed %r dropped %d"	determines the text that is written on top of the submodule
queue.queue3.packetCapacity	int	-1	maximum number of packets in the queue, no limit by default
queue.queue3.dataCapacity	int	-1b	maximum total length of packets in the queue, no limit by default
queue.queue3.dropperClass	string	""	determines which packets are dropped when the queue is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class
queue.queue3.comparatorClass	string	""	determines the order of packets in the queue, insertion order by default; the parameter must be the name of a C++ class which implements the IPacketComparatorFunction C++ interface and is registered via Register_Class
queue.queue3.bufferModule	string	""	relative module path to the IPacketBuffer module used by this queue, implicit buffer by default
queue.consumer.displayStringTextFormat	string	"received %p pk (%l)"	determines the text that is written on top of the submodule
queue.consumer.clockModule	string	""	relative path of a module that implements IClock(1,2); optional
queue.consumer.consumptionInterval	double	0s	elapsed time between subsequent packets allowed to be pushed by the connected packet producer, 0 means any number of packets can be pushed at the same simulation time
queue.consumer.scheduleForAbsoluteTime	bool	true	when a clock is used relative means that setting the clock will not affect the simulation time of the event
queue.producer.displayStringTextFormat	string	"created %p pk (%l)"	determines the text that is written on top of the submodule
queue.producer.packetNameFormat	string	"%a-%c"	see directives in module documentation
queue.producer.packetRepresentation	string	"byteCount"	determines the chunk of the packet data
queue.producer.packetLength	int
queue.producer.packetData	int	-1
queue.producer.attachCreationTimeTag	bool	true
queue.producer.attachIdentityTag	bool	true
queue.producer.attachDirectionTag	bool	true
queue.producer.clockModule	string	""	relative path of a module that implements IClock(1,2); optional
queue.producer.initialProductionOffset	double	0s
queue.producer.productionInterval	double		elapsed time between subsequent packets pushed to the connected packet consumer
queue.producer.scheduleForAbsoluteTime	bool	true	when a clock is used relative means that setting the clock will not affect the simulation time of the event
queue.scheduler.displayStringTextFormat	string	"scheduled %p pk (%l)"	determines the text that is written on top of the submodule
queue.scheduler.reverseOrder	bool	false
collector.displayStringTextFormat	string	"received %p pk (%l)"	determines the text that is written on top of the submodule
collector.clockModule	string	""	relative path of a module that implements IClock(1,2); optional
collector.initialCollectionOffset	double	0s
collector.collectionInterval	double		elapsed time between subsequent packets pulled from the connected packet provider
collector.scheduleForAbsoluteTime	bool	true	when a clock is used relative means that setting the clock will not affect the simulation time of the event

Source code

network CompoundPacketQueueTutorialStep
{
    @display("bgb=600,200");
    submodules:
        producer: ActivePacketSource {
            @display("p=100,100");
        }
        queue: ExampleCompoundPriorityQueue {
            @display("p=300,100");
        }
        collector: ActivePacketSink {
            @display("p=500,100");
        }
    connections allowunconnected:
        producer.out --> queue.in;
        queue.out --> collector.in;
}

//-------------------------------------------------

File: tutorials/queueing/QueueingTutorial.ned