Extras Pds::Ra – File

Funciones con archivos: Pds::Ra::ElementsInFile(), etc. Más...

Diagrama de colaboración para Extras Pds::Ra – File:

Namespaces
namespace	Pds
	Nombre de espacion para PDS (Procesamiento Digital de Senales)
namespace	Pds::Ra
	Nombre de espacio para RA (Real Arrays)

Trabajar con archivos
Salva datos de matrices
const std::string	Pds::Ra::FileSep
	std::string con un separador de fichero "\\" para WINDOWS y "/" para linux. Más...
const char	Pds::Ra::CharFileSep
	std::string con un separador de fichero "\\" para WINDOWS y "/" para linux. Más...
long	Pds::Ra::SignificativeLinesInFile (const std::string &filepath)
	Retorna el número de lineas significativas de un archivo. Se asume que es un archivo de texto. Más...
bool	Pds::Ra::ElementsInFile (const std::string &filepath, unsigned int &Nel)
	Retorna el número de elementos de un archivo. Se asume que es un archivo de texto. Más...
bool	Pds::Ra::ArraySizeInFile (const std::string &filepath, unsigned int &Nlin, unsigned int &Ncol)
	Retorna el número de lineas significativas y columnas de un archivo. Se asume que es un archivo de texto. Más...
char *	Pds::Ra::Fgets (FILE *fd)
	Retorna una linea leida desde un desriptor de fichero de texto. No descarta el salto de linea '\n' y no descarta 1 retorno de carro '\r' si este existe depues del salto de linea. Más...
std::string	Pds::Ra::FullFile (std::initializer_list< std::string > str_text_list)
	Retorna una nueva cadena con un filepath creado por la union de las cadenas de entrada, usando para concatenar Pds::Ra::FileSep. Más...
std::string	Pds::Ra::HomeDir (void)
	Retorna una nueva cadena de texto con la dirección del directorio de usuario. HOME en gnu-linux y {HOMEDRIVE,HOMEPATH} en Windows. Más...
std::string	Pds::Ra::Programpath (void)
	Retorna un std::string con la ruta del programa que lo invoca. Más...
std::string	Pds::Ra::Pwd (void)
	Retorna un std::string con la ruta actual. Más...
std::string	Pds::Ra::Dirname (std::string filepath)
	Retorna un std::string con el directorio de un filepath. Más...
std::string	Pds::Ra::Basename (std::string filepath)
	Retorna un std::string con el basename de un filepath. Más...
std::string	Pds::Ra::Extension (std::string filepath)
	Retorna un std::string con el extension de un filepath. Más...
std::string	Pds::Ra::Filename (std::string filepath)
	Retorna un std::string con el filename de un filepath. Más...
std::string	Pds::Ra::ReplaceExtension (std::string filepath, std::string new_ext)
	Retorna un std::string con un filepath con otra extension de un filepath. Más...
bool	Pds::Ra::IsFile (std::string path)
	Retorna true si es un fichero existenteste (simbólico o real) no directorio, o false si no. Más...
bool	Pds::Ra::IsDir (std::string path)
	Retorna true si es un directorio existenteste (simbólico o real) no fichero, o false si no. Más...
std::string	Pds::Ra::GetParamString (int argc, char *const argv[], std::string param, std::string default_data)
	Obtiene el dato de tipo std::string que va después del parámetro param en una cadena de parámetros argv de argc elementos. si el parámetro param no es encontrado la función retorna default_data. Si existen parámetros data repetidos, solo se atiende al primero. Más...
bool	Pds::Ra::ExistParam (int argc, char *const argv[], std::string param)
	Retorna true si existe el parámetro param. Más...

Descripción detallada

Funciones con archivos: Pds::Ra::ElementsInFile(), etc.

#include <Pds/RaFile>

Documentación de las funciones

SignificativeLinesInFile()

long Pds::Ra::SignificativeLinesInFile

(

const std::string &

filepath

)

Retorna el número de lineas significativas de un archivo. Se asume que es un archivo de texto.

Una linea no significativa solo contiene white-spaces:

' '     (0x20)  space (SPC)
'\t'    (0x09)  horizontal tab (TAB)
'\n'    (0x0a)  newline (LF)
'\v'    (0x0b)  vertical tab (VT)
'\f'    (0x0c)  feed (FF)
'\r'    (0x0d)  carriage return (CR)

Parámetros

[in]

filepath

Dirección de archivo a testar.

Devuelve

Retorna el número de lineas significativas de un archivo o negativo en caso de error

ElementsInFile()

bool Pds::Ra::ElementsInFile	(	const std::string &	filepath,
		unsigned int &	Nel
	)

Retorna el número de elementos de un archivo. Se asume que es un archivo de texto.

Una un elemento e cualquier grupo de caracteres con elementos que no contienen white-spaces:

' '     (0x20)  space (SPC)
'\t'    (0x09)  horizontal tab (TAB)
'\n'    (0x0a)  newline (LF)
'\v'    (0x0b)  vertical tab (VT)
'\f'    (0x0c)  feed (FF)
'\r'    (0x0d)  carriage return (CR)

Parámetros

[in]	filepath	Dirección de archivo a testar.
[out]	Nel	Variable donde se guardara el numero de elementos.

Devuelve

Retorna true si todo fue bien o false si no. Si fue retornado false entonces Nel no es modificado.

ArraySizeInFile()

bool Pds::Ra::ArraySizeInFile	(	const std::string &	filepath,
		unsigned int &	Nlin,
		unsigned int &	Ncol
	)

Retorna el número de lineas significativas y columnas de un archivo. Se asume que es un archivo de texto.

Una linea no significativa solo contiene white-spaces:

' '     (0x20)  space (SPC)
'\t'    (0x09)  horizontal tab (TAB)
'\n'    (0x0a)  newline (LF)
'\v'    (0x0b)  vertical tab (VT)
'\f'    (0x0c)  feed (FF)
'\r'    (0x0d)  carriage return (CR)

Parámetros

[in]	filepath	Dirección de archivo a testar.
[out]	Nlin	Variable donde se guardara el numero de lineas.
[out]	Ncol	Variable donde se guardara el numero de columnas.

Devuelve

Retorna true si todo fue bien o false si no. Si el numero de columnas no es constante entonces se retorna false. Si fue retornado false entonces Nlin y Ncol no son modificados.

Fgets()

char* Pds::Ra::Fgets

(

FILE *

fd

)

Retorna una linea leida desde un desriptor de fichero de texto. No descarta el salto de linea '\n' y no descarta 1 retorno de carro '\r' si este existe depues del salto de linea.

Parámetros

[in]

fd

Descriptor de fichero de texto a analizar.

Devuelve

Retorna una nueva cadena de texto con una copia de la linea leida incluyendo los caracteres de control finales exepto EOF.

FullFile()

std::string Pds::Ra::FullFile

(

std::initializer_list< std::string >

str_text_list

)

Retorna una nueva cadena con un filepath creado por la union de las cadenas de entrada, usando para concatenar Pds::Ra::FileSep.

std::string str_out=FullFile({"/usr","share","program_name","icons"});
std::cout<<str_out<<std::endl;

Parámetros

[in]

str_text_list

Lista de argumentos a concatenar.

Devuelve

Retorna una nueva cadena con un filepath creado por la union de las cadenas de entrada, usando para concatenar Pds::Ra::FileSep.

HomeDir()

std::string Pds::Ra::HomeDir

(

void

)

Retorna una nueva cadena de texto con la dirección del directorio de usuario. HOME en gnu-linux y {HOMEDRIVE,HOMEPATH} en Windows.

Devuelve

Retorna el directorio de usuario o NULL en caso de problemas en la reserva de memoria.

Programpath()

std::string Pds::Ra::Programpath

(

void

)

Retorna un std::string con la ruta del programa que lo invoca.

Devuelve

Retorna un std::string con la ruta del programa que lo invoca.

Pwd()

std::string Pds::Ra::Pwd

(

void

)

Retorna un std::string con la ruta actual.

Devuelve

Retorna un std::string con la ruta actual.

Dirname()

std::string Pds::Ra::Dirname

(

std::string

filepath

)

Retorna un std::string con el directorio de un filepath.

std::string filepath="/usr/share/program_name/icons/image.png";
std::cout<<Pds::Ra::Dirname(filepath)<<std::endl;

Retorna:

/usr/share/program_name/icons

Devuelve

Retorna un std::string con el directorio de un filepath.

Basename()

std::string Pds::Ra::Basename

(

std::string

filepath

)

Retorna un std::string con el basename de un filepath.

std::string filepath="/usr/share/program_name/icons/image.png";
std::cout<<Pds::Ra::Basename(filepath)<<std::endl;

Retorna:

image.png

Devuelve

Retorna un std::string con el basename de un filepath.

Extension()

std::string Pds::Ra::Extension

(

std::string

filepath

)

Retorna un std::string con el extension de un filepath.

std::string filepath="/usr/share/program_name/icons/image.png";
std::cout<<Pds::Ra::Extension(filepath)<<std::endl;

Retorna:

.png

Devuelve

Retorna un std::string con el extension de un filepath.

Filename()

std::string Pds::Ra::Filename

(

std::string

filepath

)

Retorna un std::string con el filename de un filepath.

std::string filepath="/usr/share/program_name/icons/image.png";
std::cout<<Pds::Ra::Filename(filepath)<<std::endl;

Retorna:

image

Devuelve

Retorna un std::string con el filename de un filepath.

ReplaceExtension()

std::string Pds::Ra::ReplaceExtension	(	std::string	filepath,
		std::string	new_ext
	)

Retorna un std::string con un filepath con otra extension de un filepath.

std::string filepath="/usr/share/program_name/icons/image.png";
std::cout<<Pds::Ra::ReplaceExtension(filepath,".bmp")<<std::endl;

Retorna:

/usr/share/program_name/icons/image.bmp

Devuelve

Retorna un std::string con un filepath con otra extension de un filepath.

IsFile()

bool Pds::Ra::IsFile

(

std::string

path

)

Retorna true si es un fichero existenteste (simbólico o real) no directorio, o false si no.

Parámetros

[in]

path

Dirección de fichero a testar.

Devuelve

Retorna true si es un fichero existenteste (simbólico o real) no directorio, o false si no.

IsDir()

bool Pds::Ra::IsDir

(

std::string

path

)

Retorna true si es un directorio existenteste (simbólico o real) no fichero, o false si no.

Parámetros

[in]

path

Dirección de directorio a testar.

Devuelve

Retorna true si es un directorio existenteste (simbólico o real) no fichero, o false si no.

GetParamString()

std::string Pds::Ra::GetParamString	(	int	argc,
		char *const	argv[],
		std::string	param,
		std::string	default_data
	)

Obtiene el dato de tipo std::string que va después del parámetro param en una cadena de parámetros argv de argc elementos. si el parámetro param no es encontrado la función retorna default_data. Si existen parámetros data repetidos, solo se atiende al primero.

std::string data;
std::string default_data="/home/user/data.dat";
data=GetParamString(argc,argv,"--input-file",default_data);

\retu

Parámetros

[in]	argc	Cantidad de elementos de argv.
[in]	argv	Cadenas de caracteres con parámetros de entrada.
[in]	param	Parametro a buscar en las cadenas argv.
[in]	default_data	Dato por defecto.

Devuelve

El dato correspondiente ou default_data.

ExistParam()

bool Pds::Ra::ExistParam	(	int	argc,
		char *const	argv[],
		std::string	param
	)

Retorna true si existe el parámetro param.

Parámetros

[in]	argc	Cantidad de elementos de argv.
[in]	argv	Cadenas de caracteres con parámetros de entrada.
[in]	param	Dato a buscar en las cadenas argv.

Devuelve

Retorna true si todo fue bien o false si no.

Documentación de las variables

FileSep

const std::string Pds::Ra::FileSep

Valor inicial:

=
 
 
 
                                "/"

std::string con un separador de fichero "\\" para WINDOWS y "/" para linux.

Definición en la línea 63 del archivo RaFile.hpp.

CharFileSep

const char Pds::Ra::CharFileSep

Valor inicial:

=
 
 
 
                                '/'

std::string con un separador de fichero "\\" para WINDOWS y "/" para linux.

Definición en la línea 74 del archivo RaFile.hpp.