HPS::Publish::DataTableKit

class HPS::Publish::DataTableKit : public HPS::SprocketKit

The DataTableKit class is a user space object. It acts as the container for all data that can be used to specify a Data Table for a Publish PDF.

Public Functions

DataTableKit(): The default constructor creates an empty DataTableKit object.

DataTableKit(DataTableKit &&in_kit)

The move constructor creates a DataTableKit by transferring the underlying object of the rvalue reference to this DataTableKit.

Parameters: in_kit – An rvalue reference to a DataTableKit to take the underlying object from.

DataTableKit(DataTableKit const &in_kit)

The copy constructor creates a new DataTableKit object that contains the same settings as the source DataTableKit.

Parameters: in_kit – The source DataTableKit to copy.

virtual bool Empty() const

Indicates whether this DataTableKit has any values set on it.

Returns: true if no values are set on this DataTableKit, false otherwise.

bool Equals(DataTableKit const &in_kit) const

Check if the source DataTableKit is equivalent to this DataTableKit.

Parameters: in_kit – The source DataTableKit to compare to this DataTableKit.
Returns: true if the objects are equivalent, false otherwise.

inline virtual HPS::Type ObjectType() const

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns: The declared type of the object in question, which may differ from the true, underlying type.

bool operator!=(DataTableKit const &in_kit) const

Check if the source DataTableKit is not equivalent to this DataTableKit.

Parameters: in_kit – The source DataTableKit to compare to this DataTableKit.
Returns: true if the objects are not equivalent, false otherwise.

DataTableKit &operator=(DataTableKit &&in_kit)

The move assignment operator transfers the underlying object of the rvalue reference to this DataTableKit.

Parameters: in_kit – An rvalue reference to a DataTableKit to take the underlying object from.
Returns: A reference to this DataTableKit.

DataTableKit &operator=(DataTableKit const &in_kit)

Copies the source DataTableKit into this DataTableKit.

Parameters: in_kit – The source DataTableKit to copy.
Returns: A reference to this DataTableKit.

bool operator==(DataTableKit const &in_kit) const

Check if the source DataTableKit is equivalent to this DataTableKit.

Parameters: in_kit – The source DataTableKit to compare to this DataTableKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(DataTableKit const &in_kit)

Copies the source DataTableKit into this DataTableKit.

Parameters: in_kit – The source DataTableKit to copy.

DataTableKit &SetColumns(unsigned int in_value)

Sets the number of columns for the DataTable. This corresponds to the value that will be passed to 3DPDFDataTableData::m_iNbCols.

Parameters: in_value – The number of columns of theData Table.
Returns: A reference to this DataTableKit.

DataTableKit &SetData(UTF8ArrayArray in_value)

Sets the data for the DataTable. This corresponds to the value that will be passed to 3DPDFDataTableData::m_ppcTexts.

Parameters: in_value – The array of UTF8Array of data (string forms) to be put in the DataTable.
Returns: A reference to this DataTableKit.

DataTableKit &SetRows(unsigned int in_value)

Sets the number of rows for the DataTable. This corresponds to the value that will be passed to 3DPDFDataTableData::m_iNbRows.

Parameters: in_value – The number of rows of theData Table.
Returns: A reference to this DataTableKit.

void Show(DataTableKit &out_kit) const

Copies this DataTableKit into the given DataTableKit.

Parameters: out_kit – The DataTableKit to populate with the contents of this DataTableKit.

bool ShowColumns(unsigned int &out_number) const

Shows the number of columns of the DataTable.

Parameters: out_number – The number of columns of the DataTable.
Returns: true if a number of columns was specified, false otherwise.

bool ShowData(UTF8ArrayArray &out_data) const

Shows the data stored inside the DataTable.

Parameters: out_data – The data stored inside the DataTable.
Returns: true if the DataTable contains any data, false otherwise.

bool ShowRows(unsigned int &out_number) const

Shows the number of rows of the DataTable.

Parameters: out_number – The number of rows of the DataTable.
Returns: true if a number of rows was specified, false otherwise.

DataTableKit &UnsetColumns()

Removes the columns setting.

Returns: A reference to this DataTableKit.

DataTableKit &UnsetData()

Removes the Data setting.

Returns: A reference to this DataTableKit.

DataTableKit &UnsetRows()

Removes the rows setting.

Returns: A reference to this DataTableKit.

Public Static Functions

static DataTableKit GetDefault()

Creates a DataTableKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for a text field unless a setting is overridden by the DataTableKit passed to a function.

Returns: A DataTableKit with the default settings.