#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::DataTableKit:
HPS::SprocketKit HPS::Sprocket HPS::Object

Public Member Functions

 DataTableKit ()
 
 DataTableKit (DataTableKit const &in_kit)
 
 DataTableKit (DataTableKit &&in_kit)
 
bool Empty () const
 
bool Equals (DataTableKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (DataTableKit const &in_kit) const
 
DataTableKitoperator= (DataTableKit const &in_kit)
 
DataTableKitoperator= (DataTableKit &&in_kit)
 
bool operator== (DataTableKit const &in_kit) const
 
void Set (DataTableKit const &in_kit)
 
DataTableKitSetColumns (unsigned int in_value)
 
DataTableKitSetData (UTF8ArrayArray in_value)
 
DataTableKitSetRows (unsigned int in_value)
 
void Show (DataTableKit &out_kit) const
 
bool ShowColumns (unsigned int &out_number) const
 
bool ShowData (UTF8ArrayArray &out_data) const
 
bool ShowRows (unsigned int &out_number) const
 
DataTableKitUnsetColumns ()
 
DataTableKitUnsetData ()
 
DataTableKitUnsetRows ()
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Member Functions

static DataTableKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::PublishDataTableKit
 
- Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type staticType = HPS::Type::SprocketKit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::SprocketKit
SprocketKitoperator= (SprocketKit &&in_that)
 
 SprocketKit (SprocketKit &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ DataTableKit() [1/3]

HPS::Publish::DataTableKit::DataTableKit ( )

The default constructor creates an empty DataTableKit object.

◆ DataTableKit() [2/3]

HPS::Publish::DataTableKit::DataTableKit ( DataTableKit const &  in_kit)

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

Parameters
in_kitThe source DataTableKit to copy.

◆ DataTableKit() [3/3]

HPS::Publish::DataTableKit::DataTableKit ( DataTableKit &&  in_kit)

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

Parameters
in_kitAn rvalue reference to a DataTableKit to take the underlying object from.

Member Function Documentation

◆ Empty()

bool HPS::Publish::DataTableKit::Empty ( ) const
virtual

Indicates whether this DataTableKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Publish::DataTableKit::Equals ( DataTableKit const &  in_kit) const

Check if the source DataTableKit is equivalent to this DataTableKit.

Parameters
in_kitThe source DataTableKit to compare to this DataTableKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static DataTableKit HPS::Publish::DataTableKit::GetDefault ( )
static

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.

◆ ObjectType()

HPS::Type HPS::Publish::DataTableKit::ObjectType ( ) const
inlinevirtual

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.

Reimplemented from HPS::SprocketKit.

◆ operator!=()

bool HPS::Publish::DataTableKit::operator!= ( DataTableKit const &  in_kit) const

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

Parameters
in_kitThe source DataTableKit to compare to this DataTableKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

DataTableKit& HPS::Publish::DataTableKit::operator= ( DataTableKit const &  in_kit)

Copies the source DataTableKit into this DataTableKit.

Parameters
in_kitThe source DataTableKit to copy.
Returns
A reference to this DataTableKit.

◆ operator=() [2/2]

DataTableKit& HPS::Publish::DataTableKit::operator= ( DataTableKit &&  in_kit)

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

Parameters
in_kitAn rvalue reference to a DataTableKit to take the underlying object from.
Returns
A reference to this DataTableKit.

◆ operator==()

bool HPS::Publish::DataTableKit::operator== ( DataTableKit const &  in_kit) const

Check if the source DataTableKit is equivalent to this DataTableKit.

Parameters
in_kitThe source DataTableKit to compare to this DataTableKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::Publish::DataTableKit::Set ( DataTableKit const &  in_kit)

Copies the source DataTableKit into this DataTableKit.

Parameters
in_kitThe source DataTableKit to copy.

◆ SetColumns()

DataTableKit& HPS::Publish::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_valueThe number of columns of theData Table.
Returns
A reference to this DataTableKit.

◆ SetData()

DataTableKit& HPS::Publish::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_valueThe array of UTF8Array of data (string forms) to be put in the DataTable.
Returns
A reference to this DataTableKit.

◆ SetRows()

DataTableKit& HPS::Publish::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_valueThe number of rows of theData Table.
Returns
A reference to this DataTableKit.

◆ Show()

void HPS::Publish::DataTableKit::Show ( DataTableKit out_kit) const

Copies this DataTableKit into the given DataTableKit.

Parameters
out_kitThe DataTableKit to populate with the contents of this DataTableKit.

◆ ShowColumns()

bool HPS::Publish::DataTableKit::ShowColumns ( unsigned int &  out_number) const

Shows the number of columns of the DataTable.

Parameters
out_numberThe number of columns of the DataTable.
Returns
true if a number of columns was specified, false otherwise.

◆ ShowData()

bool HPS::Publish::DataTableKit::ShowData ( UTF8ArrayArray out_data) const

Shows the data stored inside the DataTable.

Parameters
out_dataThe data stored inside the DataTable.
Returns
true if the DataTable contains any data, false otherwise.

◆ ShowRows()

bool HPS::Publish::DataTableKit::ShowRows ( unsigned int &  out_number) const

Shows the number of rows of the DataTable.

Parameters
out_numberThe number of rows of the DataTable.
Returns
true if a number of rows was specified, false otherwise.

◆ UnsetColumns()

DataTableKit& HPS::Publish::DataTableKit::UnsetColumns ( )

Removes the columns setting.

Returns
A reference to this DataTableKit.

◆ UnsetData()

DataTableKit& HPS::Publish::DataTableKit::UnsetData ( )

Removes the Data setting.

Returns
A reference to this DataTableKit.

◆ UnsetRows()

DataTableKit& HPS::Publish::DataTableKit::UnsetRows ( )

Removes the rows setting.

Returns
A reference to this DataTableKit.

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