ACF $AcfVersion:0$
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
i2d::CGraphData2d Class Reference

Data model for a 2D graph plot supporting multiple curves. More...

#include <CGraphData2d.h>

Inheritance diagram for i2d::CGraphData2d:
i2d::CObject2dBase i2d::IObject2d iser::IObject i2d::ICalibrationProvider iser::ISerializable istd::IChangeable istd::IChangeable istd::IPolymorphic istd::IPolymorphic

Classes

struct  Curve
 Structure representing a single curve in the graph. More...
 

Public Types

enum  ChangeFlags { CF_GRAPH_DATA = 0x7c95a1 , CF_GRAPH_APPEARANCE , CF_GRAPH_DISPLAY_OPTIONS }
 
- Public Types inherited from i2d::IObject2d
enum  ChangeFlags { CF_OBJECT_POSITION = 0x6ba340 }
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,
  CF_DELEGATED , CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,
  SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 
typedef QMultiMap< QByteArray, QVariant > ChangeInfoMap
 

Public Member Functions

 CGraphData2d ()
 
int GetCurvesCount () const
 Get the number of curves in the graph.
 
const CurveGetCurve (int index) const
 Get a curve by index.
 
CurveGetCurveRef (int index)
 Get reference to a curve by index.
 
void AddCurve (const Curve &curve)
 Add a new curve to the graph.
 
void RemoveCurve (int index)
 Remove a curve by index.
 
void ClearCurves ()
 Clear all curves.
 
const QString & GetXAxisLabel () const
 Get the X-axis label.
 
void SetXAxisLabel (const QString &label)
 Set the X-axis label.
 
const QString & GetYAxisLabel () const
 Get the Y-axis label.
 
void SetYAxisLabel (const QString &label)
 Set the Y-axis label.
 
const QString & GetTitle () const
 Get the graph title.
 
void SetTitle (const QString &title)
 Set the graph title.
 
istd::CRange GetXAxisRange () const
 Get X-axis range.
 
void SetXAxisRange (const istd::CRange &range)
 Set X-axis range.
 
istd::CRange GetYAxisRange () const
 Get Y-axis range.
 
void SetYAxisRange (const istd::CRange &range)
 Set Y-axis range.
 
bool IsLegendVisible () const
 Check if legend should be shown.
 
void SetLegendVisible (bool visible=true)
 Set whether legend should be shown.
 
bool IsGridVisible () const
 Check if grid should be shown.
 
void SetGridVisible (bool visible=true)
 Set whether grid should be shown.
 
virtual CVector2d GetCenter () const override
 Returns center of this 2D-object.
 
virtual void MoveCenterTo (const CVector2d &position) override
 Move object to position position.
 
virtual CRectangle GetBoundingBox () const override
 Get bounding box of this shape.
 
virtual bool Transform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=NULL) override
 Transform this object using some transformation.
 
virtual bool InvTransform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=NULL) override
 Do inverse transformation of this object.
 
virtual bool GetTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=NULL) const override
 Calulate transformation of the object into second one.
 
virtual bool GetInvTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=NULL) const override
 Calulate inverse transformation of the object into second one.
 
virtual QByteArray GetFactoryId () const override
 
virtual bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
virtual int GetSupportedOperations () const override
 Get set of flags for supported operations.
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 
virtual istd::TUniqueInterfacePtr< istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
 Make a copy of this object.
 
- Public Member Functions inherited from i2d::CObject2dBase
 CObject2dBase ()
 
 CObject2dBase (const CObject2dBase &object2d)
 
 CObject2dBase (CObject2dBase &&object2d)
 
CObject2dBaseoperator= (const CObject2dBase &object2d)
 
CObject2dBaseoperator= (CObject2dBase &&object2d)
 
virtual const ICalibration2dGetCalibration () const override
 Get access to transformation object, which transforms a local logical coordinate system to global one.
 
virtual void SetCalibration (const ICalibration2d *calibrationPtr, bool releaseFlag=false) override
 Set calibration of this object.
 
virtual bool CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 Copy this object from another one.
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
 Reset data to its default state.
 
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 
- Public Member Functions inherited from istd::IChangeable
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object.
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction.
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction.
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes.
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes.
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Static Public Member Functions

static QByteArray GetTypeName ()
 
- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 

Additional Inherited Members

- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event.
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event.
 
- Static Protected Attributes inherited from i2d::CObject2dBase
static const ChangeSet s_objectMovedChange
 
static const ChangeSet s_objectModifiedChange
 

Detailed Description

Data model for a 2D graph plot supporting multiple curves.

Each curve is a series of 2D points with associated properties like name and color. The graph also maintains axis ranges, labels, and legend information.

Definition at line 25 of file CGraphData2d.h.

Member Enumeration Documentation

◆ ChangeFlags

Enumerator
CF_GRAPH_DATA 

Graph data (curves, points) changed.

CF_GRAPH_APPEARANCE 

Graph appearance (colors, names, labels) changed.

CF_GRAPH_DISPLAY_OPTIONS 

Display options (legend, grid visibility) changed.

Definition at line 30 of file CGraphData2d.h.

Constructor & Destructor Documentation

◆ CGraphData2d()

i2d::CGraphData2d::CGraphData2d ( )

Member Function Documentation

◆ AddCurve()

void i2d::CGraphData2d::AddCurve ( const Curve curve)

Add a new curve to the graph.

◆ ClearCurves()

void i2d::CGraphData2d::ClearCurves ( )

Clear all curves.

◆ CloneMe()

virtual istd::TUniqueInterfacePtr< istd::IChangeable > i2d::CGraphData2d::CloneMe ( CompatibilityMode  mode = CM_WITHOUT_REFS) const
overridevirtual

Make a copy of this object.

Returns
new instance or NULL, if this operation is not supported.

Reimplemented from istd::IChangeable.

◆ CopyFrom()

virtual bool i2d::CGraphData2d::CopyFrom ( const IChangeable &  object,
CompatibilityMode  mode = CM_WITHOUT_REFS 
)
overridevirtual

◆ GetBoundingBox()

virtual CRectangle i2d::CGraphData2d::GetBoundingBox ( ) const
overridevirtual

Get bounding box of this shape.

Please note, this bounding box is in logical units, the calibration will not be considered.

Implements i2d::IObject2d.

◆ GetCenter()

virtual CVector2d i2d::CGraphData2d::GetCenter ( ) const
overridevirtual

Returns center of this 2D-object.

Implements i2d::IObject2d.

◆ GetCurve()

const CGraphData2d::Curve & i2d::CGraphData2d::GetCurve ( int  index) const
inline

Get a curve by index.

Definition at line 218 of file CGraphData2d.h.

◆ GetCurveRef()

CGraphData2d::Curve & i2d::CGraphData2d::GetCurveRef ( int  index)
inline

Get reference to a curve by index.

Use with care and trigger notifications manually if needed.

Definition at line 224 of file CGraphData2d.h.

◆ GetCurvesCount()

int i2d::CGraphData2d::GetCurvesCount ( ) const
inline

Get the number of curves in the graph.

Definition at line 212 of file CGraphData2d.h.

◆ GetFactoryId()

virtual QByteArray i2d::CGraphData2d::GetFactoryId ( ) const
overridevirtual

Reimplemented from iser::IObject.

◆ GetInvTransformed()

virtual bool i2d::CGraphData2d::GetInvTransformed ( const ITransformation2d transformation,
IObject2d result,
ITransformation2d::ExactnessMode  mode = ITransformation2d::EM_NONE,
double *  errorFactorPtr = NULL 
) const
overridevirtual

Calulate inverse transformation of the object into second one.

Please note, that this operation transforms logical coordinates, it means that the calibration will be ignored.

Parameters
modecontrols needed transformation exactness.
errorFactorPtroptional output where approximated length of transformation error vector will be stored. Value 0 means that transformation is exactly done.
resultresult object.
Returns
true, if transformation was done correctly.

Reimplemented from i2d::CObject2dBase.

◆ GetSupportedOperations()

virtual int i2d::CGraphData2d::GetSupportedOperations ( ) const
overridevirtual

Get set of flags for supported operations.

See also
SupportedOperations

Reimplemented from istd::IChangeable.

◆ GetTitle()

const QString & i2d::CGraphData2d::GetTitle ( ) const
inline

Get the graph title.

Definition at line 242 of file CGraphData2d.h.

◆ GetTransformed()

virtual bool i2d::CGraphData2d::GetTransformed ( const ITransformation2d transformation,
IObject2d result,
ITransformation2d::ExactnessMode  mode = ITransformation2d::EM_NONE,
double *  errorFactorPtr = NULL 
) const
overridevirtual

Calulate transformation of the object into second one.

Please note, that this operation transforms logical coordinates, it means that the calibration will be ignored.

Parameters
modecontrols needed transformation exactness.
errorFactorPtroptional output where approximated length of transformation error vector will be stored. Value 0 means that transformation is exactly done.
resultresult object.
Returns
true, if transformation was done correctly.

Reimplemented from i2d::CObject2dBase.

◆ GetTypeName()

static QByteArray i2d::CGraphData2d::GetTypeName ( )
static

◆ GetXAxisLabel()

const QString & i2d::CGraphData2d::GetXAxisLabel ( ) const
inline

Get the X-axis label.

Definition at line 230 of file CGraphData2d.h.

◆ GetXAxisRange()

istd::CRange i2d::CGraphData2d::GetXAxisRange ( ) const

Get X-axis range.

If not set, returns auto-calculated range.

◆ GetYAxisLabel()

const QString & i2d::CGraphData2d::GetYAxisLabel ( ) const
inline

Get the Y-axis label.

Definition at line 236 of file CGraphData2d.h.

◆ GetYAxisRange()

istd::CRange i2d::CGraphData2d::GetYAxisRange ( ) const

Get Y-axis range.

If not set, returns auto-calculated range.

◆ InvTransform()

virtual bool i2d::CGraphData2d::InvTransform ( const ITransformation2d transformation,
ITransformation2d::ExactnessMode  mode = ITransformation2d::EM_NONE,
double *  errorFactorPtr = NULL 
)
overridevirtual

Do inverse transformation of this object.

Please note, that this operation transforms logical coordinates, it means that the calibration will be ignored.

Parameters
modecontrols needed transformation exactness.
errorFactorPtroptional output where approximated length of transformation error vector will be stored. Value 0 means that transformation is exactly done.
Returns
true, if transformation was done correctly.

Reimplemented from i2d::CObject2dBase.

◆ IsGridVisible()

bool i2d::CGraphData2d::IsGridVisible ( ) const
inline

Check if grid should be shown.

Definition at line 254 of file CGraphData2d.h.

◆ IsLegendVisible()

bool i2d::CGraphData2d::IsLegendVisible ( ) const
inline

Check if legend should be shown.

Definition at line 248 of file CGraphData2d.h.

◆ MoveCenterTo()

virtual void i2d::CGraphData2d::MoveCenterTo ( const CVector2d position)
overridevirtual

Move object to position position.

Implements i2d::IObject2d.

◆ RemoveCurve()

void i2d::CGraphData2d::RemoveCurve ( int  index)

Remove a curve by index.

◆ Serialize()

virtual bool i2d::CGraphData2d::Serialize ( iser::IArchive archive)
overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also
iser::IArchive

Implements iser::ISerializable.

◆ SetGridVisible()

void i2d::CGraphData2d::SetGridVisible ( bool  visible = true)

Set whether grid should be shown.

◆ SetLegendVisible()

void i2d::CGraphData2d::SetLegendVisible ( bool  visible = true)

Set whether legend should be shown.

◆ SetTitle()

void i2d::CGraphData2d::SetTitle ( const QString &  title)

Set the graph title.

◆ SetXAxisLabel()

void i2d::CGraphData2d::SetXAxisLabel ( const QString &  label)

Set the X-axis label.

◆ SetXAxisRange()

void i2d::CGraphData2d::SetXAxisRange ( const istd::CRange range)

Set X-axis range.

Set to invalid range for auto-calculation.

◆ SetYAxisLabel()

void i2d::CGraphData2d::SetYAxisLabel ( const QString &  label)

Set the Y-axis label.

◆ SetYAxisRange()

void i2d::CGraphData2d::SetYAxisRange ( const istd::CRange range)

Set Y-axis range.

Set to invalid range for auto-calculation.

◆ Transform()

virtual bool i2d::CGraphData2d::Transform ( const ITransformation2d transformation,
ITransformation2d::ExactnessMode  mode = ITransformation2d::EM_NONE,
double *  errorFactorPtr = NULL 
)
overridevirtual

Transform this object using some transformation.

Please note, that this operation transforms logical coordinates, it means that the calibration will be ignored.

Parameters
modecontrols needed transformation exactness.
errorFactorPtroptional output where approximated length of transformation error vector will be stored. Value 0 means that transformation is exactly done.
Returns
true, if transformation was done correctly.

Reimplemented from i2d::CObject2dBase.


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