Fesapi  2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | List of all members
epc::FilePart Class Reference

#include <FilePart.h>

Public Member Functions

 FilePart ()
 
 FilePart (std::string outputPartPath)
 Constructor. More...
 
 ~FilePart ()=default
 Destructor.
 
const FileRelationshipgetFileRelationship () const
 Gets file relationship. More...
 
Relationship getIndexRelationship (int index) const
 
void addRelationship (const Relationship &relationship)
 
void createRelationship (const std::string &rsTarget, const std::string &rsType, const std::string &rsId, bool internalTarget=true)
 

Detailed Description

A file part.

Constructor & Destructor Documentation

◆ FilePart() [1/2]

epc::FilePart::FilePart ( )

Default constructor

◆ FilePart() [2/2]

epc::FilePart::FilePart ( std::string  outputPartPath)

Constructor.

Parameters
outputPartPathThe path of the part within the package.

Member Function Documentation

◆ addRelationship()

void epc::FilePart::addRelationship ( const Relationship relationship)

Copy an existing relationship into the relationship set of the part.

Parameters
relationshipThe relationship.

◆ createRelationship()

void epc::FilePart::createRelationship ( const std::string &  rsTarget,
const std::string &  rsType,
const std::string &  rsId,
bool  internalTarget = true 
)

Creates a new relationship into the relationship set of the part according to the supplied parameters

Parameters
rsTargetThe RS target.
rsTypeType of the RS.
rsIdIdentifier for the RS.
internalTarget(Optional) True to internal target.

◆ getFileRelationship()

const FileRelationship& epc::FilePart::getFileRelationship ( ) const

Gets file relationship.

Returns
The file relationship.

◆ getIndexRelationship()

Relationship epc::FilePart::getIndexRelationship ( int  index) const

Gets index relationship

Parameters
indexZero-based index of the.
Returns
The index relationship.

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