Alert object storing alert metrics values. Start and stop values for each metric. More...

#include <Message_AttributeMeter.hxx>

Inheritance diagram for Message_AttributeMeter:

[legend]

Public Member Functions
	Message_AttributeMeter (const TCollection_AsciiString &theName=TCollection_AsciiString())
	Constructor with string argument.

Standard_Boolean	HasMetric (const Message_MetricType &theMetric) const
	Checks whether the attribute has values for the metric.

Standard_Boolean	IsMetricValid (const Message_MetricType &theMetric) const
	Returns true when both values of the metric are set.

Standard_Real	StartValue (const Message_MetricType &theMetric) const
	Returns start value for the metric.

void	SetStartValue (const Message_MetricType &theMetric, const Standard_Real theValue)
	Sets start values for the metric.

Standard_Real	StopValue (const Message_MetricType &theMetric) const
	Returns stop value for the metric.

void	SetStopValue (const Message_MetricType &theMetric, const Standard_Real theValue)
	Sets stop values for the metric.

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
	Dumps the content of me into the stream.

Public Member Functions inherited from Message_Attribute
	Message_Attribute (const TCollection_AsciiString &theName=TCollection_AsciiString())
	Empty constructor.

virtual Standard_CString	GetMessageKey () const
	Return a C string to be used as a key for generating text user messages describing this alert. The messages are generated with help of Message_Msg class, in Message_Report::Dump(). Base implementation returns dynamic type name of the instance.

const TCollection_AsciiString &	GetName () const
	Returns custom name of alert if it is set.

void	SetName (const TCollection_AsciiString &theName)
	Sets the custom name of alert.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static Standard_Real	UndefinedMetricValue ()
	Returns default value of the metric when it is not defined.

static void	StartAlert (const Handle< Message_AlertExtended > &theAlert)
	Sets start values of default report metrics into the alert.

static void	StopAlert (const Handle< Message_AlertExtended > &theAlert)
	Sets stop values of default report metrics into the alert.

static void	SetAlertMetrics (const Handle< Message_AlertExtended > &theAlert, const Standard_Boolean theStartValue)
	Sets current values of default report metrics into the alert. Processed only alert with Message_AttributeMeter attribute.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Detailed Description

Alert object storing alert metrics values. Start and stop values for each metric.

Constructor & Destructor Documentation

◆ Message_AttributeMeter()

Message_AttributeMeter::Message_AttributeMeter ( const TCollection_AsciiString & theName = TCollection_AsciiString() )

Constructor with string argument.

Member Function Documentation

◆ DumpJson()

virtual void Message_AttributeMeter::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = `-1`
	)		const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from Message_Attribute.

◆ HasMetric()

Standard_Boolean Message_AttributeMeter::HasMetric ( const Message_MetricType & theMetric ) const

Checks whether the attribute has values for the metric.

Parameters

theMetric [in] metric type

Returns: true if the metric values exist in the attribute

◆ IsMetricValid()

Standard_Boolean Message_AttributeMeter::IsMetricValid ( const Message_MetricType & theMetric ) const

Returns true when both values of the metric are set.

Parameters

theMetric [in] metric type

Returns: true if metric values are valid

◆ SetAlertMetrics()

static void Message_AttributeMeter::SetAlertMetrics	(	const Handle< Message_AlertExtended > &	theAlert,
		const Standard_Boolean	theStartValue
	)

static

Sets current values of default report metrics into the alert. Processed only alert with Message_AttributeMeter attribute.

Parameters

theAlert	an alert
theStartValue	flag, if true, the start value is collected otherwise stop

◆ SetStartValue()

void Message_AttributeMeter::SetStartValue	(	const Message_MetricType &	theMetric,
		const Standard_Real	theValue
	)

Sets start values for the metric.

Parameters

theMetric [in] metric type

◆ SetStopValue()

void Message_AttributeMeter::SetStopValue	(	const Message_MetricType &	theMetric,
		const Standard_Real	theValue
	)

Sets stop values for the metric.

Parameters

theMetric [in] metric type

◆ StartAlert()

static void Message_AttributeMeter::StartAlert ( const Handle< Message_AlertExtended > & theAlert )

inlinestatic

Sets start values of default report metrics into the alert.

Parameters

theAlert an alert

◆ StartValue()

Standard_Real Message_AttributeMeter::StartValue ( const Message_MetricType & theMetric ) const

Returns start value for the metric.

Parameters

theMetric [in] metric type

Returns: real value

◆ StopAlert()

static void Message_AttributeMeter::StopAlert ( const Handle< Message_AlertExtended > & theAlert )

inlinestatic

Sets stop values of default report metrics into the alert.

Parameters

theAlert an alert

◆ StopValue()

Standard_Real Message_AttributeMeter::StopValue ( const Message_MetricType & theMetric ) const

Returns stop value for the metric.

Parameters

theMetric [in] metric type

Returns: real value

◆ UndefinedMetricValue()

static Standard_Real Message_AttributeMeter::UndefinedMetricValue ( )

inlinestatic

Returns default value of the metric when it is not defined.

Returns: undefined value

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

Message_AttributeMeter.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Message_AttributeMeter()

Member Function Documentation

◆ DumpJson()

◆ HasMetric()

◆ IsMetricValid()

◆ SetAlertMetrics()

◆ SetStartValue()

◆ SetStopValue()

◆ StartAlert()

◆ StartValue()

◆ StopAlert()

◆ StopValue()

◆ UndefinedMetricValue()