FrameInstance Class Reference

FrameInstance holds traffic details such as PDUs, ports, etc. More...

Public Member Functions
TrafficType	getUserTrafficType ()
	Returns the user traffic type. More...
QString	getDestinationString ()
	Returns the destination. More...
QString	getSourceString ()
	Returns the source. More...
Device	getDevice ()
	Returns the current device the frame instance is at. More...
Device	getPreviousDevice ()
	Returns the previous device the frame instance was at. More...
Pdu	getInFrame ()
	Returns the inbound frame. More...
Pdu	getOutFrame ()
	Returns the outbound frame. More...
Port	getInPort ()
	Returns the inbound port. More...
Port	getOutPort (int)
	returns the outbound port at the specified index. More...
int	getOutPortCount ()
	Returns the number of outbound ports. More...
void	addDecision (string, QString, bool, int)
	Adds a flowchart decision with the specified ID and description at the specified layer. More...
FlowChartNode	getFlowChartNodeAt (int)
	Returns the flowchart node at the specified index. More...
FrameDecision	getFrameDecsionAt (int)
	Returns the frame decision at the specified index. More...
int	getFlowChartNodeCount ()
	Returns the number of flowchart nodes. More...
QString	getDecisionAt (int)
	Returns the decision at the specified index. More...
void	setFrameSent (bool)
	Sets the frame as sent or unsent. More...
bool	isFrameSent ()
	Returns true if the the frame is sent, otherwise false. More...
void	setFrameBuffered (bool)
	Sets the frame as buffered or unbuffered. More...
bool	isFrameBuffered ()
	Returns true if the the frame is buffered, otherwise false. More...
void	setFrameDropped (bool)
	Sets the frame as dropped or not dropped. More...
bool	isFrameDropped ()
	Returns true if the the frame is dropped, otherwise false. More...
void	setFrameNotForwarded (bool)
	Sets the frame as not forwarded or forwarded. More...
bool	isFrameNotForwarded ()
	Returns true if the the frame is not forwarded, otherwise false. More...
void	setFrameAccepted (bool)
	Sets the frame as accepted or not accepted. More...
bool	isFrameAccepted ()
	Returns true if the the frame is accepted, otherwise false. More...
void	setFrameUnexpected (bool)
	Sets the frame as unexpected or expected. More...
bool	isFrameUnexpected ()
	Returns true if the the frame is unexpected, otherwise false. More...
bool	isFrameCollidedOnLink ()
	Returns true if the frame collided on the link, otherwise false. More...
bool	isFrameCollidedAtDevice ()
	Returns true if the frame collided at the device, otherwise false. More...
bool	isFrameOnTransit ()
	Returns true if the frame is in transit, otherwise false. More...
int	getQosStampColorCode ()
	Returns the QoS stamp color code. More...
int	getInQosStampColorCode ()
	Returns the inbound QoS stamp color code. More...
int	getOutQosStampColorCode ()
	Returns the outbound QoS stamp color code. More...
int	getTransitTime ()
	Returns the transit time. More...
int	getPercentageSent ()
	Returns the percentage of the frame that was sent. More...
long	getStartSimTime ()
	Returns the simulation start time. More...
UserTraffic	getTrafficSource ()
	Returns the traffic source. More...
int	getTime ()
	Returns time of the frame instance. More...

Detailed Description

FrameInstance holds traffic details such as PDUs, ports, etc.

Member Function Documentation

addDecision()

void FrameInstance::addDecision	(	string	,
		QString	,
		bool	,
		int
	)

Adds a flowchart decision with the specified ID and description at the specified layer.

Parameters

id,the	flowchart ID.
description,the	flowchart description.
isOsiIn,true	if inbound layer decision, false if outbound layer decision.
osiLayer,the	OSI layer.

getDecisionAt()

QString FrameInstance::getDecisionAt

(

int

)

Returns the decision at the specified index.

Parameters

index,the

index of the decision of interest.

Returns

QString, the decision at the specified index.

getDestinationString()

QString FrameInstance::getDestinationString

(

)

Returns the destination.

Returns

QString, the destination.

getDevice()

Device FrameInstance::getDevice

(

)

Returns the current device the frame instance is at.

Returns

Device, the Device object the frame instance is at.

getFlowChartNodeAt()

FlowChartNode FrameInstance::getFlowChartNodeAt

(

int

)

Returns the flowchart node at the specified index.

Parameters

nodeIndex,the

index of the flowchart node of interest.

Returns

FlowChartNode, the FlowChartNode object att he specified index.

getFlowChartNodeCount()

int FrameInstance::getFlowChartNodeCount

(

)

Returns the number of flowchart nodes.

Returns

int, the number of flowchart nodes.

getFrameDecsionAt()

FrameDecision FrameInstance::getFrameDecsionAt

(

int

)

Returns the frame decision at the specified index.

Parameters

index,the

index of the frame decision of interest.

Returns

FrameDecision, the FrameDecision at the specified index.

getInFrame()

Pdu FrameInstance::getInFrame

(

)

Returns the inbound frame.

Returns

Pdu, the inbound frame Pdu object.

getInPort()

Port FrameInstance::getInPort

(

)

Returns the inbound port.

Returns

Port, the inbound Port object.

getInQosStampColorCode()

int FrameInstance::getInQosStampColorCode

(

)

Returns the inbound QoS stamp color code.

Returns

int, the inbound QoS stamp color code.

getOutFrame()

Pdu FrameInstance::getOutFrame

(

)

Returns the outbound frame.

Returns

Pdu, the outbound frame Pdu object.

getOutPort()

Port FrameInstance::getOutPort

(

int

)

returns the outbound port at the specified index.

Parameters

outPortIndex,the

index of the outbound port of interest.

Returns

Port, the outbound Port object at the specified index.

getOutPortCount()

int FrameInstance::getOutPortCount

(

)

Returns the number of outbound ports.

Returns

int, the number of outbound ports.

getOutQosStampColorCode()

int FrameInstance::getOutQosStampColorCode

(

)

Returns the outbound QoS stamp color code.

Returns

int, the outbound QoS stamp color code.

getPercentageSent()

int FrameInstance::getPercentageSent

(

)

Returns the percentage of the frame that was sent.

Returns

int, the percentage of the frame that was sent.

getPreviousDevice()

Device FrameInstance::getPreviousDevice

(

)

Returns the previous device the frame instance was at.

Returns

Device, the Device object the frame instance was at.

getQosStampColorCode()

int FrameInstance::getQosStampColorCode

(

)

Returns the QoS stamp color code.

Returns

int, the QoS stamp color code.

getSourceString()

QString FrameInstance::getSourceString

(

)

Returns the source.

Returns

QString, the source.

getStartSimTime()

long FrameInstance::getStartSimTime

(

)

Returns the simulation start time.

Returns

int, the simulation start time.

getTime()

int FrameInstance::getTime

(

)

Returns time of the frame instance.

Returns

int, time of the frame instance.

getTrafficSource()

UserTraffic FrameInstance::getTrafficSource

(

)

Returns the traffic source.

Returns

UserTraffic, the soure UserTraffic object.

getTransitTime()

int FrameInstance::getTransitTime

(

)

Returns the transit time.

Returns

int, the transit time.

getUserTrafficType()

TrafficType FrameInstance::getUserTrafficType

(

)

Returns the user traffic type.

Returns

enum<TrafficType>, the user traffic type. User traffic types: eTrafficType_Icmp = 0, eTrafficType_Tcp = 1, eTrafficType_Udp = 2, eTrafficType_RipV1 = 3, eTrafficType_RipV2 = 4, eTrafficType_Arp = 5, eTrafficType_Cdp = 6, eTrafficType_Dhcp = 7, eTrafficType_Nat = 8, eTrafficType_Eigrp = 9, eTrafficType_Vtp = 10, eTrafficType_Stp = 11, eTrafficType_Ospf = 12, eTrafficType_Dtp = 13, eTrafficType_Telnet = 14, eTrafficType_Ssh = 15, eTrafficType_Tftp = 16, eTrafficType_Http = 17, eTrafficType_Https = 18, eTrafficType_Dns = 19, eTrafficType_Icmpv6 = 20, eTrafficType_Lacp = 21, eTrafficType_Pagp = 22, eTrafficType_Ipsec = 23, eTrafficType_Ike = 24, eTrafficType_Syslog = 25, eTrafficType_Tacacs = 26, eTrafficType_Radius = 27, eTrafficType_Snmp = 28, eTrafficType_Ntp = 29, eTrafficType_Ftp = 30, eTrafficType_Smtp = 31, eTrafficType_Pop3 = 32, eTrafficType_Sccp = 33, eTrafficType_Rtp = 34, eTrafficType_H323 = 35, eTrafficType_Bgp = 36, eTrafficType_Hsrp = 37, eTrafficType_Hsrpv6 = 38, eTrafficType_Netflow = 39, eTrafficType_Ndv6 = 40, eTrafficType_Ripng = 41, eTrafficType_Dhcpv6 = 42, eTrafficType_Eigrpv6 = 43, eTrafficType_Ospfv6 = 44, eTrafficType_IoE = 45, eTrafficType_Ptp = 46, eTrafficType_Rep = 47, eTrafficType_CapwapUdp = 48, eTrafficType_Lldp = 49, eTrafficType_Span = 50, eTrafficType_IoETcp = 51, eTrafficType_Usb = 52, eTrafficType_Bluetooth = 53, eTrafficType_Custom = 1000

isFrameAccepted()

bool FrameInstance::isFrameAccepted

(

)

Returns true if the the frame is accepted, otherwise false.

Returns

bool, true if the the frame is accepted, otherwise false.

isFrameBuffered()

bool FrameInstance::isFrameBuffered

(

)

Returns true if the the frame is buffered, otherwise false.

Returns

bool, true if the the frame is buffered, otherwise false.

isFrameCollidedAtDevice()

bool FrameInstance::isFrameCollidedAtDevice

(

)

Returns true if the frame collided at the device, otherwise false.

Returns

bool, true if the frame collided at the device, otherwise false.

isFrameCollidedOnLink()

bool FrameInstance::isFrameCollidedOnLink

(

)

Returns true if the frame collided on the link, otherwise false.

Returns

bool, true if the frame collided on the link, otherwise false.

isFrameDropped()

bool FrameInstance::isFrameDropped

(

)

Returns true if the the frame is dropped, otherwise false.

Returns

bool, true if the the frame is dropped, otherwise false.

isFrameNotForwarded()

bool FrameInstance::isFrameNotForwarded

(

)

Returns true if the the frame is not forwarded, otherwise false.

Returns

bool, true if the the frame is not forwarded, otherwise false.

isFrameOnTransit()

bool FrameInstance::isFrameOnTransit

(

)

Returns true if the frame is in transit, otherwise false.

Returns

bool, true if the frame is in transit, otherwise false.

isFrameSent()

bool FrameInstance::isFrameSent

(

)

Returns true if the the frame is sent, otherwise false.

Returns

bool, true if the the frame is sent, otherwise false.

isFrameUnexpected()

bool FrameInstance::isFrameUnexpected

(

)

Returns true if the the frame is unexpected, otherwise false.

Returns

bool, true if the the frame is unexpected, otherwise false.

setFrameAccepted()

void FrameInstance::setFrameAccepted

(

bool

)

Sets the frame as accepted or not accepted.

Parameters

accepted,true

for accepted, false for not accepted.

setFrameBuffered()

void FrameInstance::setFrameBuffered

(

bool

)

Sets the frame as buffered or unbuffered.

Parameters

buffered,true

for buffered, false for unbuffered.

setFrameDropped()

void FrameInstance::setFrameDropped

(

bool

)

Sets the frame as dropped or not dropped.

Parameters

dropped,true

for dropped, false for not dropped.

setFrameNotForwarded()

void FrameInstance::setFrameNotForwarded

(

bool

)

Sets the frame as not forwarded or forwarded.

Parameters

notForwarded,true

for not forwarded, false for forwarded.

setFrameSent()

void FrameInstance::setFrameSent

(

bool

)

Sets the frame as sent or unsent.

Parameters

sent,true

for sent, false for unsent.

setFrameUnexpected()

void FrameInstance::setFrameUnexpected

(

bool

)

Sets the frame as unexpected or expected.

Parameters

unexpected,true

for unexpected, false for expected.

---

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

• CFrameInstance.pki