Traffic graph configuration used when creating

See also: Analyzer.Graph.TrafficGraph

Inheritance diagram for Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration:

[legend]

Collaboration diagram for Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration:

[legend]

Public Member Functions
override string	GetAltName (GraphSetConfiguration owner, string postfix)
	Gets the alternative name when referred to from web pages. More...

override Uri	GetLink (GraphSetConfiguration owner, string postfix)
	Gets the link to use when referred to from web pages. More...

override string	GetTitle (NamedObject namedObject)

Public Member Functions inherited from Ntp.Analyzer.Config.Node.Graph.GraphBaseConfiguration
string	GetAltName (GraphSetConfiguration owner)

Uri	GetLink (GraphSetConfiguration owner)

Public Attributes
bool	FixedRun => fixedRun ?? true

override ImageFormat	Format => ImageFormat.Png
	Gets the format to use for destinations. More...

int	Frequency => frequency ?? 5

override DateTimeKind	GraphTime => graphTime ?? DateTimeKind.Utc
	Gets the timezone to use for timeline. More...

override int	Height => height ?? 550
	Gets the height in pixels of generated graph. More...

bool	InitialRun => initialRun ?? false

int	PacketRate => packetRate ?? 1

int	PlotInterval => plotInterval ?? 15

override int	Timespan => timespan ?? 60*12
	Gets the timespan for this graph. More...

override int	Width => width ?? 1024
	Gets the width in pixels of generated graph. More...

Public Attributes inherited from Ntp.Analyzer.Config.Node.Graph.GraphBaseConfiguration
string	GraphName => ConfigName
	Gets the name of this graph. More...

IEnumerable< StreamDestination >	Locations => Destinations.Destinations

Public Attributes inherited from Ntp.Analyzer.Config.Node.HostSubConfiguration
override string	FilePath => Server.FilePath
	Gets the file path in the HostSubConfiguration. More...

int	HostId => Server.HostId
	Gets the host identifier in the HostSubConfiguration. More...

string	ServerName => Server.ServerName
	Gets the name of the server in the HostSubConfiguration. More...

ServerType	ServerType => Server.ServerType
	Gets the type of the server in the HostSubConfiguration. More...

Uri	WebPath => Server.WebPath
	Gets the web path in the HostSubConfiguration. More...

Public Attributes inherited from Ntp.Analyzer.Config.Node.ConfigurationNode
virtual string	FilePath => Parent.FilePath + SubPath

virtual string	SubPath => string.Empty

Package Functions
	TrafficGraphConfiguration (string name, int?frequency, bool?initialRun, bool?fixedRun, string title, int?width, int?height, int?timespan, DateTimeKind?graphTime, double?received, double?ignored, double?dropped, double?sent, double?notSent, double?receivedAvg, double?ignoredAvg, double?droppedAvg, double?sentAvg, double?notSentAvg, int?plotInterval, int?packetRate, DestinationCollection destinations, WebLinkCollection links)

Package Functions inherited from Ntp.Analyzer.Config.Node.ConfigurationNode
virtual void	Assemble ()

Properties
override WebLinkCollection	ConfigLinks `[get]`

override DestinationCollection	Destinations `[get]`

double	Dropped `[get]`

double	DroppedAvg `[get]`

double	Ignored `[get]`

double	IgnoredAvg `[get]`

double	NotSent `[get]`

double	NotSentAvg `[get]`

double	Received `[get]`

double	ReceivedAvg `[get]`

double	Sent `[get]`

double	SentAvg `[get]`

override string	Title `[get]`
	Gets the title of this graph. More...

Properties inherited from Ntp.Analyzer.Config.Node.Graph.GraphBaseConfiguration
abstract WebLinkCollection	ConfigLinks `[get]`

abstract DestinationCollection	Destinations `[get]`

abstract ImageFormat	Format `[get]`
	Gets the format to use for destinations. More...

abstract DateTimeKind	GraphTime `[get]`

abstract int	Height `[get]`
	Gets the height in pixels of generated graph. More...

abstract int	Timespan `[get]`
	Gets the timespan for this graph. More...

abstract string	Title `[get]`
	Gets the title of this graph. More...

abstract int	Width `[get]`
	Gets the width in pixels of generated graph. More...

Properties inherited from Ntp.Analyzer.Config.Node.ConfigurationNode
string	ConfigName `[get]`

ConfigurationNode	Parent `[get, set]`

Properties inherited from Ntp.Analyzer.Interface.IConfigurationNode
string	ConfigName `[get]`

Properties inherited from Ntp.Analyzer.Interface.IGraphBaseConfiguration
ImageFormat	Format `[get]`

DateTimeKind	GraphTime `[get]`

int	Height `[get]`

IEnumerable< StreamDestination >	Locations `[get]`

int	Timespan `[get]`

string	Title `[get]`

int	Width `[get]`

Properties inherited from Ntp.Analyzer.Interface.ITrafficGraphConfiguration
double	Dropped `[get]`

double	DroppedAvg `[get]`

int	HostId `[get]`

double	Ignored `[get]`

double	IgnoredAvg `[get]`

double	NotSent `[get]`

double	NotSentAvg `[get]`

int	PacketRate `[get]`

int	PlotInterval `[get]`

double	Received `[get]`

double	ReceivedAvg `[get]`

double	Sent `[get]`

double	SentAvg `[get]`

Properties inherited from Ntp.Common.Process.IJobConfiguration
string	ConfigName `[get]`

bool	FixedRun `[get]`

int	Frequency `[get]`

bool	InitialRun `[get]`

Private Attributes
readonly bool	fixedRun

readonly int	frequency

readonly DateTimeKind	graphTime

readonly int	height

readonly bool	initialRun

readonly int	packetRate

readonly int	plotInterval

readonly int	timespan

readonly int	width

Additional Inherited Members
Protected Member Functions inherited from Ntp.Analyzer.Config.Node.Graph.GraphBaseConfiguration
	GraphBaseConfiguration (string name)

Protected Member Functions inherited from Ntp.Analyzer.Config.Node.HostSubConfiguration
	HostSubConfiguration (string name)

Protected Member Functions inherited from Ntp.Analyzer.Config.Node.ConfigurationNode
	ConfigurationNode (string name)

Protected Attributes inherited from Ntp.Analyzer.Config.Node.Graph.GraphBaseConfiguration
WebLinkCollection	Links => new WebLinkCollection(null, new List<WebLink> {new WebLink(Destinations.First().Link)})

Protected Attributes inherited from Ntp.Analyzer.Config.Node.HostSubConfiguration
HostConfiguration	Server => Parent as HostConfiguration

Detailed Description

Traffic graph configuration used when creating

See also: Analyzer.Graph.TrafficGraph

.

Definition at line 37 of file TrafficGraphConfiguration.cs.

Constructor & Destructor Documentation

Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.TrafficGraphConfiguration	(	string	name,
		int?	frequency,
		bool?	initialRun,
		bool?	fixedRun,
		string	title,
		int?	width,
		int?	height,
		int?	timespan,
		DateTimeKind?	graphTime,
		double?	received,
		double?	ignored,
		double?	dropped,
		double?	sent,
		double?	notSent,
		double?	receivedAvg,
		double?	ignoredAvg,
		double?	droppedAvg,
		double?	sentAvg,
		double?	notSentAvg,
		int?	plotInterval,
		int?	packetRate,
		DestinationCollection	destinations,
		WebLinkCollection	links
	)

inlinepackage

Definition at line 40 of file TrafficGraphConfiguration.cs.

             : base(name)
         {
             this.frequency = frequency;
             this.initialRun = initialRun;
             this.fixedRun = fixedRun;
             Title = title;
             this.timespan = timespan;
             this.height = height;
             this.width = width;
             this.graphTime = graphTime;
             Received = received;
             Ignored = ignored;
             Dropped = dropped;
             Sent = sent;
             NotSent = notSent;
             ReceivedAvg = receivedAvg;
             IgnoredAvg = ignoredAvg;
             DroppedAvg = droppedAvg;
             SentAvg = sentAvg;
             NotSentAvg = notSentAvg;
             this.plotInterval = plotInterval;
             this.packetRate = packetRate;
             Destinations = destinations;
             ConfigLinks = links;
         }

Member Function Documentation

override string Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.GetAltName	(	GraphSetConfiguration	owner,
		string	postfix
	)

inlinevirtual

Gets the alternative name when referred to from web pages.

Returns: The alternate name.

Parameters

owner	Owner.
postfix	Text to prepend

Implements Ntp.Analyzer.Config.Node.Graph.GraphBaseConfiguration.

Definition at line 221 of file TrafficGraphConfiguration.cs.

References Ntp.Analyzer.Config.Node.Destination.GraphSetConfiguration.LinkIndex.

         {
             int index = owner.LinkIndex;
             string name = Links.Destinations[index - 1].Link;
 
             // remove any path from name
             int pos = name.LastIndexOf('/');
             name = pos != -1 ? name.Remove(0, pos + 1) : name;
 
             return name;
         }

override Uri Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.GetLink	(	GraphSetConfiguration	owner,
		string	postfix
	)

inlinevirtual

Gets the link to use when referred to from web pages.

Returns: The link.

Parameters

owner	Owner.
postfix	Text to prepend

Implements Ntp.Analyzer.Config.Node.Graph.GraphBaseConfiguration.

Definition at line 239 of file TrafficGraphConfiguration.cs.

References Ntp.Analyzer.Config.Node.Destination.GraphSetConfiguration.LinkIndex.

         {
             return WebPath.Append(Links.Destinations[owner.LinkIndex - 1].Link);
         }

override string Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.GetTitle ( NamedObject namedObject )

inlinevirtual

Implements Ntp.Analyzer.Config.Node.Graph.GraphBaseConfiguration.

Definition at line 244 of file TrafficGraphConfiguration.cs.

         {
             return Title;
         }

Member Data Documentation

readonly bool Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.fixedRun

private

Definition at line 90 of file TrafficGraphConfiguration.cs.

bool Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.FixedRun => fixedRun ?? true

Definition at line 118 of file TrafficGraphConfiguration.cs.

override ImageFormat Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.Format => ImageFormat.Png

Gets the format to use for destinations.

The format.

Definition at line 157 of file TrafficGraphConfiguration.cs.

readonly int Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.frequency

private

Definition at line 91 of file TrafficGraphConfiguration.cs.

int Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.Frequency => frequency ?? 5

Definition at line 110 of file TrafficGraphConfiguration.cs.

readonly DateTimeKind Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.graphTime

private

Definition at line 92 of file TrafficGraphConfiguration.cs.

override DateTimeKind Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.GraphTime => graphTime ?? DateTimeKind.Utc

Gets the timezone to use for timeline.

The graph timezone.

Definition at line 213 of file TrafficGraphConfiguration.cs.

readonly int Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.height

private

Definition at line 93 of file TrafficGraphConfiguration.cs.

override int Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.Height => height ?? 550

Gets the height in pixels of generated graph.

The height.

Definition at line 150 of file TrafficGraphConfiguration.cs.

readonly bool Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.initialRun

private

Definition at line 94 of file TrafficGraphConfiguration.cs.

bool Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.InitialRun => initialRun ?? false

Definition at line 114 of file TrafficGraphConfiguration.cs.

readonly int Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.packetRate

private

Definition at line 95 of file TrafficGraphConfiguration.cs.

int Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.PacketRate => packetRate ?? 1

Definition at line 205 of file TrafficGraphConfiguration.cs.

readonly int Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.plotInterval

private

Definition at line 96 of file TrafficGraphConfiguration.cs.

int Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.PlotInterval => plotInterval ?? 15

Definition at line 201 of file TrafficGraphConfiguration.cs.

readonly int Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.timespan

private

Definition at line 97 of file TrafficGraphConfiguration.cs.

override int Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.Timespan => timespan ?? 60*12

Gets the timespan for this graph.

The timespan.

Definition at line 134 of file TrafficGraphConfiguration.cs.

readonly int Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.width

private

Definition at line 98 of file TrafficGraphConfiguration.cs.

override int Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.Width => width ?? 1024

Gets the width in pixels of generated graph.

The width.

Definition at line 142 of file TrafficGraphConfiguration.cs.

Property Documentation

override WebLinkCollection Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.ConfigLinks

get

Definition at line 106 of file TrafficGraphConfiguration.cs.

override DestinationCollection Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.Destinations

get

Definition at line 102 of file TrafficGraphConfiguration.cs.

double Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.Dropped

get

Definition at line 169 of file TrafficGraphConfiguration.cs.

double Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.DroppedAvg

get

Definition at line 189 of file TrafficGraphConfiguration.cs.

double Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.Ignored

get

Definition at line 165 of file TrafficGraphConfiguration.cs.

double Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.IgnoredAvg

get

Definition at line 185 of file TrafficGraphConfiguration.cs.

double Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.NotSent

get

Definition at line 177 of file TrafficGraphConfiguration.cs.

double Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.NotSentAvg

get

Definition at line 197 of file TrafficGraphConfiguration.cs.

double Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.Received

get

Definition at line 161 of file TrafficGraphConfiguration.cs.

double Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.ReceivedAvg

get

Definition at line 181 of file TrafficGraphConfiguration.cs.

double Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.Sent

get

Definition at line 173 of file TrafficGraphConfiguration.cs.

double Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.SentAvg

get

Definition at line 193 of file TrafficGraphConfiguration.cs.

override string Ntp.Analyzer.Config.Node.Graph.TrafficGraphConfiguration.Title

get

Gets the title of this graph.

The title.

Definition at line 126 of file TrafficGraphConfiguration.cs.

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

Ntp.Analyzer/Config/Node/Graph/TrafficGraphConfiguration.cs

Public Member Functions

Public Attributes

Package Functions

Properties

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation