CNiValuePairs

NI Measurement Studio CNi

previous page next page
Class CNiValuePairs Base ClassesData ItemsConstructorsDestructorsFunctionsGo to hierarchy chart    Prev page: SwapNext page: Count    
Class Declared in:
 NiValuepairs.h

'Overview' icon -- Shortcut to top of page. Overview

A CNiValuePairs object is a collection of value pairs on a CNiAxis or CNiAxis3D object.

  • Use the CNiAxis::ValuePairs or CNiAxis3D::ValuePairs property to obtain the associated value pair collection.
  • Use the Add function to create additional value pairs. Add returns a CNiValuePair object, which represents the new value pair.
  • Use the Item function to access existing value pairs in the collection. This function can access value pairs by either name or index.
  • Use the Remove function to remove existing value pairs from the collection. This function can access value pairs by either name or index.
  • Use the RemoveAll function to remove all value pairs from the collection.

Use the properties listed below to control the appearance of value pairs.

  • GridLines
  • LabelType
  • Location
  • MajorTicks

Hierarchy Chart Hierarchy Chart

'Base Classes' icon -- Shortcut to top of page. Base Classes

Public base class CNiInterface

'Data Items' icon -- Shortcut to top of page. Data Items

Public data short Count Returns the number of value pairs in the collection.
Public data bool GridLines Specifies if grid lines are drawn at value pair locations.
Public data ValuePairLabels LabelType Specifies the type of labels to draw for the value pairs.
Public data ValuePairLocations Location Specifies if value pairs are placed on the axis by their value or by their index.
Public data bool MajorTicks Specifies if major ticks are placed at the location of the value pairs.

'Constructors' icon -- Shortcut to top of page. Constructors

Public constructor

CNiValuePairs()

 Default constructor.
Public constructor

CNiValuePairs( CWValuePairs_CI* pCustom, CNiInterface::ThreadAccess option )

 Constructor that attaches to the specified CWValuePairs_CI pointer.
Public constructor

CNiValuePairs( const CNiValuePairs& source )

 Copy constructor.

'Destructors' icon -- Shortcut to top of page. Destructors

Public destructor

~CNiValuePairs()

 Destructor.

'Functions' icon -- Shortcut to top of page. Functions

Public function CNiValuePair

Add()

 Adds a value pair to the collection and returns the new value pair.
Public function static const IID &

GetIid()

 Returns the globally unique identifier (GUID) of the ActiveX interface to which this class connects.
Public function CNiValuePair

Item( const CString& valuePairName )

 Returns the specified value pair from the collection.
Public function CNiValuePair

Item( long valuePairIndex )

 Returns the specified value pair from the collection.
Public function const CNiValuePairs &

operator =( const CNiValuePairs& source )

 Assignment operator.
Public function void

Remove( const CString& valuePairName )

 Removes the specified value pair from the collection.
Public function void

Remove( long valuePairIndex )

 Removes the specified value pair from the collection.
Public function void

RemoveAll()

 Removes all value pairs from the collection.
Public function void

Swap( long element1, long element2 )

 Swaps two value pair elements, altering their indices.
previous page start next page