epc::FileRelationship Class Reference

#include <FileRelationship.h>

Public Member Functions
	FileRelationship ()
	FileRelationship (const Relationship &frRelationship)
	FileRelationship (const std::vector< Relationship > &frRelationship)
	~FileRelationship ()=default
bool	isEmpty () const
const std::string &	getPathName () const
const std::vector< Relationship > &	getAllRelationship () const
Relationship	getIndexRelationship (size_t index) const
std::string	toString () const
void	setPathName (const std::string &frPathName)
void	addRelationship (const Relationship &frRelationship)
void	readFromString (const std::string &textInput)

Detailed Description

This class intends to represent any rel file of the package.

Constructor & Destructor Documentation

FileRelationship() [1/3]

epc::FileRelationship::FileRelationship ( )

inline

CONSTRUCTORS

FileRelationship() [2/3]

epc::FileRelationship::FileRelationship ( const Relationship & frRelationship )

explicit

Constructor

Parameters

frRelationship

The fr relationship.

FileRelationship() [3/3]

epc::FileRelationship::FileRelationship ( const std::vector< Relationship > & frRelationship )

explicit

Constructor

Parameters

frRelationship

The fr relationship.

~FileRelationship()

epc::FileRelationship::~FileRelationship ( )

default

Destructor

Member Function Documentation

addRelationship()

void epc::FileRelationship::addRelationship

(

const Relationship &

frRelationship

)

Adds a relationship

Parameters

frRelationship

The fr relationship.

getAllRelationship()

const std::vector< Relationship > & epc::FileRelationship::getAllRelationship ( ) const

inline

Gets all relationship

Returns

all relationship.

getIndexRelationship()

Relationship epc::FileRelationship::getIndexRelationship

(

size_t

index

)

const

Gets index relationship

Parameters

index

Zero-based index of the.

Returns

The index relationship.

getPathName()

const std::string & epc::FileRelationship::getPathName ( ) const

inline

Gets path name

Returns

The path name.

isEmpty()

bool epc::FileRelationship::isEmpty

(

)

const

ACCESSORS

Returns

True if empty, false if not.

readFromString()

void epc::FileRelationship::readFromString

(

const std::string &

textInput

)

Read a relationships part from a string.

Parameters

textInput

The text input.

setPathName()

void epc::FileRelationship::setPathName ( const std::string & frPathName )

inline

Sets path name

Parameters

frPathName

Full pathname of the fr file.

toString()

std::string epc::FileRelationship::toString

(

)

const

Convert this object into a string representation

Returns

A std::string that represents this object.

---

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

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/epc/FileRelationship.h